gtk-doc for Ohm plugin interface

Add basic gtk-doc generation for ohm-plugin.h

6 files changed, 143 insertions, 0 deletions

diff --git a/docs/Makefile.am b/docs/Makefile.am
index c9639e5..8c0a548 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,3 +1,5 @@
+SUBDIRS = reference
+
 IMAGE_FILES =				\
 	ohm-logo.png			\
 	ohm-logo.svg			\
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
new file mode 100644
index 0000000..d1565fd
--- /dev/null
+++ b/docs/reference/Makefile.am
@@ -0,0 +1 @@
+SUBDIRS = ohm-plugin
diff --git a/docs/reference/ohm-plugin/Makefile.am b/docs/reference/ohm-plugin/Makefile.am
new file mode 100644
index 0000000..7fa3707
--- /dev/null
+++ b/docs/reference/ohm-plugin/Makefile.am
@@ -0,0 +1,89 @@
+## Process this file with automake to produce Makefile.in
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# 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=ohm-plugin
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# 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=../../../ohmd/
+
+# 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=--sgml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+MKTMPL_OPTIONS=
+
+# 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=
+
+# 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)/ohmd/ohm-plugin.h
+CFILE_GLOB=
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES= \
+	ohm-common.h \
+	ohm-conf.h \
+	ohm-confobj.h \
+	ohm-dbus-keystore.h \
+	ohm-dbus-manager.h \
+	ohm-debug.h \
+	ohm-keystore.h \
+	ohm-manager.h \
+	ohm-marshal.h \
+	ohm-module.h \
+	ohm-plugin-internal.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=
+
+# 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=
+
+# 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. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+INCLUDES=-I$(top_srcdir) $(GLIB_CFLAGS)
+GTKDOC_LIBS=$(GLIB_LIBS)
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+# e.g. EXTRA_DIST += version.xml.in
+EXTRA_DIST += 
diff --git a/docs/reference/ohm-plugin/ohm-plugin-decl-list.txt b/docs/reference/ohm-plugin/ohm-plugin-decl-list.txt
new file mode 100644
index 0000000..8fc373d
--- /dev/null
+++ b/docs/reference/ohm-plugin/ohm-plugin-decl-list.txt
@@ -0,0 +1,26 @@
+<SECTION>
+<FILE>ohm-plugin</FILE>
+OhmPlugin
+OhmPluginDesc
+OhmPluginKeyIdMap
+OhmLicenseType
+OHM_PLUGIN_DESCRIPTION
+OHM_PLUGIN_INTERESTED
+OHM_PLUGIN_PROVIDES
+OHM_PLUGIN_REQUIRES
+OHM_PLUGIN_SUGGESTS
+OHM_PLUGIN_PREVENTS
+OhmPluginHalPropMod
+OhmPluginHalCondition
+ohm_plugin_spawn_async
+ohm_plugin_conf_get_key
+ohm_plugin_conf_set_key
+ohm_plugin_hal_init
+ohm_plugin_hal_use_property_modified
+ohm_plugin_hal_use_condition
+ohm_plugin_hal_get_bool
+ohm_plugin_hal_get_int
+ohm_plugin_hal_get_udi
+ohm_plugin_hal_add_device_capability
+</SECTION>
+
diff --git a/docs/reference/ohm-plugin/ohm-plugin-overrides.txt b/docs/reference/ohm-plugin/ohm-plugin-overrides.txt
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/docs/reference/ohm-plugin/ohm-plugin-overrides.txt
diff --git a/docs/reference/ohm-plugin/ohm-plugin-sections.txt b/docs/reference/ohm-plugin/ohm-plugin-sections.txt
new file mode 100644
index 0000000..3858d3c
--- /dev/null
+++ b/docs/reference/ohm-plugin/ohm-plugin-sections.txt
@@ -0,0 +1,25 @@
+<SECTION>
+<FILE>ohm-plugin</FILE>
+OhmPlugin
+OhmPluginDesc
+OhmPluginKeyIdMap
+OhmLicenseType
+OHM_PLUGIN_DESCRIPTION
+OHM_PLUGIN_INTERESTED
+OHM_PLUGIN_PROVIDES
+OHM_PLUGIN_REQUIRES
+OHM_PLUGIN_SUGGESTS
+OHM_PLUGIN_PREVENTS
+OhmPluginHalPropMod
+OhmPluginHalCondition
+ohm_plugin_spawn_async
+ohm_plugin_conf_get_key
+ohm_plugin_conf_set_key
+ohm_plugin_hal_init
+ohm_plugin_hal_use_property_modified
+ohm_plugin_hal_use_condition
+ohm_plugin_hal_get_bool
+ohm_plugin_hal_get_int
+ohm_plugin_hal_get_udi
+ohm_plugin_hal_add_device_capability
+</SECTION>