From 4fe03992b568decdbdfa5dc30de27d4876eb9331 Mon Sep 17 00:00:00 2001 From: Ken VanDine Date: Wed, 9 Jun 2010 12:24:31 -0400 Subject: Build gtk-doc (LP: #422087) --- docs/Makefile.am | 1 + docs/libdbusmenu-glib/Makefile.am | 1 + docs/libdbusmenu-glib/reference/Makefile.am | 87 ++++++++++++++++++++++ .../reference/libdbusmenu-glib-docs.sgml | 33 ++++++++ docs/libdbusmenu-glib/reference/version.xml.in | 1 + docs/libdbusmenu-gtk/Makefile.am | 1 + docs/libdbusmenu-gtk/reference/Makefile.am | 87 ++++++++++++++++++++++ .../reference/libdbusmenu-gtk-docs.sgml | 30 ++++++++ docs/libdbusmenu-gtk/reference/version.xml.in | 1 + 9 files changed, 242 insertions(+) create mode 100644 docs/Makefile.am create mode 100644 docs/libdbusmenu-glib/Makefile.am create mode 100644 docs/libdbusmenu-glib/reference/Makefile.am create mode 100644 docs/libdbusmenu-glib/reference/libdbusmenu-glib-docs.sgml create mode 100644 docs/libdbusmenu-glib/reference/version.xml.in create mode 100644 docs/libdbusmenu-gtk/Makefile.am create mode 100644 docs/libdbusmenu-gtk/reference/Makefile.am create mode 100644 docs/libdbusmenu-gtk/reference/libdbusmenu-gtk-docs.sgml create mode 100644 docs/libdbusmenu-gtk/reference/version.xml.in (limited to 'docs') diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 0000000..87ffe5f --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1 @@ +SUBDIRS = libdbusmenu-glib libdbusmenu-gtk diff --git a/docs/libdbusmenu-glib/Makefile.am b/docs/libdbusmenu-glib/Makefile.am new file mode 100644 index 0000000..f3ddc22 --- /dev/null +++ b/docs/libdbusmenu-glib/Makefile.am @@ -0,0 +1 @@ +SUBDIRS = reference diff --git a/docs/libdbusmenu-glib/reference/Makefile.am b/docs/libdbusmenu-glib/reference/Makefile.am new file mode 100644 index 0000000..4f511bc --- /dev/null +++ b/docs/libdbusmenu-glib/reference/Makefile.am @@ -0,0 +1,87 @@ +## 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=libdbusmenu-glib + +# 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=../../../libdbusmenu-glib + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS=--nogtkinit --type-init-func="g_type_init()" + +# 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)/libdbusmenu-glib/*.h +CFILE_GLOB=$(top_srcdir)/libdbusmenu-glib/*.c + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES=menuitem-marshal.h server-marshal.h menuitem-private.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=version.xml + +# 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) $(DBUSMENUGLIB_CFLAGS) $(DBUSMENUGTK_CFLAGS) +GTKDOC_LIBS=$(top_builddir)/libdbusmenu-glib/libdbusmenu-glib.la + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.local.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += version.xml.in + +# Files not to distribute +# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types +# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt +#DISTCLEANFILES += + +# Comment this out if you want your docs-status tested during 'make check' +#TESTS = $(GTKDOC_CHECK) + diff --git a/docs/libdbusmenu-glib/reference/libdbusmenu-glib-docs.sgml b/docs/libdbusmenu-glib/reference/libdbusmenu-glib-docs.sgml new file mode 100644 index 0000000..ecc25a3 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/libdbusmenu-glib-docs.sgml @@ -0,0 +1,33 @@ + + +]> + + + libdbusmenu-glib Reference Manual + + + + API + + + + + + + + + + + Object Hierarchy + + + + API Index + + + + + diff --git a/docs/libdbusmenu-glib/reference/version.xml.in b/docs/libdbusmenu-glib/reference/version.xml.in new file mode 100644 index 0000000..d78bda9 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/version.xml.in @@ -0,0 +1 @@ +@VERSION@ diff --git a/docs/libdbusmenu-gtk/Makefile.am b/docs/libdbusmenu-gtk/Makefile.am new file mode 100644 index 0000000..f3ddc22 --- /dev/null +++ b/docs/libdbusmenu-gtk/Makefile.am @@ -0,0 +1 @@ +SUBDIRS = reference diff --git a/docs/libdbusmenu-gtk/reference/Makefile.am b/docs/libdbusmenu-gtk/reference/Makefile.am new file mode 100644 index 0000000..ec1bd28 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/Makefile.am @@ -0,0 +1,87 @@ +## 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=libdbusmenu-gtk + +# 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=../../../libdbusmenu-gtk + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS=--nogtkinit --type-init-func="g_type_init()" + +# 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)/libdbusmenu-gtk/*.h +CFILE_GLOB=$(top_srcdir)/libdbusmenu-gtk/*.c + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES= + +# 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=version.xml + +# 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) $(DBUSMENUGLIB_CFLAGS) $(DBUSMENUGTK_CFLAGS) +GTKDOC_LIBS=$(top_builddir)/libdbusmenu-gtk/libdbusmenu-gtk.la + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.local.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += version.xml.in + +# Files not to distribute +# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types +# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt +#DISTCLEANFILES += + +# Comment this out if you want your docs-status tested during 'make check' +#TESTS = $(GTKDOC_CHECK) + diff --git a/docs/libdbusmenu-gtk/reference/libdbusmenu-gtk-docs.sgml b/docs/libdbusmenu-gtk/reference/libdbusmenu-gtk-docs.sgml new file mode 100644 index 0000000..ae9ab07 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/libdbusmenu-gtk-docs.sgml @@ -0,0 +1,30 @@ + + +]> + + + libdbusmenu-gtk Reference Manual + + + + API + + + + + + + + Object Hierarchy + + + + API Index + + + + + diff --git a/docs/libdbusmenu-gtk/reference/version.xml.in b/docs/libdbusmenu-gtk/reference/version.xml.in new file mode 100644 index 0000000..d78bda9 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/version.xml.in @@ -0,0 +1 @@ +@VERSION@ -- cgit v1.2.3