From c5a99f8bad23f7524c1e5a5da7413e1462a3a7f2 Mon Sep 17 00:00:00 2001 From: Lars Uebernickel Date: Wed, 29 Aug 2012 13:27:54 +0200 Subject: Add gtk-doc support --- Makefile.am | 6 ++++- autogen.sh | 2 +- configure.ac | 8 +++++-- doc/Makefile.am | 1 + doc/reference/Makefile.am | 21 ++++++++++++++++++ doc/reference/messaging-menu-docs.xml.in | 38 ++++++++++++++++++++++++++++++++ libmessaging-menu/messaging-menu.c | 2 +- 7 files changed, 73 insertions(+), 5 deletions(-) create mode 100644 doc/Makefile.am create mode 100644 doc/reference/Makefile.am create mode 100644 doc/reference/messaging-menu-docs.xml.in 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 @@ + + + +]> + +Messaging Menu Reference Manual + + Messaging Menu Reference Manual + for libmessaging-menu &version; + + + 2012 + Canonical Ltd. + + + + + API Reference + + + + + Object Hierarchy + + + + API Index + + + + Index of deprecated API + + + + + 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 /** - * SECTION:messagingmenuapp + * SECTION:messaging-menu * @title: MessagingMenuApp * @short_description: An application section in the messaging menu * -- cgit v1.2.3