diff options
Diffstat (limited to 'gudev/docs')
-rw-r--r-- | gudev/docs/Makefile.am | 86 | ||||
-rw-r--r-- | gudev/docs/gudev-docs.xml | 79 | ||||
-rw-r--r-- | gudev/docs/gudev-sections.txt | 66 | ||||
-rw-r--r-- | gudev/docs/gudev.types | 3 | ||||
-rw-r--r-- | gudev/docs/version.xml.in | 1 |
5 files changed, 235 insertions, 0 deletions
diff --git a/gudev/docs/Makefile.am b/gudev/docs/Makefile.am new file mode 100644 index 0000000..b5e498e --- /dev/null +++ b/gudev/docs/Makefile.am @@ -0,0 +1,86 @@ +## Process this file with automake to create Makefile.in. + +NULL = + +AUTOMAKE_OPTIONS = 1.7 + +# The name of the module. +DOC_MODULE=gudev + +# The top-level SGML file. +DOC_MAIN_SGML_FILE=gudev-docs.xml + +# Extra options to supply to gtkdoc-scan +SCAN_OPTIONS=--ignore-headers=config.h + +#SCAN_OPTIONS+=--rebuild-sections + +# The directory containing the source code. Relative to $(srcdir) +DOC_SOURCE_DIR=.. + +# Used for dependencies +HFILE_GLOB=$(top_srcdir)/gudev/*.h +CFILE_GLOB=$(top_srcdir)/gudev/*.c + +# Headers to ignore +IGNORE_HFILES= \ + $(NULL) + +# CFLAGS and LDFLAGS for compiling scan program. Only needed +# if $(DOC_MODULE).types is non-empty. +INCLUDES = \ + $(DBUS_GLIB_CFLAGS) \ + $(GLIB_CFLAGS) \ + -I$(top_srcdir)/gudev \ + -I$(top_builddir)/gudev \ + $(NULL) + +GTKDOC_LIBS = \ + $(GLIB_LIBS) \ + $(top_builddir)/gudev/libgudev-1.0.la \ + $(NULL) + +# Extra options to supply to gtkdoc-mkdb +MKDB_OPTIONS=--sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-mktmpl +MKTMPL_OPTIONS= + +# Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE) +content_files = \ + version.xml \ + $(NULL) + +# Images to copy into HTML directory +HTML_IMAGES = \ + $(NULL) + +# Extra options to supply to gtkdoc-fixref +FIXXREF_OPTIONS= + +if ENABLE_GTK_DOC +include $(top_srcdir)/gtk-doc.make +else +EXTRA_DIST = +CLEANFILES = +endif + +# Version information for marking the documentation +EXTRA_DIST += version.xml.in + +CLEANFILES += *~ \ + gudev-scan.* \ + gudev.args \ + gudev.hierarchy \ + gudev.interfaces \ + gudev.prerequisites \ + gudev.signals \ + *.bak \ + gudev-decl-list.txt \ + gudev-decl.txt \ + gudev-overrides.txt \ + gudev-undeclared.txt \ + gudev-undocumented.txt \ + *.stamp \ + -rf html xml \ + $(NULL) diff --git a/gudev/docs/gudev-docs.xml b/gudev/docs/gudev-docs.xml new file mode 100644 index 0000000..f69be2c --- /dev/null +++ b/gudev/docs/gudev-docs.xml @@ -0,0 +1,79 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ +<!ENTITY version SYSTEM "version.xml"> +]> +<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> + <bookinfo> + <title>GUDev Reference Manual</title> + <releaseinfo>For GUdev version &version;</releaseinfo> + <authorgroup> + <author> + <firstname>David</firstname> + <surname>Zeuthen</surname> + <affiliation> + <address> + <email>davidz@redhat.com</email> + </address> + </affiliation> + </author> + </authorgroup> + + <copyright> + <year>2009</year> + <holder>The GUDev Authors</holder> + </copyright> + + <legalnotice> + <para> + Permission is granted to copy, distribute and/or modify this + document under the terms of the <citetitle>GNU Free + Documentation License</citetitle>, Version 1.1 or any later + version published by the Free Software Foundation with no + Invariant Sections, no Front-Cover Texts, and no Back-Cover + Texts. You may obtain a copy of the <citetitle>GNU Free + Documentation License</citetitle> from the Free Software + Foundation by visiting <ulink type="http" + url="http://www.fsf.org">their Web site</ulink> or by writing + to: + + <address> + The Free Software Foundation, Inc., + <street>59 Temple Place</street> - Suite 330, + <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>, + <country>USA</country> + </address> + </para> + + <para> + Many of the names used by companies to distinguish their + products and services are claimed as trademarks. Where those + names appear in any freedesktop.org documentation, and those + trademarks are made aware to the members of the + freedesktop.org Project, the names have been printed in caps + or initial caps. + </para> + </legalnotice> + </bookinfo> + + <reference id="ref-API"> + <title>API Reference</title> + <partintro> + <para> + This part presents the class and function reference for the + <literal>libgudev</literal> library. + </para> + </partintro> + <xi:include href="xml/gudevclient.xml"/> + <xi:include href="xml/gudevdevice.xml"/> + </reference> + + <chapter id="gudev-hierarchy"> + <title>Object Hierarchy</title> + <xi:include href="xml/tree_index.sgml"/> + </chapter> + <index> + <title>Index</title> + </index> + +</book> diff --git a/gudev/docs/gudev-sections.txt b/gudev/docs/gudev-sections.txt new file mode 100644 index 0000000..faa6a8d --- /dev/null +++ b/gudev/docs/gudev-sections.txt @@ -0,0 +1,66 @@ +<SECTION> +<FILE>gudevclient</FILE> +<TITLE>GUdevClient</TITLE> +GUdevClient +GUdevClientClass +GUdevDeviceType +GUdevDeviceNumber +g_udev_client_new +g_udev_client_query_by_subsystem +g_udev_client_query_by_device_number +g_udev_client_query_by_device_file +g_udev_client_query_by_sysfs_path +g_udev_client_query_by_subsystem_and_name +<SUBSECTION Standard> +G_UDEV_CLIENT +G_UDEV_IS_CLIENT +G_UDEV_TYPE_CLIENT +g_udev_client_get_type +G_UDEV_CLIENT_CLASS +G_UDEV_IS_CLIENT_CLASS +G_UDEV_CLIENT_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gudevdevice</FILE> +<TITLE>GUdevDevice</TITLE> +GUdevDevice +GUdevDeviceClass +g_udev_device_get_subsystem +g_udev_device_get_devtype +g_udev_device_get_name +g_udev_device_get_number +g_udev_device_get_sysfs_path +g_udev_device_get_driver +g_udev_device_get_action +g_udev_device_get_seqnum +g_udev_device_get_device_type +g_udev_device_get_device_number +g_udev_device_get_device_file +g_udev_device_get_device_file_symlinks +g_udev_device_get_parent +g_udev_device_get_parent_with_subsystem +g_udev_device_get_property_keys +g_udev_device_has_property +g_udev_device_get_property +g_udev_device_get_property_as_int +g_udev_device_get_property_as_uint64 +g_udev_device_get_property_as_double +g_udev_device_get_property_as_boolean +g_udev_device_get_property_as_strv +g_udev_device_get_sysfs_attr +g_udev_device_get_sysfs_attr_as_int +g_udev_device_get_sysfs_attr_as_uint64 +g_udev_device_get_sysfs_attr_as_double +g_udev_device_get_sysfs_attr_as_boolean +g_udev_device_get_sysfs_attr_as_strv +<SUBSECTION Standard> +G_UDEV_DEVICE +G_UDEV_IS_DEVICE +G_UDEV_TYPE_DEVICE +g_udev_device_get_type +G_UDEV_DEVICE_CLASS +G_UDEV_IS_DEVICE_CLASS +G_UDEV_DEVICE_GET_CLASS +</SECTION> + diff --git a/gudev/docs/gudev.types b/gudev/docs/gudev.types new file mode 100644 index 0000000..be090b1 --- /dev/null +++ b/gudev/docs/gudev.types @@ -0,0 +1,3 @@ +g_udev_device_type_get_type +g_udev_device_get_type +g_udev_client_get_type diff --git a/gudev/docs/version.xml.in b/gudev/docs/version.xml.in new file mode 100644 index 0000000..65ace8a --- /dev/null +++ b/gudev/docs/version.xml.in @@ -0,0 +1 @@ +@LIBGUDEV_VERSION@ |