From: Andrea Zagli Date: Sun, 19 Jul 2009 09:44:17 +0000 (+0200) Subject: Gtkdocized. X-Git-Tag: GTKGIS_0_0_2~3 X-Git-Url: https://saetta.ns0.it/gitweb?a=commitdiff_plain;h=3f8c468ab2eb9095c53c873b86b15dade61d42ab;p=libgtkgis Gtkdocized. --- diff --git a/.gitignore b/.gitignore index d5a5551..df1ab9d 100644 --- a/.gitignore +++ b/.gitignore @@ -33,6 +33,11 @@ tests/.libs tests/from_xml tests/test_comune.gtkgis tests/samples +docs/reference/.libs +docs/reference/html +docs/reference/xml +docs/reference/version.xml +docs/reference/*.stamp # temporarily TODO.tasks diff --git a/Makefile.am b/Makefile.am index 1711135..ca8c7f0 100644 --- a/Makefile.am +++ b/Makefile.am @@ -2,7 +2,7 @@ ACLOCAL_AMFLAGS=-I m4 DISTCHECK_CONFIGURE_FLAGS = --enable-gtk-doc -SUBDIRS = src data tests +SUBDIRS = src data docs tests EXTRA_DIST = autogen.sh libgtkgis.pc.in diff --git a/configure.ac b/configure.ac index 4f9cff1..3706415 100644 --- a/configure.ac +++ b/configure.ac @@ -2,7 +2,7 @@ # Process this file with autoconf to produce a configure script. AC_PREREQ(2.63) -AC_INIT([libgtkgis], [0.0.1], [azagli@libero.it]) +AC_INIT([libgtkgis], [0.0.2], [azagli@libero.it]) AC_CONFIG_SRCDIR([src/gtkgis.c]) AC_CONFIG_HEADER([config.h]) @@ -54,6 +54,9 @@ AC_CONFIG_FILES([ Makefile src/Makefile data/Makefile + docs/Makefile + docs/reference/Makefile + docs/reference/version.xml tests/Makefile ]) AC_OUTPUT 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..899a189 --- /dev/null +++ b/docs/reference/Makefile.am @@ -0,0 +1,94 @@ +## Process this file with automake to produce Makefile.in + +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 + +# 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=libgtkgis + +# Uncomment for versioned docs and specify the version of the module, e.g. '2'. +#DOC_MODULE_VERSION=2 + + +# The top-level SGML file. You can change this if you want to. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting the functions and macros. +# e.g. DOC_SOURCE_DIR=../../../gtk +DOC_SOURCE_DIR=../../src + +# Extra options to pass to gtkdoc-scangobj. Not normally 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=--sgml-mode --output-format=xml +MKDB_OPTIONS=--sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-mktmpl +# e.g. MKTMPL_OPTIONS=--only-section-tmpl +MKTMPL_OPTIONS= + +# Extra options to supply to gtkdoc-mkhtml +MKHTML_OPTIONS= + +# Extra options to supply to gtkdoc-fixref. Not normally 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 + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES= + +# Images to copy into HTML directory. +# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png +HTML_IMAGES= + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +# e.g. content_files=running.sgml building.sgml changes-2.0.sgml +content_files=version.xml + +# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded +# These files must be listed here *and* in content_files +# e.g. expand_content_files=running.sgml +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 $(GTKGIS_CFLAGS) $(GDAL_CFLAGS) +GTKDOC_LIBS=$(top_builddir)/src/libgtkgis.la $(GTKGIS_LIBS) $(GDAL_LIBS) + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += version.xml.in + +# Files not to distribute +# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types +# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt +#DISTCLEANFILES += + +# Comment this out if you want your docs-status tested during 'make check' +#TESTS = $(GTKDOC_CHECK) + diff --git a/docs/reference/libgtkgis-docs.sgml b/docs/reference/libgtkgis-docs.sgml new file mode 100644 index 0000000..c87f261 --- /dev/null +++ b/docs/reference/libgtkgis-docs.sgml @@ -0,0 +1,44 @@ + + +]> + + + LibGtkGis Reference Manual + + for libgtkgis [VERSION] + The latest version of this documentation can be found on-line at + http://[SERVER]/libgtkgis/. + + + + + LibGtkGis + + + + + + + + + + + + + + + + + Object Hierarchy + + + + API Index + + + + + diff --git a/docs/reference/tmpl/commons.sgml b/docs/reference/tmpl/commons.sgml new file mode 100644 index 0000000..613aa2b --- /dev/null +++ b/docs/reference/tmpl/commons.sgml @@ -0,0 +1,31 @@ + +commons + + + + + + + + + + + + + + + + + + + + + + + + +@LAYER_GEOMETRY_TYPE_POINT: +@LAYER_GEOMETRY_TYPE_LINE: +@LAYER_GEOMETRY_TYPE_POLYGON: +@LAYER_GEOMETRY_TYPE_RASTER: + diff --git a/docs/reference/tmpl/geometry.sgml b/docs/reference/tmpl/geometry.sgml new file mode 100644 index 0000000..e7097f6 --- /dev/null +++ b/docs/reference/tmpl/geometry.sgml @@ -0,0 +1,110 @@ + +GtkGisGeometry + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + + + + + + + +@Returns: + + + + + + + +@geometry: +@Returns: + + + + + + + +@geometry: +@editable: + + + + + + + +@geometry: +@scale: +@Returns: + + diff --git a/docs/reference/tmpl/geometryline.sgml b/docs/reference/tmpl/geometryline.sgml new file mode 100644 index 0000000..7fbc79d --- /dev/null +++ b/docs/reference/tmpl/geometryline.sgml @@ -0,0 +1,118 @@ + +GtkGisGeometryLine + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + + + + + + + +@Returns: + + + + + + + +@Returns: + + + + + + + +@points: +@Returns: + + + + + + + +@line: +@point: + + + + + + + +@line: +@x: +@y: + + diff --git a/docs/reference/tmpl/geometrypoint.sgml b/docs/reference/tmpl/geometrypoint.sgml new file mode 100644 index 0000000..d480c60 --- /dev/null +++ b/docs/reference/tmpl/geometrypoint.sgml @@ -0,0 +1,118 @@ + +GtkGisGeometryPoint + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + + + + + + + +@Returns: + + + + + + + +@point: +@Returns: + + + + + + + +@point: +@Returns: + + + + + + + +@point: +@Returns: + + + + + + + +@point: +@Returns: + + diff --git a/docs/reference/tmpl/geometrypolygon.sgml b/docs/reference/tmpl/geometrypolygon.sgml new file mode 100644 index 0000000..b436478 --- /dev/null +++ b/docs/reference/tmpl/geometrypolygon.sgml @@ -0,0 +1,135 @@ + +GtkGisGeometryPolygon + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + + + + + + + +@Returns: + + + + + + + +@Returns: + + + + + + + +@line: +@Returns: + + + + + + + +@points: +@Returns: + + + + + + + +@polygon: +@line: + + + + + + + +@polygon: +@points: + + + + + + + +@polygon: +@line: + + diff --git a/docs/reference/tmpl/geometryraster.sgml b/docs/reference/tmpl/geometryraster.sgml new file mode 100644 index 0000000..3fe0dc2 --- /dev/null +++ b/docs/reference/tmpl/geometryraster.sgml @@ -0,0 +1,93 @@ + +GtkGisGeometryRaster + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + + + + + + + +@Returns: + + + + + + + +@pixbuf: +@x: +@y: +@Returns: + + diff --git a/docs/reference/tmpl/gtkgis.sgml b/docs/reference/tmpl/gtkgis.sgml new file mode 100644 index 0000000..7651d68 --- /dev/null +++ b/docs/reference/tmpl/gtkgis.sgml @@ -0,0 +1,225 @@ + +GtkGis + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + + + + + + + +@Returns: + + + + + + + +@Returns: + + + + + + + +@xdoc: +@Returns: + + + + + + + +@file_name: +@Returns: + + + + + + + +@gtkgis: +@Returns: + + + + + + + +@gtkgis: +@file_name: +@Returns: + + + + + + + +@gtkgis: +@layers_group: + + + + + + + +@gtkgis: +@layers_group: + + + + + + + +@gtkgis: +@layer: + + + + + + + +@gtkgis: +@layer: + + + + + + + +@gtkgis: +@layer_name: +@Returns: + + + + + + + +@gtkgis: + + + + + + + +@gtkgis: +@Returns: + + + + + + + +@gtkgis: +@scale: + + + + + + + +@gtkgis: + + + + + + + +@gtkgis: +@layer: + + + + + + + +@gtkgis: +@Returns: + + diff --git a/docs/reference/tmpl/layer.sgml b/docs/reference/tmpl/layer.sgml new file mode 100644 index 0000000..c1be248 --- /dev/null +++ b/docs/reference/tmpl/layer.sgml @@ -0,0 +1,202 @@ + +GtkGisLayer + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + + + + + + + +@Returns: + + + + + + + +@source: +@name: +@geometry_type: +@Returns: + + + + + + + +@source: +@name: +@Returns: + + + + + + + +@layer: +@Returns: + + + + + + + +@layer: +@Returns: + + + + + + + +@layer: +@Returns: + + + + + + + +@layer: + + + + + + + +@layer: +@source: + + + + + + + +@layer: +@geometry: + + + + + + + +@layer: +@geometry: + + + + + + + +@layer: +@Returns: + + + + + + + +@layer: +@Returns: + + + + + + + +@layer: +@editable: + + + + + + + +@layer: +@root: +@scale: + + diff --git a/docs/reference/tmpl/layersgroup.sgml b/docs/reference/tmpl/layersgroup.sgml new file mode 100644 index 0000000..a50d646 --- /dev/null +++ b/docs/reference/tmpl/layersgroup.sgml @@ -0,0 +1,127 @@ + +GtkGisLayersGroup + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + + + + + + + +@Returns: + + + + + + + +@name: +@Returns: + + + + + + + +@layers_group: +@layer: + + + + + + + +@layers_group: +@layer: + + + + + + + +@layers_group: +@Returns: + + + + + + + +@layers_group: +@name: + + diff --git a/docs/reference/tmpl/layersource.sgml b/docs/reference/tmpl/layersource.sgml new file mode 100644 index 0000000..d63f8cc --- /dev/null +++ b/docs/reference/tmpl/layersource.sgml @@ -0,0 +1,130 @@ + +GtkGisLayerSource + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + + + + + + + +@Returns: + + + + + + + +@source: +@Returns: + + + + + + + +@source: +@name: +@Returns: + + + + + + + +@source: +@name: +@Returns: + + + + + + + +@source: +@name: +@Returns: + + + + + + + +@source: +@extent: + + diff --git a/docs/reference/tmpl/layersourcepostgis.sgml b/docs/reference/tmpl/layersourcepostgis.sgml new file mode 100644 index 0000000..2cf23a5 --- /dev/null +++ b/docs/reference/tmpl/layersourcepostgis.sgml @@ -0,0 +1,103 @@ + +GtkGisLayerSourcePostgis + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + + + + + + + +@Returns: + + + + + + + +@host: +@port: +@username: +@password: +@Returns: + + + + + + + +@xnode: +@Returns: + + diff --git a/docs/reference/tmpl/layersourceraster.sgml b/docs/reference/tmpl/layersourceraster.sgml new file mode 100644 index 0000000..15d8b63 --- /dev/null +++ b/docs/reference/tmpl/layersourceraster.sgml @@ -0,0 +1,109 @@ + +GtkGisLayerSourceRaster + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + + + + + + + +@Returns: + + + + + + + +@filename: +@Returns: + + + + + + + +@xnode: +@Returns: + + + + + + + +@source: +@Returns: + + diff --git a/docs/reference/tmpl/layersourceshp.sgml b/docs/reference/tmpl/layersourceshp.sgml new file mode 100644 index 0000000..a56c32e --- /dev/null +++ b/docs/reference/tmpl/layersourceshp.sgml @@ -0,0 +1,109 @@ + +GtkGisLayerSourceShp + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + + + + + + + +@Returns: + + + + + + + +@filename: +@Returns: + + + + + + + +@xnode: +@Returns: + + + + + + + +@source: +@Returns: + + diff --git a/docs/reference/tmpl/libgtkgis-unused.sgml b/docs/reference/tmpl/libgtkgis-unused.sgml new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference/tmpl/libgtkgis.sgml b/docs/reference/tmpl/libgtkgis.sgml new file mode 100644 index 0000000..d24f66a --- /dev/null +++ b/docs/reference/tmpl/libgtkgis.sgml @@ -0,0 +1,21 @@ + +libgtkgis + + + + + + + + + + + + + + + + + + + diff --git a/docs/reference/version.xml.in b/docs/reference/version.xml.in new file mode 100644 index 0000000..c5d0fd6 --- /dev/null +++ b/docs/reference/version.xml.in @@ -0,0 +1,2 @@ +@PACKAGE_VERSION@ +