Permalink
Browse files

Generate document from gtk-doc

  • Loading branch information...
1 parent 3b504f6 commit f0e15856438cf25b7e09f30cc8ceb299a8cdc1f8 @tagoh committed Jan 18, 2012
View
2 Makefile.am
@@ -1,6 +1,6 @@
NULL =
AUTOMAKE_OPTIONS = dist-bzip2
-SUBDIRS = liblangtag data
+SUBDIRS = liblangtag data docs
if ENABLE_GOBJECT
SUBDIRS += liblangtag-gobject
View
2 configure.ac
@@ -109,6 +109,8 @@ dnl ======================================================================
AC_CONFIG_FILES([
Makefile
data/Makefile
+ docs/Makefile
+ docs/version.xml
liblangtag/Makefile
liblangtag-gobject/Makefile
liblangtag.pc
View
124 docs/Makefile.am
@@ -0,0 +1,124 @@
+## Process this file with automake to produce Makefile.in
+
+NULL =
+
+# 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=liblangtag
+
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+#DOC_MODULE_VERSION=2
+
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# Directories containing the source code.
+# gtk-doc will search all .c and .h files beneath these paths
+# for inline comments documenting functions and macros.
+# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
+DOC_SOURCE_DIR=$(top_srcdir)/liblangtag
+
+# 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=--xml-mode --output-format=xml
+MKDB_OPTIONS=--xml-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-mkhtml
+MKHTML_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)/liblangtag/*.h
+CFILE_GLOB=$(top_srcdir)/liblangtag/*.c
+
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+EXTRA_HFILES=
+
+# Header files or dirs to ignore when scanning. Use base file/dir names
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
+IGNORE_HFILES= \
+ langtag.h \
+ lt-extlang-private.h \
+ lt-grandfathered-private.h \
+ lt-lang-private.h \
+ lt-mem.h \
+ lt-region-private.h \
+ lt-script-private.h \
+ lt-tag-private.h \
+ lt-utils.h \
+ lt-variant-private.h \
+ $(NULL)
+
+# 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 \
+ $(NULL)
+
+# 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. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+GTKDOC_CFLAGS=
+GTKDOC_LIBS= \
+ $(top_builddir)/liblangtag/liblangtag.la \
+ $(NULL)
+
+# 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 \
+ $(NULL)
+
+# 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 'make check' to test you doc status
+# and run some sanity checks
+if ENABLE_GTK_DOC
+TESTS_ENVIRONMENT = cd $(srcdir) && \
+ DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
+ SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
+#TESTS = $(GTKDOC_CHECK)
+endif
+
+-include $(top_srcdir)/git.mk
View
59 docs/liblangtag-docs.sgml
@@ -0,0 +1,59 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+ <!ENTITY version SYSTEM "version.xml">
+]>
+<book id="index">
+ <bookinfo>
+ <title>liblangtag Documentation</title>
+ <releaseinfo>
+ for liblangtag &version;.
+<!--
+ The latest version of this documentation can be found on-line at
+ <ulink role="online-location" url="http://[SERVER]/liblangtag/index.html">http://[SERVER]/liblangtag/</ulink>.
+-->
+ </releaseinfo>
+ </bookinfo>
+
+ <chapter>
+ <title>liblangtag API References</title>
+ <section id="Database">
+ <title>Database APIs</title>
+ <xi:include href="xml/lt-database.xml"/>
+ <xi:include href="xml/lt-extlang-db.xml"/>
+ <xi:include href="xml/lt-grandfathered-db.xml"/>
+ <xi:include href="xml/lt-lang-db.xml"/>
+ <xi:include href="xml/lt-region-db.xml"/>
+ <xi:include href="xml/lt-script-db.xml"/>
+ <xi:include href="xml/lt-variant-db.xml"/>
+ </section>
+ <section id="Container">
+ <title>Container APIs</title>
+ <xi:include href="xml/lt-extlang.xml"/>
+ <xi:include href="xml/lt-grandfathered.xml"/>
+ <xi:include href="xml/lt-lang.xml"/>
+ <xi:include href="xml/lt-region.xml"/>
+ <xi:include href="xml/lt-script.xml"/>
+ <xi:include href="xml/lt-tag.xml"/>
+ <xi:include href="xml/lt-variant.xml"/>
+ </section>
+ <xi:include href="xml/lt-error.xml"/>
+
+ </chapter>
+ <chapter id="object-tree">
+ <title>Object Hierarchy</title>
+ <xi:include href="xml/tree_index.sgml"/>
+ </chapter>
+ <index id="api-index-full">
+ <title>API Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="deprecated-api-index" role="deprecated">
+ <title>Index of deprecated API</title>
+ <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+ </index>
+
+ <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>
View
0 docs/liblangtag-overrides.txt
No changes.
View
0 docs/liblangtag.types
No changes.
View
1 docs/version.xml.in
@@ -0,0 +1 @@
+@VERSION@

0 comments on commit f0e1585

Please sign in to comment.