aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Makefile.am6
-rwxr-xr-xautogen.sh2
-rw-r--r--configure.ac8
-rw-r--r--doc/Makefile.am1
-rw-r--r--doc/reference/Makefile.am21
-rw-r--r--doc/reference/messaging-menu-docs.xml.in38
-rw-r--r--libmessaging-menu/messaging-menu.c2
7 files changed, 73 insertions, 5 deletions
diff --git a/Makefile.am b/Makefile.am
index ef08e41..daeb2b7 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -5,6 +5,10 @@ SUBDIRS = \
data \
po
+if ENABLE_GTK_DOC
+SUBDIRS += doc
+endif
+
if BUILD_TESTS
SUBDIRS += \
test
@@ -17,7 +21,7 @@ endif
-DISTCHECK_CONFIGURE_FLAGS = --enable-localinstall --enable-deprecations --enable-introspection
+DISTCHECK_CONFIGURE_FLAGS = --enable-localinstall --enable-deprecations --enable-introspection --enable-gtk-doc
dist-hook:
@if test -d "$(top_srcdir)/.bzr"; \
diff --git a/autogen.sh b/autogen.sh
index a49cd41..ab2f513 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -1,5 +1,5 @@
#!/bin/sh -e
+gtkdocize
autoreconf -i -f
intltoolize
-gtkdocize
diff --git a/configure.ac b/configure.ac
index 4d3ef7a..ea1a0f8 100644
--- a/configure.ac
+++ b/configure.ac
@@ -57,7 +57,7 @@ AC_SUBST(APPLET_LIBS)
GLIB_GSETTINGS
-GTK_DOC_CHECK([1.18], [])
+GTK_DOC_CHECK([1.18], [--flavour no-tmpl])
GOBJECT_INTROSPECTION_CHECK([$INTROSPECTION_REQUIRED_VERSION])
@@ -178,6 +178,9 @@ po/Makefile.in
test/Makefile
libmessaging-menu/Makefile
libmessaging-menu/messaging-menu.pc
+doc/Makefile
+doc/reference/Makefile
+doc/reference/messaging-menu-docs.xml
])
###########################
@@ -192,5 +195,6 @@ Messaging Indicator Configuration:
Indicator Dir: $INDICATORDIR
gtest: $enable_tests
gcov: $use_gcov
- introspecion: $enable_introspection
+ introspecion: $enable_introspection
+ documentation: $enable_gtk_doc
])
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>
diff --git a/libmessaging-menu/messaging-menu.c b/libmessaging-menu/messaging-menu.c
index 5bce20b..f910de1 100644
--- a/libmessaging-menu/messaging-menu.c
+++ b/libmessaging-menu/messaging-menu.c
@@ -24,7 +24,7 @@
#include <gio/gdesktopappinfo.h>
/**
- * SECTION:messagingmenuapp
+ * SECTION:messaging-menu
* @title: MessagingMenuApp
* @short_description: An application section in the messaging menu
*