diff options
| author | Lars Uebernickel <lars.uebernickel@canonical.com> | 2012-08-29 13:27:54 +0200 |
|---|---|---|
| committer | Lars Uebernickel <lars.uebernickel@canonical.com> | 2012-08-29 13:27:54 +0200 |
| commit | c5a99f8bad23f7524c1e5a5da7413e1462a3a7f2 (patch) | |
| tree | 7cebda345a611daadd488392548887d4901fc731 /doc | |
| parent | 462b560f917d51a81c5d6ffa4e21e4e5b0194a99 (diff) | |
| download | ayatana-indicator-messages-c5a99f8bad23f7524c1e5a5da7413e1462a3a7f2.tar.gz ayatana-indicator-messages-c5a99f8bad23f7524c1e5a5da7413e1462a3a7f2.tar.bz2 ayatana-indicator-messages-c5a99f8bad23f7524c1e5a5da7413e1462a3a7f2.zip | |
Add gtk-doc support
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 1 | ||||
| -rw-r--r-- | doc/reference/Makefile.am | 21 | ||||
| -rw-r--r-- | doc/reference/messaging-menu-docs.xml.in | 38 |
3 files changed, 60 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..f3ddc22 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1 @@ +SUBDIRS = reference diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am new file mode 100644 index 0000000..023f1e7 --- /dev/null +++ b/doc/reference/Makefile.am @@ -0,0 +1,21 @@ +DOC_MODULE = messaging-menu + +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml + +DOC_SOURCE_DIR = $(top_srcdir)/libmessaging-menu + +SCANGOBJ_OPTIONS=--type-init-func="g_type_init()" +MKDB_OPTIONS=--xml-mode --output-format=xml + +# Used for dependencies. The docs will be rebuilt if any of these change. +HFILE_GLOB = $(top_srcdir)/libmessaging-menu/*.h +CFILE_GLOB = $(top_srcdir)/libmessaging-menu/*.c + +IGNORE_HFILES= \ + indicator-messages-service.h \ + gtupleaction.h + +INCLUDES=-I$(top_srcdir)/libmessaging-menu $(GIO_CFLAGS) +GTKDOC_LIBS=$(top_builddir)/libmessaging-menu/libmessaging-menu.la + +include $(top_srcdir)/gtk-doc.make diff --git a/doc/reference/messaging-menu-docs.xml.in b/doc/reference/messaging-menu-docs.xml.in new file mode 100644 index 0000000..742d37b --- /dev/null +++ b/doc/reference/messaging-menu-docs.xml.in @@ -0,0 +1,38 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.5//EN' + 'http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd' [ +<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +<!ENTITY version "@PACKAGE_VERSION@"> +]> +<book lang="en" id="messaging-menu" xmlns:xi="http://www.w3.org/2003/XInclude"> +<title>Messaging Menu Reference Manual</title> + <bookinfo> + <title>Messaging Menu Reference Manual</title> + <releaseinfo>for libmessaging-menu &version;</releaseinfo> + + <copyright> + <year>2012</year> + <holder>Canonical Ltd.</holder> + </copyright> + </bookinfo> + + <chapter> + <title>API Reference</title> + <xi:include href="xml/messaging-menu.xml"/> + </chapter> + + <chapter id="object-tree"> + <title>Object Hierarchy</title> + <xi:include href="xml/tree_index.sgml"/> + </chapter> + <index id="api-index-full"> + <title>API Index</title> + <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> + </index> + <index id="deprecated-api-index" role="deprecated"> + <title>Index of deprecated API</title> + <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include> + </index> + + <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> +</book> |