From 0dfe97f894f04f3bd10c6166942751b9df9041e7 Mon Sep 17 00:00:00 2001 From: Pierre-Luc Beaudoin Date: Thu, 12 Feb 2009 23:00:46 +0200 Subject: [PATCH] Fix libchamplain-gtk doc generation --- Makefile.am | 6 +- configure.ac | 2 + docs/reference-gtk/Makefile.am | 84 +++++++++++++++++++ docs/reference-gtk/libchamplain-gtk-docs.sgml | 20 +++++ .../libchamplain-gtk-overrides.txt | 0 .../libchamplain-gtk-sections.txt | 19 +++++ .../tmpl/champlain-gtk-marshal.sgml | 19 +++++ .../tmpl/champlain-gtk-marshal.sgml.bak | 21 +++++ .../tmpl/champlainviewembed.sgml | 37 ++++++++ .../tmpl/champlainviewembed.sgml.bak | 39 +++++++++ .../tmpl/libchamplain-gtk-unused.sgml | 0 docs/reference-gtk/version.xml.in | 1 + docs/reference/Makefile.am | 8 +- 13 files changed, 249 insertions(+), 7 deletions(-) create mode 100644 docs/reference-gtk/Makefile.am create mode 100644 docs/reference-gtk/libchamplain-gtk-docs.sgml create mode 100644 docs/reference-gtk/libchamplain-gtk-overrides.txt create mode 100644 docs/reference-gtk/libchamplain-gtk-sections.txt create mode 100644 docs/reference-gtk/tmpl/champlain-gtk-marshal.sgml create mode 100644 docs/reference-gtk/tmpl/champlain-gtk-marshal.sgml.bak create mode 100644 docs/reference-gtk/tmpl/champlainviewembed.sgml create mode 100644 docs/reference-gtk/tmpl/champlainviewembed.sgml.bak create mode 100644 docs/reference-gtk/tmpl/libchamplain-gtk-unused.sgml create mode 100644 docs/reference-gtk/version.xml.in diff --git a/Makefile.am b/Makefile.am index 97b1bb8..d4f2408 100644 --- a/Makefile.am +++ b/Makefile.am @@ -3,16 +3,16 @@ SUBDIRS = tidy champlain docs/reference ACLOCAL_AMFLAGS = -I m4 pcfiles = champlain-@API_VERSION@.pc +champlain-@API_VERSION@.pc: champlain.pc + @cp -f $< $@ if ENABLE_GTK -SUBDIRS += champlain-gtk +SUBDIRS += champlain-gtk docs/reference-gtk pcfiles += champlain-gtk-@API_VERSION@.pc champlain-gtk-@API_VERSION@.pc: champlain-gtk.pc @cp -f $< $@ endif -champlain-@API_VERSION@.pc: champlain.pc - @cp -f $< $@ pkgconfig_DATA = $(pcfiles) pkgconfigdir = $(libdir)/pkgconfig diff --git a/configure.ac b/configure.ac index a5442e5..2c78886 100644 --- a/configure.ac +++ b/configure.ac @@ -69,6 +69,8 @@ if test x$enable_gtk = xyes; then ) AC_CONFIG_FILES([champlain-gtk/Makefile + docs/reference-gtk/Makefile + docs/reference-gtk/version.xml champlain-gtk.pc]) AC_DEFINE(ENABLE_GTK, [], [Enable Gtk+ view code]) diff --git a/docs/reference-gtk/Makefile.am b/docs/reference-gtk/Makefile.am new file mode 100644 index 0000000..ac75107 --- /dev/null +++ b/docs/reference-gtk/Makefile.am @@ -0,0 +1,84 @@ +## Process this file with automake to produce Makefile.in + +AUTOMAKE_OPTIONS = 1.6 + +# The name of the module, e.g. 'glib'. +DOC_MODULE=libchamplain-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=../../champlain-gtk + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS= + +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS=--deprecated-guards="CHAMPLAIN_OBSOLETE_API" + +# 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= \ + --extra-dir=$(PREFIX)/share/gtk-doc/html/gobject \ + --extra-dir=$(PREFIX)/share/gtk-doc/html/glib \ + --extra-dir=$(PREFIX)/share/gtk-doc/html/clutter + +# 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)/champlain-gtk/*.h +CFILE_GLOB=$(top_srcdir)/champlain-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)/champlain -I$(top_srcdir) -I$(top_builddir) $(DEPS_CFLAGS) +GTKDOC_LIBS=$(DEPS_LIBS) $(top_builddir)/champlain-gtk/libchamplain-gtk-0.2.la + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += + +# 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/reference-gtk/libchamplain-gtk-docs.sgml b/docs/reference-gtk/libchamplain-gtk-docs.sgml new file mode 100644 index 0000000..5358797 --- /dev/null +++ b/docs/reference-gtk/libchamplain-gtk-docs.sgml @@ -0,0 +1,20 @@ + + +]> + + + libchamplain-gtk Reference Manual + + for libchamplain-gtk &version; + The latest version of this documentation can be found on-line at + http://blog.pierlux.com/projects/libchamplain/. + + + + + I. API Reference + + + diff --git a/docs/reference-gtk/libchamplain-gtk-overrides.txt b/docs/reference-gtk/libchamplain-gtk-overrides.txt new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference-gtk/libchamplain-gtk-sections.txt b/docs/reference-gtk/libchamplain-gtk-sections.txt new file mode 100644 index 0000000..a04f9c2 --- /dev/null +++ b/docs/reference-gtk/libchamplain-gtk-sections.txt @@ -0,0 +1,19 @@ +
+champlainviewembed +ChamplainViewEmbed +champlain_view_embed_new +champlain_view_embed_get_view + +CHAMPLAIN_VIEW_EMBED +CHAMPLAIN_IS_VIEW_EMBED +CHAMPLAIN_TYPE_VIEW_EMBED +champlain_view_embed_get_type +CHAMPLAIN_VIEW_EMBED_CLASS +CHAMPLAIN_IS_VIEW_EMBED_CLASS +CHAMPLAIN_VIEW_EMBED_GET_CLASS +
+ +
+champlain-gtk-marshal +
+ diff --git a/docs/reference-gtk/tmpl/champlain-gtk-marshal.sgml b/docs/reference-gtk/tmpl/champlain-gtk-marshal.sgml new file mode 100644 index 0000000..7acbe5a --- /dev/null +++ b/docs/reference-gtk/tmpl/champlain-gtk-marshal.sgml @@ -0,0 +1,19 @@ + +champlain-gtk-marshal + + + + + + + + + + + + + + + + + diff --git a/docs/reference-gtk/tmpl/champlain-gtk-marshal.sgml.bak b/docs/reference-gtk/tmpl/champlain-gtk-marshal.sgml.bak new file mode 100644 index 0000000..38e6dc1 --- /dev/null +++ b/docs/reference-gtk/tmpl/champlain-gtk-marshal.sgml.bak @@ -0,0 +1,21 @@ + +champlain-gtk-marshal + + + + + + + + + + + + + + + + + + + diff --git a/docs/reference-gtk/tmpl/champlainviewembed.sgml b/docs/reference-gtk/tmpl/champlainviewembed.sgml new file mode 100644 index 0000000..5087dde --- /dev/null +++ b/docs/reference-gtk/tmpl/champlainviewembed.sgml @@ -0,0 +1,37 @@ + +ChamplainViewEmbed + + + + + + + + + + + + + + + + + + + + + + +@view: +@Returns: + + + + + + + +@embed: +@Returns: + + diff --git a/docs/reference-gtk/tmpl/champlainviewembed.sgml.bak b/docs/reference-gtk/tmpl/champlainviewembed.sgml.bak new file mode 100644 index 0000000..46a6ca7 --- /dev/null +++ b/docs/reference-gtk/tmpl/champlainviewembed.sgml.bak @@ -0,0 +1,39 @@ + +ChamplainViewEmbed + + + + + + + + + + + + + + + + + + + + + + + + +@view: +@Returns: + + + + + + + +@embed: +@Returns: + + diff --git a/docs/reference-gtk/tmpl/libchamplain-gtk-unused.sgml b/docs/reference-gtk/tmpl/libchamplain-gtk-unused.sgml new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference-gtk/version.xml.in b/docs/reference-gtk/version.xml.in new file mode 100644 index 0000000..a24f987 --- /dev/null +++ b/docs/reference-gtk/version.xml.in @@ -0,0 +1 @@ +@PACKAGE_VERSION@ diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index db48ec4..887e688 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -12,7 +12,7 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml # 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=../../champlain ../../champlain-gtk +DOC_SOURCE_DIR=../../champlain # Extra options to pass to gtkdoc-scangobj. Not normally needed. SCANGOBJ_OPTIONS= @@ -39,8 +39,8 @@ 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)/champlain/*.h $(top_srcdir)/champlain-gtk/*.h -CFILE_GLOB=$(top_srcdir)/champlain/*.c $(top_srcdir)/champlain-gtk/*.c +HFILE_GLOB=$(top_srcdir)/champlain/*.h +CFILE_GLOB=$(top_srcdir)/champlain/*.c # Header files to ignore when scanning. # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h @@ -65,7 +65,7 @@ expand_content_files= # e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) INCLUDES=-I$(top_srcdir)/champlain -I$(top_srcdir) -I$(top_builddir) $(DEPS_CFLAGS) -GTKDOC_LIBS=$(DEPS_LIBS) $(top_builddir)/champlain/libchamplain-0.3.la $(top_builddir)/champlain-gtk/libchamplain-gtk-0.3.la +GTKDOC_LIBS=$(DEPS_LIBS) $(top_builddir)/champlain/libchamplain-0.3.la # This includes the standard gtk-doc make rules, copied by gtkdocize. include $(top_srcdir)/gtk-doc.make -- 2.39.5