r3079 - in trunk/src/target/OM-2007.2/libraries/libmokojournal2: . doc doc/reference

thomas at sita.openmoko.org thomas at sita.openmoko.org
Thu Oct 4 13:10:13 CEST 2007 

Author: thomas
Date: 2007-10-04 13:10:11 +0200 (Thu, 04 Oct 2007)
New Revision: 3079

Added:
   trunk/src/target/OM-2007.2/libraries/libmokojournal2/doc/
   trunk/src/target/OM-2007.2/libraries/libmokojournal2/doc/Makefile.am
   trunk/src/target/OM-2007.2/libraries/libmokojournal2/doc/reference/
   trunk/src/target/OM-2007.2/libraries/libmokojournal2/doc/reference/Makefile.am
   trunk/src/target/OM-2007.2/libraries/libmokojournal2/doc/reference/libmokojournal-docs.sgml
   trunk/src/target/OM-2007.2/libraries/libmokojournal2/doc/reference/version.xml.in
Modified:
   trunk/src/target/OM-2007.2/libraries/libmokojournal2/ChangeLog
   trunk/src/target/OM-2007.2/libraries/libmokojournal2/Makefile.am
   trunk/src/target/OM-2007.2/libraries/libmokojournal2/autogen.sh
   trunk/src/target/OM-2007.2/libraries/libmokojournal2/configure.ac
Log:
* Makefile.am:
* autogen.sh:
* configure.ac:
* doc/reference/Makefile.am:
* doc/reference/libmokojournal-docs.sgml:

Add gtk-doc support


Modified: trunk/src/target/OM-2007.2/libraries/libmokojournal2/ChangeLog
===================================================================
--- trunk/src/target/OM-2007.2/libraries/libmokojournal2/ChangeLog	2007-10-04 11:08:44 UTC (rev 3078)
+++ trunk/src/target/OM-2007.2/libraries/libmokojournal2/ChangeLog	2007-10-04 11:10:11 UTC (rev 3079)
@@ -1,3 +1,13 @@
+2007-10-04  Thomas Wood  <thomas at openedhand.com>
+
+	* Makefile.am:
+	* autogen.sh:
+	* configure.ac:
+	* doc/reference/Makefile.am:
+	* doc/reference/libmokojournal-docs.sgml:
+
+	Add gtk-doc support
+
 2007-08-22  Holger Freyther  <zecke at selfish.org>
 
         Rubberstamped by Mickey.

Modified: trunk/src/target/OM-2007.2/libraries/libmokojournal2/Makefile.am
===================================================================
--- trunk/src/target/OM-2007.2/libraries/libmokojournal2/Makefile.am	2007-10-04 11:08:44 UTC (rev 3078)
+++ trunk/src/target/OM-2007.2/libraries/libmokojournal2/Makefile.am	2007-10-04 11:10:11 UTC (rev 3079)
@@ -1,4 +1,4 @@
-SUBDIRS = mokojournal mokojournal-tool tests
+SUBDIRS = mokojournal mokojournal-tool tests doc
 
 pcdata_DATA= libmokojournal2.pc
 pcdatadir= $(libdir)/pkgconfig

Modified: trunk/src/target/OM-2007.2/libraries/libmokojournal2/autogen.sh
===================================================================
--- trunk/src/target/OM-2007.2/libraries/libmokojournal2/autogen.sh	2007-10-04 11:08:44 UTC (rev 3078)
+++ trunk/src/target/OM-2007.2/libraries/libmokojournal2/autogen.sh	2007-10-04 11:10:11 UTC (rev 3079)
@@ -1,4 +1,5 @@
 #! /bin/sh
+gtkdocize || exit 1
 autoreconf -v --install || exit 1
 glib-gettextize --force --copy || exit 1
 ./configure --enable-maintainer-mode "$@"

