diff options
Diffstat (limited to 'docs/libudev')
-rw-r--r-- | docs/libudev/.gitignore | 19 | ||||
-rw-r--r-- | docs/libudev/Makefile.am | 107 | ||||
-rw-r--r-- | docs/libudev/libudev-docs.xml | 40 | ||||
-rw-r--r-- | docs/libudev/libudev-sections.txt | 134 | ||||
-rw-r--r-- | docs/libudev/libudev.types | 0 | ||||
-rw-r--r-- | docs/libudev/version.xml.in | 1 |
6 files changed, 301 insertions, 0 deletions
diff --git a/docs/libudev/.gitignore b/docs/libudev/.gitignore new file mode 100644 index 0000000000..f8dd67c50a --- /dev/null +++ b/docs/libudev/.gitignore @@ -0,0 +1,19 @@ +/gtk-doc.make +/version.xml +/Makefile +/libudev-overrides.txt +/libudev-decl-list.txt +/libudev-decl.txt +/libudev-undeclared.txt +/libudev-undocumented.txt +/libudev-unused.txt +/libudev.args +/libudev.hierarchy +/libudev.interfaces +/libudev.prerequisites +/libudev.signals +/html/ +/xml/ +/*.stamp +/*.bak +/tmpl/ diff --git a/docs/libudev/Makefile.am b/docs/libudev/Makefile.am new file mode 100644 index 0000000000..c6d7b8ca25 --- /dev/null +++ b/docs/libudev/Makefile.am @@ -0,0 +1,107 @@ +## Process this file with automake to produce Makefile.in + +# We require automake 1.10 at least. +AUTOMAKE_OPTIONS = 1.10 + +# This is a blank Makefile.am for using gtk-doc. +# Copy this to your project's API docs directory and modify the variables to +# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples +# of using the various options. + +# The name of the module, e.g. 'glib'. +DOC_MODULE=libudev + +# Uncomment for versioned docs and specify the version of the module, e.g. '2'. +#DOC_MODULE_VERSION=2 + +# The top-level SGML file. You can change this if you want to. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting the functions and macros. +# e.g. DOC_SOURCE_DIR=../../../gtk +DOC_SOURCE_DIR=$(top_srcdir)/src/libudev + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS= + +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS= + +# Extra options to supply to gtkdoc-mkdb. +# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml +MKDB_OPTIONS=--xml-mode --output-format=xml --name-space=udev + +# Extra options to supply to gtkdoc-mktmpl +# e.g. MKTMPL_OPTIONS=--only-section-tmpl +MKTMPL_OPTIONS= + +# Extra options to supply to gtkdoc-mkhtml +MKHTML_OPTIONS=--path=$(abs_srcdir) --path=$(abs_builddir) + +# Extra options to supply to gtkdoc-fixref. Not normally needed. +# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +FIXXREF_OPTIONS=>/dev/null 2>&1 + +# Used for dependencies. The docs will be rebuilt if any of these change. +# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h +# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c +HFILE_GLOB=$(top_srcdir)/src/libudev/libudev*.h +CFILE_GLOB=$(top_srcdir)/src/libudev/libudev*.c + +# Extra header to include when scanning, which are not under DOC_SOURCE_DIR +# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h +EXTRA_HFILES= + +# Header files to ignore when scanning. Use base file name, no paths +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES = libudev-private.h libudev-hwdb-def.h + +# Images to copy into HTML directory. +# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png +HTML_IMAGES= + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +# e.g. content_files=running.sgml building.sgml changes-2.0.sgml +content_files = version.xml + +# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded +# These files must be listed here *and* in content_files +# e.g. expand_content_files=running.sgml +expand_content_files= + +# Hack, hack. You silly gtk-doc, you must not add CFLAGS multiple +# times when calling gcc; it surely can not work with options that must +# be listed only once. +# Kill CFLAGS here because gtk-doc thinks adding CFLAGS to CC _and_ also +# adding CFLAGS itself again would work. +override CFLAGS= +override LDFLAGS= + +# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. +# Only needed if you are using gtkdoc-scangobj to dynamically query widget +# signals and properties. +# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +GTKDOC_CFLAGS= +GTKDOC_LIBS= + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/docs/gtk-doc.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += version.xml.in + +# Files not to distribute +# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types +# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt +#DISTCLEANFILES += + +# Comment this out if you want your docs-status tested during 'make check' +if ENABLE_GTK_DOC +TESTS_ENVIRONMENT = cd $(top_srcdir) +TESTS = $(GTKDOC_CHECK) +endif diff --git a/docs/libudev/libudev-docs.xml b/docs/libudev/libudev-docs.xml new file mode 100644 index 0000000000..454cd31646 --- /dev/null +++ b/docs/libudev/libudev-docs.xml @@ -0,0 +1,40 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY version SYSTEM "version.xml"> +]> +<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> + <bookinfo> + <title>libudev Reference Manual</title> + <releaseinfo> + For version &version; — the latest version of this + documentation can be found at + <ulink role="online-location" url="http://www.freedesktop.org/software/systemd/libudev/"> + http://www.freedesktop.org/software/systemd/libudev/ + </ulink>. + </releaseinfo> + <copyright> + <year>2009-2012</year> + <holder>Kay Sievers <kay@vrfy.org></holder> + </copyright> + </bookinfo> + + <chapter> + <title>API Reference</title> + <xi:include href="xml/libudev.xml"/> + <xi:include href="xml/libudev-list.xml"/> + <xi:include href="xml/libudev-device.xml"/> + <xi:include href="xml/libudev-monitor.xml"/> + <xi:include href="xml/libudev-enumerate.xml"/> + <xi:include href="xml/libudev-queue.xml"/> + <xi:include href="xml/libudev-hwdb.xml"/> + <xi:include href="xml/libudev-util.xml"/> + <xi:include href="xml/api-index-deprecated.xml"/> + </chapter> + + <index id="api-index-full"> + <title>Index</title> + <xi:include href="xml/api-index-full.xml"/> + </index> +</book> diff --git a/docs/libudev/libudev-sections.txt b/docs/libudev/libudev-sections.txt new file mode 100644 index 0000000000..067a3f5b95 --- /dev/null +++ b/docs/libudev/libudev-sections.txt @@ -0,0 +1,134 @@ +<SECTION> +<FILE>libudev</FILE> +<TITLE>udev</TITLE> +udev +udev_ref +udev_unref +udev_new +udev_set_log_fn +udev_get_log_priority +udev_set_log_priority +udev_get_userdata +udev_set_userdata +</SECTION> + +<SECTION> +<FILE>libudev-list</FILE> +<TITLE>udev_list</TITLE> +udev_list_entry +udev_list_entry_get_next +udev_list_entry_get_by_name +udev_list_entry_get_name +udev_list_entry_get_value +udev_list_entry_foreach +</SECTION> + +<SECTION> +<FILE>libudev-device</FILE> +<TITLE>udev_device</TITLE> +udev_device +udev_device_ref +udev_device_unref +udev_device_get_udev +udev_device_new_from_syspath +udev_device_new_from_devnum +udev_device_new_from_subsystem_sysname +udev_device_new_from_device_id +udev_device_new_from_environment +udev_device_get_parent +udev_device_get_parent_with_subsystem_devtype +udev_device_get_devpath +udev_device_get_subsystem +udev_device_get_devtype +udev_device_get_syspath +udev_device_get_sysname +udev_device_get_sysnum +udev_device_get_devnode +udev_device_get_is_initialized +udev_device_get_devlinks_list_entry +udev_device_get_properties_list_entry +udev_device_get_tags_list_entry +udev_device_get_property_value +udev_device_get_driver +udev_device_get_devnum +udev_device_get_action +udev_device_get_sysattr_value +udev_device_get_sysattr_list_entry +udev_device_get_seqnum +udev_device_get_usec_since_initialized +udev_device_has_tag +</SECTION> + +<SECTION> +<FILE>libudev-monitor</FILE> +<TITLE>udev_monitor</TITLE> +udev_monitor +udev_monitor_ref +udev_monitor_unref +udev_monitor_get_udev +udev_monitor_new_from_netlink +udev_monitor_enable_receiving +udev_monitor_set_receive_buffer_size +udev_monitor_get_fd +udev_monitor_receive_device +udev_monitor_filter_add_match_subsystem_devtype +udev_monitor_filter_add_match_tag +udev_monitor_filter_update +udev_monitor_filter_remove +</SECTION> + +<SECTION> +<FILE>libudev-enumerate</FILE> +<TITLE>udev_enumerate</TITLE> +udev_enumerate +udev_enumerate_ref +udev_enumerate_unref +udev_enumerate_get_udev +udev_enumerate_new +udev_enumerate_add_match_subsystem +udev_enumerate_add_nomatch_subsystem +udev_enumerate_add_match_sysattr +udev_enumerate_add_nomatch_sysattr +udev_enumerate_add_match_property +udev_enumerate_add_match_tag +udev_enumerate_add_match_parent +udev_enumerate_add_match_is_initialized +udev_enumerate_add_match_sysname +udev_enumerate_add_syspath +udev_enumerate_scan_devices +udev_enumerate_scan_subsystems +udev_enumerate_get_list_entry +</SECTION> + +<SECTION> +<FILE>libudev-queue</FILE> +<TITLE>udev_queue</TITLE> +udev_queue +udev_queue_ref +udev_queue_unref +udev_queue_get_udev +udev_queue_new +udev_queue_get_udev_is_active +udev_queue_get_queue_is_empty +udev_queue_get_seqnum_is_finished +udev_queue_get_seqnum_sequence_is_finished +udev_queue_get_queued_list_entry +udev_queue_get_kernel_seqnum +udev_queue_get_udev_seqnum +</SECTION> + +<SECTION> +<FILE>libudev-hwdb</FILE> +<TITLE>udev_hwdb</TITLE> +udev_hwdb +udev_hwdb_ref +udev_hwdb_unref +udev_hwdb_new +udev_hwdb_get_properties_list_entry +</SECTION> + +<SECTION> +<FILE>libudev-util</FILE> +<TITLE>udev_util</TITLE> +udev_util_encode_string +</SECTION> diff --git a/docs/libudev/libudev.types b/docs/libudev/libudev.types new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/docs/libudev/libudev.types diff --git a/docs/libudev/version.xml.in b/docs/libudev/version.xml.in new file mode 100644 index 0000000000..d78bda9342 --- /dev/null +++ b/docs/libudev/version.xml.in @@ -0,0 +1 @@ +@VERSION@ |