Enabled gtk-doc.

diff --git a/.gitignore b/.gitignore
index 6fce3bf6af947f368c13f7d1aee5914b08a9b248..a6032c79272d5af1ef3779135325217ef334d3ae 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -37,6 +37,16 @@ m4/
 missing
 config.h
 config.status
+docs/reference/*.args
+docs/reference/*.hierarchy
+docs/reference/*.interfaces
+docs/reference/*.prerequisites
+docs/reference/*.signals
+docs/reference/*-decl.txt
+docs/reference/*-decl-list.txt
+docs/reference/*-undeclared.txt
+docs/reference/*-undocumented.txt
+docs/reference/*-unused.txt
 docs/reference/version.xml
 docs/reference/html/
 docs/reference/xml/
@@ -50,4 +60,5 @@ intltool-*
 Rules-quot
 *.exe
 *.csv
-src/*marshal*.[ch]
\ No newline at end of file
+src/*marshal*.[ch]
+test-driver
\ No newline at end of file

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

diff --git a/autogen.sh b/autogen.sh
index 83f5de2eff99d76076f1d617e180c5f07d309433..c32ddd775e9c6fdf8b979b8d7ea89b89a9d99c47 100755 (executable)
--- a/autogen.sh
+++ b/autogen.sh
@@ -24,7 +24,7 @@ fi
 set -x
 aclocal --install || exit 1
 glib-gettextize --force --copy || exit 1
-#gtkdocize --copy || exit 1
+gtkdocize --copy || exit 1
 intltoolize --force --copy --automake || exit 1
 autoreconf --verbose --force --install -Wno-portability || exit 1
 

diff --git a/configure.ac b/configure.ac
index 1f2bffefd0392ba1dbe39cb356e6241fa575d8d7..12baf731e9e76b4f0b2a9c8ce4bef1cdb8d2f0aa 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -29,7 +29,7 @@ AC_PROG_MAKE_SET
 AC_PROG_LIBTOOL
 AC_PROG_RANLIB
 
-GTK_DOC_CHECK(1.0)
+GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
 IT_PROG_INTLTOOL
 
 dnl ******************************
@@ -84,6 +84,8 @@ AM_CONDITIONAL(PLATFORM_WIN32, [test $platform_win32 = yes])
 AC_CONFIG_FILES([
        libzakform.pc
        Makefile
+       docs/Makefile
+       docs/reference/Makefile
        po/Makefile.in
        src/Makefile
        tests/Makefile

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..a5daac4
--- /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=libzakform
+
+# 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) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+GTKDOC_LIBS=$(top_builddir)/src/libzakform.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/libzakform-docs.xml b/docs/reference/libzakform-docs.xml
new file mode 100644 (file)
index 0000000..31935ae
--- /dev/null
+++ b/docs/reference/libzakform-docs.xml
@@ -0,0 +1,53 @@
+<?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/form.xml"/>
+    <xi:include href="xml/formelement.xml"/>
+    <xi:include href="xml/formelementfilter.xml"/>
+    <xi:include href="xml/formelementfilterluc.xml"/>
+    <xi:include href="xml/formelementfiltertrim.xml"/>
+    <xi:include href="xml/formelementvalidator.xml"/>
+    <xi:include href="xml/formelementvalidatordate.xml"/>
+    <xi:include href="xml/formelementvalidatornotempty.xml"/>
+    <xi:include href="xml/formelementvalidatorregex.xml"/>
+    <xi:include href="xml/formiprovider.xml"/>
+    <xi:include href="xml/formvalidator.xml"/>
+    <xi:include href="xml/formvalidatorcompare.xml"/>
+    <xi:include href="xml/formvalidatorcomparedate.xml"/>
+    <xi:include href="xml/formvalidatorcomposite.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/libzakform-overrides.txt b/docs/reference/libzakform-overrides.txt
new file mode 100644 (file)
index 0000000..e69de29

diff --git a/docs/reference/libzakform-sections.txt b/docs/reference/libzakform-sections.txt
new file mode 100644 (file)
index 0000000..fc84b59
--- /dev/null
+++ b/docs/reference/libzakform-sections.txt
@@ -0,0 +1,169 @@
+<SECTION>
+<FILE>commons</FILE>
+ZakFormCompareType
+zak_form_get_compare_type_from_string
+zak_form_get_compare_type_stringify
+zak_form_get_element_by_id
+</SECTION>
+
+<SECTION>
+<FILE>form</FILE>
+<TITLE>ZakFormForm</TITLE>
+ZAK_FORM_TYPE_FORM
+ZakFormFormClass
+ZakFormElementValidatorConstructorFunc
+zak_form_get_form_element_validator
+zak_form_form_load_from_xml
+zak_form_form_load_from_file
+zak_form_form_add_element
+zak_form_form_get_element_by_id
+zak_form_form_get_elements
+zak_form_form_get_elements_by_type
+zak_form_form_add_validator
+zak_form_form_get_validator_by_id
+zak_form_form_get_validators
+zak_form_form_get_validators_by_type
+zak_form_form_clear
+zak_form_form_set_as_original
+zak_form_form_is_valid
+zak_form_form_get_messages
+zak_form_form_is_changed
+zak_form_form_set_editable
+zak_form_form_load
+zak_form_form_insert
+zak_form_form_update
+zak_form_form_delete
+ZakFormForm
+</SECTION>
+
+<SECTION>
+<FILE>formelement</FILE>
+ZAK_FORM_TYPE_ELEMENT
+ZakFormElement
+ZakFormElementClass
+</SECTION>
+
+<SECTION>
+<FILE>formelementfilter</FILE>
+<TITLE>ZakFormElementFilter</TITLE>
+ZAK_FORM_TYPE_ELEMENT_FILTER
+ZakFormElementFilterClass
+zak_form_element_filter_xml_parsing
+zak_form_element_filter_filter
+zak_form_element_filter_set_id
+zak_form_element_filter_get_id
+zak_form_element_filter_get_enabled
+zak_form_element_filter_set_enabled
+ZakFormElementFilter
+</SECTION>
+
+<SECTION>
+<FILE>formelementfilterluc</FILE>
+ZAK_FORM_TYPE_ELEMENT_FILTER_LUC
+zak_form_element_filter_luc_new
+ZakFormElementFilterLuc
+</SECTION>
+
+<SECTION>
+<FILE>formelementfiltertrim</FILE>
+ZAK_FORM_TYPE_ELEMENT_FILTER_TRIM
+zak_form_element_filter_trim_new
+ZakFormElementFilterTrim
+</SECTION>
+
+<SECTION>
+<FILE>formelementvalidator</FILE>
+<TITLE>ZakFormElementValidator</TITLE>
+ZAK_FORM_TYPE_ELEMENT_VALIDATOR
+ZakFormElementValidatorClass
+zak_form_element_validator_xml_parsing
+zak_form_element_validator_validate
+zak_form_element_validator_set_id
+zak_form_element_validator_get_id
+zak_form_element_validator_set_message
+zak_form_element_validator_get_message
+zak_form_element_validator_get_enabled
+zak_form_element_validator_set_enabled
+ZakFormElementValidator
+</SECTION>
+
+<SECTION>
+<FILE>formelementvalidatordate</FILE>
+ZAK_FORM_TYPE_ELEMENT_VALIDATOR_DATE
+zak_form_element_validator_date_new
+zak_form_element_validator_date_set_compare_type
+zak_form_element_validator_date_get_compare_type
+zak_form_element_validator_date_set_compare_value
+zak_form_element_validator_date_get_compare_value
+zak_form_element_validator_date_set_format
+zak_form_element_validator_date_get_format
+ZakFormElementValidatorDate
+</SECTION>
+
+<SECTION>
+<FILE>formelementvalidatornotempty</FILE>
+ZAK_FORM_TYPE_ELEMENT_VALIDATOR_NOTEMPTY
+zak_form_element_validator_notempty_new
+zak_form_element_validator_notempty_set_as_empty_string
+zak_form_element_validator_notempty_get_as_empty_string
+ZakFormElementValidatorNotempty
+</SECTION>
+
+<SECTION>
+<FILE>formelementvalidatorregex</FILE>
+ZAK_FORM_TYPE_ELEMENT_VALIDATOR_REGEX
+zak_form_element_validator_regex_new
+zak_form_element_validator_regex_set_regex
+zak_form_element_validator_regex_get_regex
+ZakFormElementValidatorRegex
+</SECTION>
+
+<SECTION>
+<FILE>formiprovider</FILE>
+<TITLE>ZakFormIProvider</TITLE>
+ZAK_FORM_TYPE_IPROVIDER
+ZakFormIProviderInterface
+zak_form_iprovider_load
+zak_form_iprovider_insert
+zak_form_iprovider_update
+zak_form_iprovider_delete
+ZakFormIProvider
+</SECTION>
+
+<SECTION>
+<FILE>formvalidator</FILE>
+<TITLE>ZakFormValidator</TITLE>
+ZAK_FORM_TYPE_VALIDATOR
+ZakFormValidatorClass
+zak_form_validator_xml_parsing
+zak_form_validator_get_id
+zak_form_validator_set_id
+zak_form_validator_validate
+zak_form_validator_set_message
+zak_form_validator_get_message
+zak_form_validator_get_enabled
+zak_form_validator_set_enabled
+ZakFormValidator
+</SECTION>
+
+<SECTION>
+<FILE>formvalidatorcompare</FILE>
+ZAK_FORM_TYPE_VALIDATOR_COMPARE
+zak_form_validator_compare_new
+ZakFormValidatorCompare
+</SECTION>
+
+<SECTION>
+<FILE>formvalidatorcomparedate</FILE>
+ZAK_FORM_TYPE_VALIDATOR_COMPARE_DATE
+zak_form_validator_compare_date_new
+ZakFormValidatorCompareDate
+</SECTION>
+
+<SECTION>
+<FILE>formvalidatorcomposite</FILE>
+ZAK_FORM_TYPE_VALIDATOR_COMPOSITE
+zak_form_validator_composite_new
+ZakFormValidatorComposite
+</SECTION>
+

diff --git a/docs/reference/libzakform.types b/docs/reference/libzakform.types
new file mode 100644 (file)
index 0000000..3f60585
--- /dev/null
+++ b/docs/reference/libzakform.types
@@ -0,0 +1,14 @@
+zak_form_element_filter_get_type
+zak_form_element_filter_luc_get_type
+zak_form_element_filter_trim_get_type
+zak_form_element_get_type
+zak_form_element_validator_date_get_type
+zak_form_element_validator_get_type
+zak_form_element_validator_notempty_get_type
+zak_form_element_validator_regex_get_type
+zak_form_form_get_type
+zak_form_iprovider_get_type
+zak_form_validator_compare_date_get_type
+zak_form_validator_compare_get_type
+zak_form_validator_composite_get_type
+zak_form_validator_get_type