From: Andrea Zagli Date: Sat, 10 Jun 2017 08:26:01 +0000 (+0200) Subject: Enabled gtk-doc generation. X-Git-Url: https://saetta.ns0.it/gitweb?a=commitdiff_plain;h=0c1fdb08fc24adc9427360049b11a444dc3cfbf1;p=libgdaexgrid Enabled gtk-doc generation. --- diff --git a/.gitignore b/.gitignore index 7c9e482..6a2c9e6 100644 --- a/.gitignore +++ b/.gitignore @@ -52,3 +52,4 @@ Rules-quot *.csv tests/grid tests/grid_tree +test-driver \ No newline at end of file diff --git a/Makefile.am b/Makefile.am index a7f5ad7..1dbf6f9 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,4 +1,4 @@ -SUBDIRS = po src tests +SUBDIRS = po src tests docs ACLOCAL_AMFLAGS = -I m4 diff --git a/autogen.sh b/autogen.sh index 2bfbe7f..76d5d65 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 914d792..4fa4584 100644 --- a/configure.ac +++ b/configure.ac @@ -29,7 +29,9 @@ AC_PROG_MAKE_SET AC_PROG_LIBTOOL AC_PROG_RANLIB -GTK_DOC_CHECK(1.0) +# check for gtk-doc +GTK_DOC_CHECK([1.14],[--flavour no-tmpl]) + IT_PROG_INTLTOOL dnl ****************************** @@ -97,6 +99,8 @@ AM_CONDITIONAL(PLATFORM_WIN32, [test $platform_win32 = yes]) AC_CONFIG_FILES([ libgdaexgrid.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..4d4430a --- /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=libgdaexgrid + +# 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= +GTKDOC_LIBS= + +# 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/libgdaexgrid-decl-list.txt b/docs/reference/libgdaexgrid-decl-list.txt new file mode 100644 index 0000000..436231c --- /dev/null +++ b/docs/reference/libgdaexgrid-decl-list.txt @@ -0,0 +1,26 @@ +
+grid + +GDAEX_GRID +GDAEX_GRID_CLASS +GDAEX_GRID_GET_CLASS +GDAEX_IS_GRID +GDAEX_IS_GRID_CLASS +GDAEX_TYPE_GRID +GdaExGrid +GdaExGridClass +
+ +
+gridcolumn + +GDAEX_GRID_COLUMN +GDAEX_GRID_COLUMN_CLASS +GDAEX_GRID_COLUMN_GET_CLASS +GDAEX_IS_GRID_COLUMN +GDAEX_IS_GRID_COLUMN_CLASS +GDAEX_TYPE_GRID_COLUMN +GdaExGridColumn +GdaExGridColumnClass +
+ diff --git a/docs/reference/libgdaexgrid-decl.txt b/docs/reference/libgdaexgrid-decl.txt new file mode 100644 index 0000000..2ef9389 --- /dev/null +++ b/docs/reference/libgdaexgrid-decl.txt @@ -0,0 +1,60 @@ + +GDAEX_TYPE_GRID_COLUMN +#define GDAEX_TYPE_GRID_COLUMN (gdaex_grid_column_get_type ()) + + +GDAEX_GRID_COLUMN +#define GDAEX_GRID_COLUMN(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDAEX_TYPE_GRID_COLUMN, GdaExGridColumn)) + + +GDAEX_GRID_COLUMN_CLASS +#define GDAEX_GRID_COLUMN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GDAEX_TYPE_GRID_COLUMN, GdaExGridColumnClass)) + + +GDAEX_IS_GRID_COLUMN +#define GDAEX_IS_GRID_COLUMN(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDAEX_TYPE_GRID_COLUMN)) + + +GDAEX_IS_GRID_COLUMN_CLASS +#define GDAEX_IS_GRID_COLUMN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GDAEX_TYPE_GRID_COLUMN)) + + +GDAEX_GRID_COLUMN_GET_CLASS +#define GDAEX_GRID_COLUMN_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GDAEX_TYPE_GRID_COLUMN, GdaExGridColumnClass)) + + +GdaExGridColumn + + +GdaExGridColumnClass + + +GDAEX_TYPE_GRID +#define GDAEX_TYPE_GRID (gdaex_grid_get_type ()) + + +GDAEX_GRID +#define GDAEX_GRID(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDAEX_TYPE_GRID, GdaExGrid)) + + +GDAEX_GRID_CLASS +#define GDAEX_GRID_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GDAEX_TYPE_GRID, GdaExGridClass)) + + +GDAEX_IS_GRID +#define GDAEX_IS_GRID(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDAEX_TYPE_GRID)) + + +GDAEX_IS_GRID_CLASS +#define GDAEX_IS_GRID_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GDAEX_TYPE_GRID)) + + +GDAEX_GRID_GET_CLASS +#define GDAEX_GRID_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GDAEX_TYPE_GRID, GdaExGridClass)) + + +GdaExGrid + + +GdaExGridClass + diff --git a/docs/reference/libgdaexgrid-docs.xml b/docs/reference/libgdaexgrid-docs.xml new file mode 100644 index 0000000..a77c78f --- /dev/null +++ b/docs/reference/libgdaexgrid-docs.xml @@ -0,0 +1,40 @@ + + + + %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/libgdaexgrid-overrides.txt b/docs/reference/libgdaexgrid-overrides.txt new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference/libgdaexgrid-sections.txt b/docs/reference/libgdaexgrid-sections.txt new file mode 100644 index 0000000..436231c --- /dev/null +++ b/docs/reference/libgdaexgrid-sections.txt @@ -0,0 +1,26 @@ +
+grid + +GDAEX_GRID +GDAEX_GRID_CLASS +GDAEX_GRID_GET_CLASS +GDAEX_IS_GRID +GDAEX_IS_GRID_CLASS +GDAEX_TYPE_GRID +GdaExGrid +GdaExGridClass +
+ +
+gridcolumn + +GDAEX_GRID_COLUMN +GDAEX_GRID_COLUMN_CLASS +GDAEX_GRID_COLUMN_GET_CLASS +GDAEX_IS_GRID_COLUMN +GDAEX_IS_GRID_COLUMN_CLASS +GDAEX_TYPE_GRID_COLUMN +GdaExGridColumn +GdaExGridColumnClass +
+ diff --git a/docs/reference/libgdaexgrid-undeclared.txt b/docs/reference/libgdaexgrid-undeclared.txt new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference/libgdaexgrid-undocumented.txt b/docs/reference/libgdaexgrid-undocumented.txt new file mode 100644 index 0000000..96662e5 --- /dev/null +++ b/docs/reference/libgdaexgrid-undocumented.txt @@ -0,0 +1,29 @@ +0% symbol docs coverage. +0 symbols documented. +0 symbols incomplete. +22 not documented. + + +gdaex_grid_column_get_column +gdaex_grid_column_get_decimals +gdaex_grid_column_get_field_name +gdaex_grid_column_get_reorderable +gdaex_grid_column_get_resizable +gdaex_grid_column_get_sortable +gdaex_grid_column_get_title +gdaex_grid_column_get_type +gdaex_grid_column_get_visible +gdaex_grid_column_new +gdaex_grid_column_set_decimals +gdaex_grid_column_set_field_name +gdaex_grid_column_set_gtype +gdaex_grid_column_set_reorderable +gdaex_grid_column_set_resizable +gdaex_grid_column_set_sortable +gdaex_grid_column_set_visible +gdaex_grid_columns_set_title + +grid:Long_Description +grid:Short_Description +gridcolumn:Long_Description +gridcolumn:Short_Description diff --git a/docs/reference/libgdaexgrid-unused.txt b/docs/reference/libgdaexgrid-unused.txt new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference/libgdaexgrid.args b/docs/reference/libgdaexgrid.args new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference/libgdaexgrid.hierarchy b/docs/reference/libgdaexgrid.hierarchy new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference/libgdaexgrid.interfaces b/docs/reference/libgdaexgrid.interfaces new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference/libgdaexgrid.prerequisites b/docs/reference/libgdaexgrid.prerequisites new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference/libgdaexgrid.signals b/docs/reference/libgdaexgrid.signals new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference/libgdaexgrid.types b/docs/reference/libgdaexgrid.types new file mode 100644 index 0000000..e69de29