From: Andrea Zagli Date: Sun, 11 Jun 2017 08:03:34 +0000 (+0200) Subject: Enabled gtk-doc. X-Git-Url: https://saetta.ns0.it/gitweb?a=commitdiff_plain;h=bd5e6ba7f896afe8133753c05475c2ccdeb66336;p=libzakgtkdecoder Enabled gtk-doc. --- diff --git a/.gitignore b/.gitignore index c9c8039..a2073df 100644 --- a/.gitignore +++ b/.gitignore @@ -53,4 +53,16 @@ Rules-quot *.csv decodermarshal.[ch] *.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 \ No newline at end of file diff --git a/Makefile.am b/Makefile.am index 1de65fe..6fe4e78 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,6 +1,6 @@ DISTCHECK_CONFIGURE_FLAGS = --enable-introspection -SUBDIRS = glade src tests +SUBDIRS = glade 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 1eedaef..d6a85bd 100644 --- a/configure.ac +++ b/configure.ac @@ -36,6 +36,9 @@ AC_PATH_PROG(GLIB_GENMARSHAL, glib-genmarshal) GOBJECT_INTROSPECTION_CHECK([1.30.0]) +# check for gtk-doc +GTK_DOC_CHECK([1.14],[--flavour no-tmpl]) + dnl ****************************** dnl Translations dnl ****************************** @@ -92,6 +95,8 @@ AM_CONDITIONAL(PLATFORM_WIN32, [test $platform_win32 = yes]) AC_CONFIG_FILES([ libzakgtkdecoder.pc Makefile + docs/Makefile + docs/reference/Makefile 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..a9646ad --- /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=libzakgtkdecoder + +# 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/libzakgtkdecoder.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/libzakgtkdecoder-docs.xml b/docs/reference/libzakgtkdecoder-docs.xml new file mode 100644 index 0000000..e7a579c --- /dev/null +++ b/docs/reference/libzakgtkdecoder-docs.xml @@ -0,0 +1,39 @@ + + + + %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/libzakgtkdecoder-sections.txt b/docs/reference/libzakgtkdecoder-sections.txt new file mode 100644 index 0000000..188b47e --- /dev/null +++ b/docs/reference/libzakgtkdecoder-sections.txt @@ -0,0 +1,22 @@ +
+zakgtkdecoder +ZakGtkDecoder +ZAK_GTK_TYPE_DECODER +ZakGtkDecoderClass +zak_gtk_decoder_new +zak_gtk_decoder_set_key +zak_gtk_decoder_get_key +zak_gtk_decoder_get_decoded +zak_gtk_decoder_show_btn_clean +zak_gtk_decoder_show_btn_new +zak_gtk_decoder_show_btn_open +zak_gtk_decoder_show_btn_browse +zak_gtk_decoder_btn_clean_is_visible +zak_gtk_decoder_btn_new_is_visible +zak_gtk_decoder_btn_open_is_visible +zak_gtk_decoder_btn_browse_is_visible +zak_gtk_decoder_set_editable +zak_gtk_decoder_get_editable +ZakGtkDecoder +
+ diff --git a/docs/reference/libzakgtkdecoder.types b/docs/reference/libzakgtkdecoder.types new file mode 100644 index 0000000..a7af98f --- /dev/null +++ b/docs/reference/libzakgtkdecoder.types @@ -0,0 +1 @@ +zak_gtk_decoder_get_type