GNOME.org
 

[libchamplain] Update champlain-gtk docs

commit 57270fe4f30c85fd68b9ba018c489765de1e82c5
Author: JiÅ?í Techet <techet gmail com>
Date:   Mon May 10 01:46:02 2010 +0200

    Update champlain-gtk docs
    
    Signed-off-by: JiÅ?í Techet <techet gmail com>

 champlain-gtk/gtk-champlain-embed.c              |    4 ++
 champlain-gtk/gtk-champlain-embed.h              |    7 +----
 docs/reference-gtk/Makefile.am                   |   36 ++++++++++++++++------
 docs/reference-gtk/libchamplain-gtk-docs.sgml    |   10 ++++--
 docs/reference-gtk/libchamplain-gtk-sections.txt |    3 +-
 docs/reference/Makefile.am                       |    2 +-
 6 files changed, 39 insertions(+), 23 deletions(-)
---
diff --git a/champlain-gtk/gtk-champlain-embed.c b/champlain-gtk/gtk-champlain-embed.c
index 285cd70..06b50e6 100644
--- a/champlain-gtk/gtk-champlain-embed.c
+++ b/champlain-gtk/gtk-champlain-embed.c
@@ -302,6 +302,8 @@ mouse_button_cb (GtkWidget *widget,
 /**
  * gtk_champlain_embed_new:
  *
+ * Creates an instance of #GtkChamplainEmbed.
+ *
  * Return value: a new #GtkChamplainEmbed ready to be used as a #GtkWidget.
  *
  * Since: 0.4
@@ -316,6 +318,8 @@ gtk_champlain_embed_new ()
  * gtk_champlain_embed_get_view:
  * @embed: a #ChamplainView, the map view to embed
  *
+ * Gets a #ChamplainView from the #GtkChamplainEmbed object.
+ *
  * Return value: a #ChamplainView ready to be used
  *
  * Since: 0.4
diff --git a/champlain-gtk/gtk-champlain-embed.h b/champlain-gtk/gtk-champlain-embed.h
index 216d85f..d534328 100644
--- a/champlain-gtk/gtk-champlain-embed.h
+++ b/champlain-gtk/gtk-champlain-embed.h
@@ -15,7 +15,7 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  */
- 
+
 #if !defined (__CHAMPLAIN_GTK_CHAMPLAIN_GTK_H_INSIDE__) && !defined (CHAMPLAIN_GTK_COMPILATION)
 #error "Only <champlain/champlain.h> can be included directly."
 #endif
@@ -57,9 +57,4 @@ GType gtk_champlain_embed_get_type (void);
 GtkWidget *gtk_champlain_embed_new (void);
 ChamplainView *gtk_champlain_embed_get_view (GtkChamplainEmbed* embed);
 
-/* DEPRECATED API */
-GtkWidget *champlain_view_embed_new (ChamplainView *view) G_GNUC_DEPRECATED;
-ChamplainView *champlain_view_embed_get_view (GtkChamplainEmbed* embed) G_GNUC_DEPRECATED;
-void champlain_view_embed_set_view (GtkChamplainEmbed *embed, ChamplainView *view) G_GNUC_DEPRECATED;
-
 #endif
diff --git a/docs/reference-gtk/Makefile.am b/docs/reference-gtk/Makefile.am
index cdc28f5..18d001b 100644
--- a/docs/reference-gtk/Makefile.am
+++ b/docs/reference-gtk/Makefile.am
@@ -1,10 +1,15 @@
 ## Process this file with automake to produce Makefile.in
 
+# We require automake 1.6 at least.
 AUTOMAKE_OPTIONS = 1.6
 
 # The name of the module, e.g. 'glib'.
 DOC_MODULE=libchamplain-gtk
 
+# 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
 
@@ -15,11 +20,11 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
 DOC_SOURCE_DIR=../../champlain-gtk
 
 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
-SCANGOBJ_OPTIONS=
+SCANGOBJ_OPTIONS=--type-init-func 'g_type_init(); g_thread_init(NULL)'
 
 # Extra options to supply to gtkdoc-scan.
 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
-SCAN_OPTIONS=--deprecated-guards="CHAMPLAIN_OBSOLETE_API"
+SCAN_OPTIONS=--rebuild-types
 
 # Extra options to supply to gtkdoc-mkdb.
 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
@@ -29,6 +34,9 @@ MKDB_OPTIONS=--sgml-mode --output-format=xml
 # 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= \
@@ -39,12 +47,16 @@ 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)/champlain-gtk/*.h
-CFILE_GLOB=$(top_srcdir)/champlain-gtk/*.c
+HFILE_GLOB=
+CFILE_GLOB=
+
+# 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 to ignore when scanning.
+# Header files to ignore when scanning. Use base file name, no paths
 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES=
+IGNORE_HFILES= champlain-gtk-marshal.h
 
 # Images to copy into HTML directory.
 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
@@ -52,7 +64,7 @@ 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
+content_files=version.xml
 
 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
 # These files must be listed here *and* in content_files
@@ -62,10 +74,10 @@ 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. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
-INCLUDES=-I$(top_srcdir)/champlain -I$(top_srcdir) -I$(top_builddir) $(DEPS_CFLAGS)
-GTKDOC_LIBS=$(DEPS_LIBS) $(top_builddir)/champlain/libchamplain-0.5.la $(top_builddir)/champlain-gtk/libchamplain-gtk-0.5.la
+GTKDOC_CFLAGS=$(DEPS_CFLAGS) -I$(top_srcdir) -I$(top_builddir)
+GTKDOC_LIBS=$(DEPS_LIBS) $(top_builddir)/champlain-gtk/libchamplain-gtk-0.5.la
 
 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 include $(top_srcdir)/gtk-doc.make
@@ -80,5 +92,9 @@ EXTRA_DIST +=
 #DISTCLEANFILES +=
 
 # Comment this out if you want your docs-status tested during 'make check'
+if ENABLE_GTK_DOC
+#TESTS_ENVIRONMENT = cd $(srcsrc) &&
 #TESTS = $(GTKDOC_CHECK)
+endif
 
+-include $(top_srcdir)/git.mk
diff --git a/docs/reference-gtk/libchamplain-gtk-docs.sgml b/docs/reference-gtk/libchamplain-gtk-docs.sgml
index 8d36313..cdf2c45 100644
--- a/docs/reference-gtk/libchamplain-gtk-docs.sgml
+++ b/docs/reference-gtk/libchamplain-gtk-docs.sgml
@@ -8,11 +8,13 @@
     <title>libchamplain-gtk Reference Manual</title>
     <releaseinfo>
       for libchamplain-gtk &version;
+      <para>
       The latest version of this documentation can be found on-line at
       <ulink role="online-location" url="http://projects.gnome.org/libchamplain/";>http://projects.gnome.org/libchamplain/</ulink>.
+      </para>
     </releaseinfo>
     <copyright>
-      <year>2008, 2009</year>
+      <year>2008-2010</year>
       <holder>libchamplain contributors</holder>
     </copyright>
     <legalnotice>
@@ -38,8 +40,8 @@
     </legalnotice>
   </bookinfo>
 
-  <chapter>
-    <title>I. API Reference</title>
+  <part>
+    <title>API Reference</title>
     <xi:include href="xml/gtk-champlain-embed.xml"/>
-  </chapter>
+  </part>
 </book>
diff --git a/docs/reference-gtk/libchamplain-gtk-sections.txt b/docs/reference-gtk/libchamplain-gtk-sections.txt
index d602566..b5a9d51 100644
--- a/docs/reference-gtk/libchamplain-gtk-sections.txt
+++ b/docs/reference-gtk/libchamplain-gtk-sections.txt
@@ -5,15 +5,14 @@ GtkChamplainEmbed
 gtk_champlain_embed_new
 gtk_champlain_embed_get_view
 <SUBSECTION Standard>
+GTK_TYPE_CHAMPLAIN_EMBED
 GTK_CHAMPLAIN_EMBED
 GTK_CHAMPLAIN_IS_EMBED
-CHAMPLAIN_TYPE_EMBED
 gtk_champlain_embed_get_type
 GTK_CHAMPLAIN_EMBED_CLASS
 GTK_CHAMPLAIN_IS_EMBED_CLASS
 GTK_CHAMPLAIN_EMBED_GET_CLASS
 <SUBSECTION Private>
-GTK_TYPE_CHAMPLAIN_EMBED
 GtkChamplainEmbedClass
 GtkChamplainEmbedPrivate
 </SECTION>
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index e003604..a88c2ea 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -76,7 +76,7 @@ expand_content_files=
 # 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.
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
 GTKDOC_CFLAGS=$(DEPS_CFLAGS) -I$(top_srcdir) -I$(top_builddir)
 GTKDOC_LIBS=$(DEPS_LIBS) $(top_builddir)/champlain/libchamplain-0.5.la
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]