Enabled gtk-doc.

diff --git a/.gitignore b/.gitignore
index 8c7bba648dc66a4188c4b65a45ab55f48ceba588..25fce6b4355cb4362f45143fdd594869da2ae0a6 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -60,4 +60,16 @@ tests/session
 tests/tag
 tests/url
 *.gir
-*.typelib
\ No newline at end of file
+*.typelib
+test-driver
+docs/reference/*-decl-list.txt
+docs/reference/*-decl.txt
+docs/reference/*-overrides.txt
+docs/reference/*-undeclared.txt
+docs/reference/*-undocumented.txt
+docs/reference/*-unused.txt
+docs/reference/*.args
+docs/reference/*.hierarchy
+docs/reference/*.interfaces
+docs/reference/*.prerequisites
+docs/reference/*.signals

diff --git a/Makefile.am b/Makefile.am
index 4b717791cb1410ac247c4c41ec2a96b37253f6d8..66bbb6d324f65e21a0ac1178246ac156106ee2d7 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,6 +1,6 @@
-DISTCHECK_CONFIGURE_FLAGS = --enable-introspection
+DISTCHECK_CONFIGURE_FLAGS = --enable-introspection --enable-gtk-doc
 
-SUBDIRS = src tests
+SUBDIRS = src tests docs
 
 ACLOCAL_AMFLAGS = -I m4
 

diff --git a/configure.ac b/configure.ac
index f73f65a3d220f79ed78de3367718bb92c31ba2e7..91971a0628a152ae952f4ad470e49c38df2da46d 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -22,6 +22,9 @@ AC_LIBTOOL_WIN32_DLL
 
 GOBJECT_INTROSPECTION_CHECK([1.30.0])
 
+# check for gtk-doc
+GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
+
 # Checks for programs.
 AC_PROG_CC
 AC_PROG_CXX
@@ -70,5 +73,7 @@ AC_CONFIG_FILES([
        Makefile
        src/Makefile
        tests/Makefile
+       docs/Makefile
+       docs/reference/Makefile
 ])
 AC_OUTPUT

diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644 (file)
index 0000000..f3ddc22
--- /dev/null
+++ b/docs/Makefile.am
@@ -0,0 +1 @@
+SUBDIRS = reference

diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
new file mode 100644 (file)
index 0000000..47f2baa
--- /dev/null
+++ b/docs/reference/Makefile.am
@@ -0,0 +1,85 @@
+# 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=libzakcgi
+
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+#DOC_MODULE_VERSION=2
+
+# The top-level XML file.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
+
+# 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)/src
+
+# Extra options to pass to gtkdoc-scangobj. Normally not 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-mkhtml
+MKHTML_OPTIONS=
+
+# Extra options to supply to gtkdoc-fixref. Normally not 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)/src/*.h
+CFILE_GLOB=$(top_srcdir)/src/*.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=
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+HTML_IMAGES=
+
+# Extra files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.xml building.xml changes-2.0.xml
+content_files=
+
+# Files where gtk-doc abbrevations (#GtkWidget) are expanded
+# e.g. expand_content_files=running.xml
+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=-I$(top_srcdir)/src -I$(top_builddir)/src $(GTK_DEBUG_FLAGS)
+GTKDOC_LIBS=$(top_builddir)/src/libzakcgi.la
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+# Comment this out if you want 'make check' to test you doc status
+# and run some sanity checks
+if ENABLE_GTK_DOC
+TESTS_ENVIRONMENT = \
+  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

diff --git a/docs/reference/libzakcgi-docs.xml b/docs/reference/libzakcgi-docs.xml
new file mode 100644 (file)
index 0000000..54fe8cd
--- /dev/null
+++ b/docs/reference/libzakcgi-docs.xml
@@ -0,0 +1,43 @@
+<?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 % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
+  %gtkdocentities;
+]>
+<book id="index">
+  <bookinfo>
+    <title>&package_name; Reference Manual</title>
+    <releaseinfo>
+      for &package_string;.
+      The latest version of this documentation can be found on-line at
+      <ulink role="online-location" url="http://[SERVER]/&package_name;/index.html">http://[SERVER]/&package_name;/</ulink>.
+    </releaseinfo>
+  </bookinfo>
+
+  <chapter>
+    <title>[Insert title here]</title>
+        <xi:include href="xml/commons.xml"/>
+    <xi:include href="xml/main.xml"/>
+    <xi:include href="xml/session.xml"/>
+    <xi:include href="xml/tag.xml"/>
+    <xi:include href="xml/url.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>
+  <!-- enable this when you use gobject introspection annotations
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+  -->
+</book>

diff --git a/docs/reference/libzakcgi-sections.txt b/docs/reference/libzakcgi-sections.txt
new file mode 100644 (file)
index 0000000..d29a366
--- /dev/null
+++ b/docs/reference/libzakcgi-sections.txt
@@ -0,0 +1,69 @@
+<SECTION>
+<FILE>commons</FILE>
+zak_cgi_commons_valist_to_ghashtable
+zak_cgi_commons_ghashtable_to_str_attrs
+</SECTION>
+
+<SECTION>
+<FILE>main</FILE>
+ZakCgiMain
+ZAK_CGI_TYPE_FILE
+zak_cgi_main_get_stdin
+zak_cgi_main_parse_stdin
+zak_cgi_main_get_stdin_field
+zak_cgi_main_stdin_foreach
+zak_cgi_main_redirect
+zak_cgi_main_is_request_method
+zak_cgi_main_is_get
+zak_cgi_main_is_post
+ZakCgiMainClass
+<SUBSECTION Standard>
+ZAK_CGI_IS_MAIN
+ZAK_CGI_IS_MAIN_CLASS
+ZAK_CGI_MAIN
+ZAK_CGI_MAIN_CLASS
+ZAK_CGI_MAIN_GET_CLASS
+ZAK_CGI_TYPE_MAIN
+zak_cgi_file_get_type
+</SECTION>
+
+<SECTION>
+<FILE>session</FILE>
+ZakCgiSession
+ZakCgiSessionClass
+<SUBSECTION Standard>
+ZAK_CGI_IS_SESSION
+ZAK_CGI_IS_SESSION_CLASS
+ZAK_CGI_SESSION
+ZAK_CGI_SESSION_CLASS
+ZAK_CGI_SESSION_GET_CLASS
+ZAK_CGI_TYPE_SESSION
+</SECTION>
+
+<SECTION>
+<FILE>tag</FILE>
+zak_cgi_tag_tag
+zak_cgi_tag_tag_ht
+zak_cgi_tag_img
+zak_cgi_tag_img_ht
+zak_cgi_tag_text
+zak_cgi_tag_text_ht
+zak_cgi_tag_file
+zak_cgi_tag_file_ht
+zak_cgi_tag_submit
+zak_cgi_tag_submit_ht
+</SECTION>
+
+<SECTION>
+<FILE>url</FILE>
+ZakCgiUrl
+ZakCgiUrlClass
+<SUBSECTION Standard>
+ZAK_CGI_IS_URL
+ZAK_CGI_IS_URL_CLASS
+ZAK_CGI_TYPE_URL
+ZAK_CGI_URL
+ZAK_CGI_URL_CLASS
+ZAK_CGI_URL_GET_CLASS
+</SECTION>
+

diff --git a/docs/reference/libzakcgi.types b/docs/reference/libzakcgi.types
new file mode 100644 (file)
index 0000000..bf5480f
--- /dev/null
+++ b/docs/reference/libzakcgi.types
@@ -0,0 +1 @@
+zak_cgi_file_get_type