Modified: trunk/src/target/OM-2007.2/libraries/libmokojournal2/configure.ac
===================================================================
--- trunk/src/target/OM-2007.2/libraries/libmokojournal2/configure.ac	2007-10-04 11:08:44 UTC (rev 3078)
+++ trunk/src/target/OM-2007.2/libraries/libmokojournal2/configure.ac	2007-10-04 11:10:11 UTC (rev 3079)
@@ -35,6 +35,8 @@
 
 AC_SUBST(LIBS)
 
+GTK_DOC_CHECK([1.4])
+
 # output stuff
 AC_OUTPUT([
 Makefile
@@ -42,6 +44,9 @@
 mokojournal/Makefile
 mokojournal-tool/Makefile
 tests/Makefile
+doc/Makefile
+doc/reference/Makefile
+doc/reference/version.xml
 ])
 
 echo "CFLAGS = $CFLAGS"

Added: trunk/src/target/OM-2007.2/libraries/libmokojournal2/doc/Makefile.am
===================================================================
--- trunk/src/target/OM-2007.2/libraries/libmokojournal2/doc/Makefile.am	2007-10-04 11:08:44 UTC (rev 3078)
+++ trunk/src/target/OM-2007.2/libraries/libmokojournal2/doc/Makefile.am	2007-10-04 11:10:11 UTC (rev 3079)
@@ -0,0 +1 @@
+SUBDIRS=reference

Added: trunk/src/target/OM-2007.2/libraries/libmokojournal2/doc/reference/Makefile.am
===================================================================
--- trunk/src/target/OM-2007.2/libraries/libmokojournal2/doc/reference/Makefile.am	2007-10-04 11:08:44 UTC (rev 3078)
+++ trunk/src/target/OM-2007.2/libraries/libmokojournal2/doc/reference/Makefile.am	2007-10-04 11:10:11 UTC (rev 3079)
@@ -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=libmokojournal
+
+# 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=../../mokojournal
+
+# 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=
+
+# 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)/mokojournal/*.h
+CFILE_GLOB=$(top_srcdir)/mokojournal/*.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_scrdir) $(CFLAGS)
+GTKDOC_LIBS=$(LIBS) $(top_builddir)/mokojournal/libmokojournal2.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 = 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)
+

Added: trunk/src/target/OM-2007.2/libraries/libmokojournal2/doc/reference/libmokojournal-docs.sgml
===================================================================
--- trunk/src/target/OM-2007.2/libraries/libmokojournal2/doc/reference/libmokojournal-docs.sgml	2007-10-04 11:08:44 UTC (rev 3078)
+++ trunk/src/target/OM-2007.2/libraries/libmokojournal2/doc/reference/libmokojournal-docs.sgml	2007-10-04 11:10:11 UTC (rev 3079)
@@ -0,0 +1,22 @@
+<?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">
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+  <bookinfo>
+    <title>libmokojournal Reference Manual</title>
+<!--
+    <releaseinfo>
+      for libmokojournal [VERSION]
+      The latest version of this documentation can be found on-line at
+      <ulink role="online-location" url="http://[SERVER]/libmokojournal/index.html">http://[SERVER]/libmokojournal/</ulink>.
+    </releaseinfo>
+ -->
+  </bookinfo>
+
+  <chapter>
+    <title>libmokojournal2</title>
+    <xi:include href="xml/moko-journal.xml"/>
+    <xi:include href="xml/moko-time-priv.xml"/>
+    <xi:include href="xml/moko-time.xml"/>
+  </chapter>
+</book>

Added: trunk/src/target/OM-2007.2/libraries/libmokojournal2/doc/reference/version.xml.in
===================================================================
--- trunk/src/target/OM-2007.2/libraries/libmokojournal2/doc/reference/version.xml.in	2007-10-04 11:08:44 UTC (rev 3078)
+++ trunk/src/target/OM-2007.2/libraries/libmokojournal2/doc/reference/version.xml.in	2007-10-04 11:10:11 UTC (rev 3079)
@@ -0,0 +1 @@
+ at VERSION@

More information about the commitlog mailing list