From e09b3e2fa2c21a9f5d01dae3d91f1b7eb6342b08 Mon Sep 17 00:00:00 2001 From: Andrea Zagli Date: Wed, 7 Jun 2017 16:03:33 +0200 Subject: [PATCH] Enabled gtk-doc. --- .gitignore | 13 +- Makefile.am | 4 +- autogen.sh | 2 +- configure.ac | 4 +- docs/Makefile.am | 1 + docs/reference/Makefile.am | 85 ++++++++++++ docs/reference/libzakform-docs.xml | 53 ++++++++ docs/reference/libzakform-overrides.txt | 0 docs/reference/libzakform-sections.txt | 169 ++++++++++++++++++++++++ docs/reference/libzakform.types | 14 ++ 10 files changed, 341 insertions(+), 4 deletions(-) create mode 100644 docs/Makefile.am create mode 100644 docs/reference/Makefile.am create mode 100644 docs/reference/libzakform-docs.xml create mode 100644 docs/reference/libzakform-overrides.txt create mode 100644 docs/reference/libzakform-sections.txt create mode 100644 docs/reference/libzakform.types diff --git a/.gitignore b/.gitignore index 6fce3bf..a6032c7 100644 --- 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 dc08cdf..6e50ffa 100644 --- 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 83f5de2..c32ddd7 100755 --- 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 1f2bffe..12baf73 100644 --- 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 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 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 index 0000000..31935ae --- /dev/null +++ b/docs/reference/libzakform-docs.xml @@ -0,0 +1,53 @@ + + + + %gtkdocentities; +]> + + + &package_name; Reference Manual + + for &package_string;. + The latest version of this documentation can be found on-line at + http://[SERVER]/&package_name;/. + + + + + [Insert title here] + + + + + + + + + + + + + + + + + + + Object Hierarchy + + + + API Index + + + + Index of deprecated API + + + + diff --git a/docs/reference/libzakform-overrides.txt b/docs/reference/libzakform-overrides.txt new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference/libzakform-sections.txt b/docs/reference/libzakform-sections.txt new file mode 100644 index 0000000..fc84b59 --- /dev/null +++ b/docs/reference/libzakform-sections.txt @@ -0,0 +1,169 @@ +
+commons +ZakFormCompareType +zak_form_get_compare_type_from_string +zak_form_get_compare_type_stringify +zak_form_get_element_by_id +
+ +
+form +ZakFormForm +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 +
+ +
+formelement +ZAK_FORM_TYPE_ELEMENT +ZakFormElement +ZakFormElementClass +
+ +
+formelementfilter +ZakFormElementFilter +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 +
+ +
+formelementfilterluc +ZAK_FORM_TYPE_ELEMENT_FILTER_LUC +zak_form_element_filter_luc_new +ZakFormElementFilterLuc +
+ +
+formelementfiltertrim +ZAK_FORM_TYPE_ELEMENT_FILTER_TRIM +zak_form_element_filter_trim_new +ZakFormElementFilterTrim +
+ +
+formelementvalidator +ZakFormElementValidator +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 +
+ +
+formelementvalidatordate +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 +
+ +
+formelementvalidatornotempty +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 +
+ +
+formelementvalidatorregex +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 +
+ +
+formiprovider +ZakFormIProvider +ZAK_FORM_TYPE_IPROVIDER +ZakFormIProviderInterface +zak_form_iprovider_load +zak_form_iprovider_insert +zak_form_iprovider_update +zak_form_iprovider_delete +ZakFormIProvider +
+ +
+formvalidator +ZakFormValidator +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 +
+ +
+formvalidatorcompare +ZAK_FORM_TYPE_VALIDATOR_COMPARE +zak_form_validator_compare_new +ZakFormValidatorCompare +
+ +
+formvalidatorcomparedate +ZAK_FORM_TYPE_VALIDATOR_COMPARE_DATE +zak_form_validator_compare_date_new +ZakFormValidatorCompareDate +
+ +
+formvalidatorcomposite +ZAK_FORM_TYPE_VALIDATOR_COMPOSITE +zak_form_validator_composite_new +ZakFormValidatorComposite +
+ diff --git a/docs/reference/libzakform.types b/docs/reference/libzakform.types new file mode 100644 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 -- 2.49.0