diff options
author | Rob Taylor <rob.taylor@codethink.co.uk> | 2007-08-16 13:52:10 +0100 |
---|---|---|
committer | Rob Taylor <rob.taylor@codethink.co.uk> | 2007-08-16 13:52:10 +0100 |
commit | 4f6b30eea8c5d175f1131c46d2c6d888177329a4 (patch) | |
tree | 40603ce4b370dd0aa28374040fc34e554bb91b55 | |
parent | 18c21ca0a0ba3a662f17249a5bdd9ce040594e72 (diff) |
gtk-doc for Ohm plugin interface
Add basic gtk-doc generation for ohm-plugin.h
-rwxr-xr-x | autogen.sh | 3 | ||||
-rw-r--r-- | configure.in | 5 | ||||
-rw-r--r-- | docs/Makefile.am | 2 | ||||
-rw-r--r-- | docs/reference/Makefile.am | 1 | ||||
-rw-r--r-- | docs/reference/ohm-plugin/Makefile.am | 89 | ||||
-rw-r--r-- | docs/reference/ohm-plugin/ohm-plugin-decl-list.txt | 26 | ||||
-rw-r--r-- | docs/reference/ohm-plugin/ohm-plugin-overrides.txt | 0 | ||||
-rw-r--r-- | docs/reference/ohm-plugin/ohm-plugin-sections.txt | 25 |
8 files changed, 151 insertions, 0 deletions
@@ -25,6 +25,9 @@ echo "Running $AUTOMAKE..." $AUTOMAKE -a || exit 1 $AUTOMAKE -a ohmd/Makefile || exit 1 +echo "Running gtkdocize..." +gtkdocize || exit 1 + conf_flags="" if test x$NOCONFIGURE = x; then diff --git a/configure.in b/configure.in index 5409e22..967ffc0 100644 --- a/configure.in +++ b/configure.in @@ -29,6 +29,9 @@ AC_PROG_INTLTOOL([0.33.0]) AM_GLIB_GNU_GETTEXT AC_PATH_PROG(GLIB_GENMARSHAL, glib-genmarshal) + +GTK_DOC_CHECK([1.8]) + ALL_LINGUAS="en_GB" AC_SUBST(ALL_LINGUAS) @@ -320,6 +323,8 @@ ohmd/Makefile po/Makefile.in docs/Makefile docs/index.xml +docs/reference/Makefile +docs/reference/ohm-plugin/Makefile libohm/Makefile libidletime/Makefile tools/Makefile 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> |