From: Pierre-Luc Beaudoin <pierre-luc@pierlux.com>
Date: Fri, 12 Jun 2009 02:08:14 +0000 (-0400)
Subject: Fix ChamplainPoint gtk documentation
X-Git-Url: https://err.no/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d47fe504b420e333dc1e2316685938a69b5362f3;p=libchamplain

Fix ChamplainPoint gtk documentation
---

diff --git a/.gitignore b/.gitignore
index bcfa161..5b70746 100644
--- a/.gitignore
+++ b/.gitignore
@@ -35,7 +35,13 @@ demos/launcher-gtk
 depcomp
 compile
 docs/reference-gtk/version.xml
+docs/reference-gtk/html/*.*
+docs/reference-gtk/tmpl/*.*
+docs/reference-gtk/xml/*.*
 docs/reference/version.xml
+docs/reference/html/*.*
+docs/reference/tmpl/*.*
+docs/reference/xml/*.*
 gtk-doc.make
 install-sh
 libtool
diff --git a/champlain/champlain-point.c b/champlain/champlain-point.c
index 4997890..4f314f0 100644
--- a/champlain/champlain-point.c
+++ b/champlain/champlain-point.c
@@ -19,6 +19,11 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
+/**
+ * SECTION:champlain-point
+ * @short_description: A base struct to store a latitude and longitude
+ */
+
 #include "champlain-point.h"
 
 GType
@@ -74,9 +79,10 @@ champlain_point_free (ChamplainPoint *point)
 
 /**
  * champlain_point_new:
- * @point: a #ChamplainPoint
+ * @lat: the latitude
+ * @lon: the longitude
  *
- * Frees a point structure created with champlain_point_copy().
+ * Return value: a newly allocated #ChamplainPoint to be freed with #champlain_point_free
  *
  * Since: 0.4
  */
diff --git a/champlain/champlain-point.h b/champlain/champlain-point.h
index 3356f92..7cae947 100644
--- a/champlain/champlain-point.h
+++ b/champlain/champlain-point.h
@@ -25,14 +25,17 @@
 
 #include <glib-object.h>
 
-typedef struct
+typedef struct _ChamplainPoint ChamplainPoint;
+
+struct _ChamplainPoint
 {
   double lat;
   double lon;
-} ChamplainPoint;
+};
 
 GType champlain_point_get_type (void) G_GNUC_CONST;
 #define CHAMPLAIN_TYPE_POINT (champlain_point_get_type ())
+#define CHAMPLAIN_POINT(x) ((ChamplainPoint *) (x))
 
 ChamplainPoint * champlain_point_copy (const ChamplainPoint *point);
 
diff --git a/docs/reference/libchamplain-docs.sgml b/docs/reference/libchamplain-docs.sgml
index ab545a3..a0ed186 100644
--- a/docs/reference/libchamplain-docs.sgml
+++ b/docs/reference/libchamplain-docs.sgml
@@ -45,6 +45,7 @@
     <xi:include href="xml/champlain-base-marker.xml"/>
     <xi:include href="xml/champlain-marker.xml"/>
     <xi:include href="xml/champlain-polygon.xml"/>
+    <xi:include href="xml/champlain-point.xml"/>
   </chapter>
   <chapter>
     <title>II. Map Source API Reference</title>
diff --git a/docs/reference/libchamplain-sections.txt b/docs/reference/libchamplain-sections.txt
index 240611c..85507a7 100644
--- a/docs/reference/libchamplain-sections.txt
+++ b/docs/reference/libchamplain-sections.txt
@@ -321,6 +321,19 @@ CHAMPLAIN_PARAM_READWRITE
 ChamplainState
 </SECTION>
 
+<SECTION>
+<FILE>champlain-point</FILE>
+<TITLE>ChamplainPoint</TITLE>
+ChamplainPoint
+champlain_point_new
+champlain_point_copy
+champlain_point_free
+<SUBSECTION Standard>
+CHAMPLAIN_POINT
+CHAMPLAIN_TYPE_POINT
+champlain_point_get_type
+</SECTION>
+
 <SECTION>
 <FILE>champlain-cache</FILE>
 <TITLE>ChamplainCache</TITLE>
diff --git a/docs/reference/libchamplain.types b/docs/reference/libchamplain.types
index d89f791..b2c5267 100644
--- a/docs/reference/libchamplain.types
+++ b/docs/reference/libchamplain.types
@@ -10,3 +10,4 @@ champlain_tile_get_type
 champlain_cache_get_type
 champlain_map_source_factory_get_type
 champlain_polygon_get_type
+champlain_point_get_type