diff options
author | Richard Hughes <richard@hughsie.com> | 2010-01-25 16:26:47 +0000 |
---|---|---|
committer | Richard Hughes <richard@hughsie.com> | 2010-01-25 16:54:17 +0000 |
commit | 27fada20be7feba6783abc5b6cad91ee274ad3df (patch) | |
tree | ee0cbd3518a6f73762979ce9ff2f2d5a81de2335 /doc | |
parent | 69c06340a80420b20c53a08ce4c54a5f4df7f983 (diff) | |
download | upower-27fada20be7feba6783abc5b6cad91ee274ad3df.tar.gz |
trivial: add some gtk-doc markup into libupower-glib and hook it up to the build system
Diffstat (limited to 'doc')
-rw-r--r-- | doc/.gitignore | 1 | ||||
-rw-r--r-- | doc/Makefile.am | 12 | ||||
-rw-r--r-- | doc/upower-docs.xml | 35 |
3 files changed, 38 insertions, 10 deletions
diff --git a/doc/.gitignore b/doc/.gitignore index e3be474..6d049dc 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -12,4 +12,5 @@ html tmpl version.xml xml +.libs diff --git a/doc/Makefile.am b/doc/Makefile.am index 479429b..be6ed02 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -6,7 +6,7 @@ NULL = AUTOMAKE_OPTIONS = 1.7 # The name of the module. -DOC_MODULE=upower +DOC_MODULE=UPower # The top-level SGML file. DOC_MAIN_SGML_FILE=upower-docs.xml @@ -25,6 +25,7 @@ CFILE_GLOB= # Headers to ignore IGNORE_HFILES= \ + config.h \ $(NULL) # CFLAGS and LDFLAGS for compiling scan program. Only needed @@ -32,11 +33,16 @@ IGNORE_HFILES= \ INCLUDES = \ $(DBUS_GLIB_CFLAGS) \ $(GLIB_CFLAGS) \ - -I$(top_srcdir)/policy \ - -I$(top_builddir)/policy \ + -I$(top_srcdir)/libupower-glib \ + -I$(top_builddir)/libupower-glib \ + $(NULL) + +UPOWER_GLIB_LIBS = \ + $(top_builddir)/libupower-glib/libupower-glib.la \ $(NULL) GTKDOC_LIBS = \ + $(UPOWER_GLIB_LIBS) \ $(DBUS_GLIB_LIBS) \ $(NULL) diff --git a/doc/upower-docs.xml b/doc/upower-docs.xml index 14438d1..9b01704 100644 --- a/doc/upower-docs.xml +++ b/doc/upower-docs.xml @@ -9,13 +9,13 @@ <releaseinfo>Version &version;</releaseinfo> <authorgroup> <author> - <firstname>David</firstname> - <surname>Zeuthen</surname> - <affiliation> - <address> - <email>davidz@redhat.com</email> - </address> - </affiliation> + <firstname>Richard</firstname> + <surname>Hughes</surname> + <affiliation> + <address> + <email>richard@hughsie.com</email> + </address> + </affiliation> </author> </authorgroup> @@ -69,6 +69,27 @@ <xi:include href="dbus/org.freedesktop.UPower.QoS.ref.xml"/> </reference> + <reference id="libupower-glib"> + <title>libpackagekit GObjects</title> + <partintro> + <para> + This part documents GObjects used in libupower-glib. + </para> + </partintro> + <xi:include href="xml/up-client.xml"/> + <xi:include href="xml/up-device.xml"/> + </reference> + + <reference id="libupower-glib-helpers"> + <title>libupower-glib helpers</title> + <partintro> + <para> + This part documents helper funtions in libupower-glib. + </para> + </partintro> + <xi:include href="xml/up-types.xml"/> + </reference> + <reference id="tools-fileformats"> <title>Manual Pages</title> <partintro> |