]> err.no Git - libchamplain/commitdiff
Fix libchamplain-gtk doc generation
authorPierre-Luc Beaudoin <pierre-luc@pierlux.com>
Thu, 12 Feb 2009 21:00:46 +0000 (23:00 +0200)
committerPierre-Luc Beaudoin <pierre-luc@pierlux.com>
Thu, 12 Feb 2009 21:00:46 +0000 (23:00 +0200)
13 files changed:
Makefile.am
configure.ac
docs/reference-gtk/Makefile.am [new file with mode: 0644]
docs/reference-gtk/libchamplain-gtk-docs.sgml [new file with mode: 0644]
docs/reference-gtk/libchamplain-gtk-overrides.txt [new file with mode: 0644]
docs/reference-gtk/libchamplain-gtk-sections.txt [new file with mode: 0644]
docs/reference-gtk/tmpl/champlain-gtk-marshal.sgml [new file with mode: 0644]
docs/reference-gtk/tmpl/champlain-gtk-marshal.sgml.bak [new file with mode: 0644]
docs/reference-gtk/tmpl/champlainviewembed.sgml [new file with mode: 0644]
docs/reference-gtk/tmpl/champlainviewembed.sgml.bak [new file with mode: 0644]
docs/reference-gtk/tmpl/libchamplain-gtk-unused.sgml [new file with mode: 0644]
docs/reference-gtk/version.xml.in [new file with mode: 0644]
docs/reference/Makefile.am

index 97b1bb8f2088b432f08fde97ab6fe937ee59a1a2..d4f24088f16329e9cae3874da22ef3b5223e55ab 100644 (file)
@@ -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
index a5442e5c2aa1730f5339f5b8cf6834e058fcf87e..2c78886e241e963888a060a341bdb739e4f7ec2c 100644 (file)
@@ -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 (file)
index 0000000..ac75107
--- /dev/null
@@ -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 (file)
index 0000000..5358797
--- /dev/null
@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!ENTITY version SYSTEM "version.xml">
+]>
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+  <bookinfo>
+    <title>libchamplain-gtk Reference Manual</title>
+    <releaseinfo>
+      for libchamplain-gtk &version;
+      The latest version of this documentation can be found on-line at
+      <ulink role="online-location" url="http://blog.pierlux.com/projects/libchamplain/">http://blog.pierlux.com/projects/libchamplain/</ulink>.
+    </releaseinfo>
+  </bookinfo>
+
+  <chapter>
+    <title>I. API Reference</title>
+    <xi:include href="xml/champlainviewembed.xml"/>
+  </chapter>
+</book>
diff --git a/docs/reference-gtk/libchamplain-gtk-overrides.txt b/docs/reference-gtk/libchamplain-gtk-overrides.txt
new file mode 100644 (file)
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 (file)
index 0000000..a04f9c2
--- /dev/null
@@ -0,0 +1,19 @@
+<SECTION>
+<FILE>champlainviewembed</FILE>
+<TITLE>ChamplainViewEmbed</TITLE>
+champlain_view_embed_new
+champlain_view_embed_get_view
+<SUBSECTION Standard>
+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
+</SECTION>
+
+<SECTION>
+<FILE>champlain-gtk-marshal</FILE>
+</SECTION>
+
diff --git a/docs/reference-gtk/tmpl/champlain-gtk-marshal.sgml b/docs/reference-gtk/tmpl/champlain-gtk-marshal.sgml
new file mode 100644 (file)
index 0000000..7acbe5a
--- /dev/null
@@ -0,0 +1,19 @@
+<!-- ##### SECTION Title ##### -->
+champlain-gtk-marshal
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
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 (file)
index 0000000..38e6dc1
--- /dev/null
@@ -0,0 +1,21 @@
+<!-- ##### SECTION Title ##### -->
+champlain-gtk-marshal
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
diff --git a/docs/reference-gtk/tmpl/champlainviewembed.sgml b/docs/reference-gtk/tmpl/champlainviewembed.sgml
new file mode 100644 (file)
index 0000000..5087dde
--- /dev/null
@@ -0,0 +1,37 @@
+<!-- ##### SECTION Title ##### -->
+ChamplainViewEmbed
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### FUNCTION champlain_view_embed_new ##### -->
+<para>
+
+</para>
+
+@view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION champlain_view_embed_get_view ##### -->
+<para>
+
+</para>
+
+@embed: 
+@Returns: 
+
+
diff --git a/docs/reference-gtk/tmpl/champlainviewembed.sgml.bak b/docs/reference-gtk/tmpl/champlainviewembed.sgml.bak
new file mode 100644 (file)
index 0000000..46a6ca7
--- /dev/null
@@ -0,0 +1,39 @@
+<!-- ##### SECTION Title ##### -->
+ChamplainViewEmbed
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### FUNCTION champlain_view_embed_new ##### -->
+<para>
+
+</para>
+
+@view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION champlain_view_embed_get_view ##### -->
+<para>
+
+</para>
+
+@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 (file)
index 0000000..e69de29
diff --git a/docs/reference-gtk/version.xml.in b/docs/reference-gtk/version.xml.in
new file mode 100644 (file)
index 0000000..a24f987
--- /dev/null
@@ -0,0 +1 @@
+@PACKAGE_VERSION@
index db48ec45670ab9e0e7ec88073eb9c8e1eeedbe89..887e6885dd08ace376d063a0ff1d52c4da6765c9 100644 (file)
@@ -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