[libchamplain] Fix ChamplainPolygon documentation
- From: Pierre-Luc Beaudoin <plbeaudoin src gnome org>
- To: svn-commits-list gnome org
- Subject: [libchamplain] Fix ChamplainPolygon documentation
- Date: Fri, 12 Jun 2009 00:58:28 -0400 (EDT)
commit db0e34146774b928cfd8559eb15575d9274dfaee
Author: Pierre-Luc Beaudoin <pierre-luc pierlux com>
Date: Wed Jun 10 00:14:25 2009 -0400
Fix ChamplainPolygon documentation
champlain/champlain-polygon.c | 10 ++-----
champlain/champlain-view.c | 2 +-
docs/reference/libchamplain-docs.sgml | 1 +
docs/reference/libchamplain-sections.txt | 36 ++++++++++++++++++++++++++++-
docs/reference/libchamplain.types | 1 +
5 files changed, 40 insertions(+), 10 deletions(-)
---
diff --git a/champlain/champlain-polygon.c b/champlain/champlain-polygon.c
index f2281ca..820ddff 100644
--- a/champlain/champlain-polygon.c
+++ b/champlain/champlain-polygon.c
@@ -18,13 +18,9 @@
/**
* SECTION:champlain-polygon
- * @short_description: A container for #ChamplainPolygon
+ * @short_description: A polygon to be drawn on the map
*
- * A ChamplainPolygon is little more than a #ClutterContainer. It keeps the
- * polygons ordered so that they display correctly.
- *
- * Use #clutter_container_add to add polygons to the polygon and
- * #clutter_container_remove to remove them.
+ * A ChamplainPolygon is a set of point forming a shape on the map. This API is based on Cairo's.
*/
#include "config.h"
@@ -292,7 +288,7 @@ champlain_polygon_init (ChamplainPolygon *self)
/**
* champlain_polygon_new:
*
- * Returns a new #ChamplainPolygon ready to be to draw polygons on the map
+ * Returns a new empty #ChamplainPolygon
*
* Since: 0.4
*/
diff --git a/champlain/champlain-view.c b/champlain/champlain-view.c
index cd8c283..5ca635e 100644
--- a/champlain/champlain-view.c
+++ b/champlain/champlain-view.c
@@ -2359,7 +2359,7 @@ champlain_view_add_polygon (ChamplainView *view,
* @view: a #ChamplainView
* @polygon: a #ChamplainPolygon
*
- * Removes a #ChamplainPolygon to the #ChamplainView
+ * Removes a #ChamplainPolygon from #ChamplainView
*
* Since: 0.4
*/
diff --git a/docs/reference/libchamplain-docs.sgml b/docs/reference/libchamplain-docs.sgml
index 0d89f0f..ab545a3 100644
--- a/docs/reference/libchamplain-docs.sgml
+++ b/docs/reference/libchamplain-docs.sgml
@@ -44,6 +44,7 @@
<xi:include href="xml/champlain-layer.xml"/>
<xi:include href="xml/champlain-base-marker.xml"/>
<xi:include href="xml/champlain-marker.xml"/>
+ <xi:include href="xml/champlain-polygon.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 ae62f1f..240611c 100644
--- a/docs/reference/libchamplain-sections.txt
+++ b/docs/reference/libchamplain-sections.txt
@@ -154,6 +154,8 @@ champlain_view_get_scroll_mode
champlain_view_get_show_license
champlain_view_get_zoom_level
champlain_view_get_zoom_on_double_click
+champlain_view_add_polygon
+champlain_view_remove_polygon
<SUBSECTION Standard>
CHAMPLAIN_VIEW
CHAMPLAIN_IS_VIEW
@@ -325,7 +327,7 @@ ChamplainState
ChamplainCache
ChamplainCacheClass
champlain_cache_fill_tile
-champlain_cache_get_default
+champlain_cache_dup_default
champlain_cache_get_size_limit
champlain_cache_purge
champlain_cache_purge_on_idle
@@ -348,7 +350,7 @@ CHAMPLAIN_CACHE_GET_CLASS
ChamplainMapSourceFactory
ChamplainMapSourceDesc
ChamplainMapSourceConstructor
-champlain_map_source_factory_get_default
+champlain_map_source_factory_dup_default
champlain_map_source_factory_get_list
champlain_map_source_factory_create
champlain_map_source_factory_register
@@ -362,3 +364,33 @@ CHAMPLAIN_IS_MAP_SOURCE_FACTORY_CLASS
CHAMPLAIN_MAP_SOURCE_FACTORY_GET_CLASS
</SECTION>
+<SECTION>
+<FILE>champlain-polygon</FILE>
+<TITLE>ChamplainPolygon</TITLE>
+ChamplainPolygon
+champlain_polygon_new
+champlain_polygon_append_point
+champlain_polygon_clear_points
+champlain_polygon_get_fill
+champlain_polygon_get_fill_color
+champlain_polygon_get_points
+champlain_polygon_get_stroke
+champlain_polygon_get_stroke_color
+champlain_polygon_get_stroke_width
+champlain_polygon_hide
+champlain_polygon_insert_point
+champlain_polygon_set_fill
+champlain_polygon_set_fill_color
+champlain_polygon_set_stroke
+champlain_polygon_set_stroke_color
+champlain_polygon_set_stroke_width
+champlain_polygon_show
+<SUBSECTION Standard>
+CHAMPLAIN_POLYGON_FACTORY
+CHAMPLAIN_IS_POLYGON
+CHAMPLAIN_TYPE_POLYGON
+champlain_polygon_get_type
+CHAMPLAIN_POLYGON_CLASS
+CHAMPLAIN_IS_POLYGON_CLASS
+CHAMPLAIN_POLYGON_GET_CLASS
+</SECTION>
diff --git a/docs/reference/libchamplain.types b/docs/reference/libchamplain.types
index e460bc8..d89f791 100644
--- a/docs/reference/libchamplain.types
+++ b/docs/reference/libchamplain.types
@@ -9,3 +9,4 @@ champlain_network_map_source_get_type
champlain_tile_get_type
champlain_cache_get_type
champlain_map_source_factory_get_type
+champlain_polygon_get_type
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]