[libchamplain] cleanup ChamplainMarker and ChamplainBaseMarker



commit ace1565efc700b5ea6ec5e18e1b2b4b9d0ff54eb
Author: Simon Wenner <simon wenner ch>
Date:   Thu Aug 20 15:43:00 2009 +0200

    cleanup ChamplainMarker and ChamplainBaseMarker

 champlain/champlain-base-marker.c        |   18 ++++++------
 champlain/champlain-marker.c             |    8 +++---
 docs/reference/libchamplain-sections.txt |   42 +++++++++++++++++++----------
 3 files changed, 40 insertions(+), 28 deletions(-)
---
diff --git a/champlain/champlain-base-marker.c b/champlain/champlain-base-marker.c
index 585cc68..50aa54d 100644
--- a/champlain/champlain-base-marker.c
+++ b/champlain/champlain-base-marker.c
@@ -20,17 +20,17 @@
  * SECTION:champlain-base-marker
  * @short_description: A base marker to identify points of interest on a map
  *
- * Base markers reprensent points of interest on a map. base markers need to be
- * placed on a layer (a #ChamplainLayer).  layers have to be added to a
+ * Base markers reprensent points of interest on a map. Base markers need to be
+ * placed on a layer (a #ChamplainLayer). Layers have to be added to a
  * #champlainview for the base_markers to show on the map.
  *
- * a basemarker is nothing more than a regular #clutteractor.  you can draw on
- * it what ever you want.  don't forget to set the anchor position in the base
- * marker using #clutter_actor_set_anchor_point. set the base_markers position
+ * A basemarker is nothing more than a regular #clutteractor. You can draw on
+ * it what ever you want. Don't forget to set the anchor position in the base
+ * marker using #clutter_actor_set_anchor_point. Set the base_markers position
  * on the map using #champlain_base_marker_set_position.
  *
  * champlain has a more evoluted type of markers with text and image support.
- * see #champlainmarker.
+ * See #champlainmarker.
  */
 
 #include "config.h"
@@ -217,7 +217,7 @@ champlain_base_marker_new (void)
 
 /**
  * champlain_base_marker_set_position:
- * @base_marker: a #ChamplainBaseMarker
+ * @marker: a #ChamplainBaseMarker
  * @longitude: the longitude to center the map at
  * @latitude: the longitude to center the map at
  *
@@ -243,7 +243,7 @@ champlain_base_marker_set_position (ChamplainBaseMarker *champlainBaseMarker,
 
 /**
  * champlain_base_marker_set_highlighted:
- * @base_marker: a #ChamplainBaseMarker
+ * @marker: a #ChamplainBaseMarker
  * @value: the highlighted state
  *
  * Sets the marker as highlighted or not. This will affect the "Selected" look
@@ -266,7 +266,7 @@ champlain_base_marker_set_highlighted (ChamplainBaseMarker *champlainBaseMarker,
 
 /**
  * champlain_base_marker_get_highlighted:
- * @base_marker: a #ChamplainBaseMarker
+ * @marker: a #ChamplainBaseMarker
  *
  * Returns the highlighted or not state of the marker.
  *
diff --git a/champlain/champlain-marker.c b/champlain/champlain-marker.c
index bc6c518..ec0a228 100644
--- a/champlain/champlain-marker.c
+++ b/champlain/champlain-marker.c
@@ -888,7 +888,7 @@ champlain_marker_set_image (ChamplainMarker *marker,
 /**
  * champlain_marker_set_use_markup:
  * @marker: The marker
- * @markup: The value
+ * @use_markup: The value
  *
  * Sets if the marker's text uses markup.
  *
@@ -1041,7 +1041,7 @@ champlain_marker_set_wrap (ChamplainMarker *marker,
 /**
  * champlain_marker_set_wrap_mode:
  * @marker: The marker
- * @wrap: The marker's wrap.
+ * @wrap_mode: The marker's wrap.
  *
  * Set the marker's text color.
  *
@@ -1063,7 +1063,7 @@ champlain_marker_set_wrap_mode (ChamplainMarker *marker,
 /**
  * champlain_marker_set_attributes:
  * @marker: The marker
- * @attributes: The marker's text attributes.
+ * @list: The marker's text attributes.
  *
  * Set the marker's text attribute.
  *
@@ -1092,7 +1092,7 @@ champlain_marker_set_attributes (ChamplainMarker *marker,
 /**
  * champlain_marker_set_ellipsize:
  * @marker: The marker
- * @ellipsize: The marker's ellipsize mode.
+ * @mode: The marker's ellipsize mode.
  *
  * Set the marker's text ellipsize mode.
  *
diff --git a/docs/reference/libchamplain-sections.txt b/docs/reference/libchamplain-sections.txt
index b2321c5..8b1aeba 100644
--- a/docs/reference/libchamplain-sections.txt
+++ b/docs/reference/libchamplain-sections.txt
@@ -31,6 +31,9 @@ champlain_map_source_get_type
 CHAMPLAIN_MAP_SOURCE_CLASS
 CHAMPLAIN_IS_MAP_SOURCE_CLASS
 CHAMPLAIN_MAP_SOURCE_GET_CLASS
+<SUBSECTION Private>
+ChamplainMapSourceClass
+ChamplainMapSourcePrivate
 </SECTION>
 
 <SECTION>
@@ -44,30 +47,30 @@ champlain_marker_new_with_image
 champlain_marker_new_full
 champlain_marker_new_from_file
 champlain_marker_set_text
+champlain_marker_get_text
 champlain_marker_set_image
+champlain_marker_get_image
 champlain_marker_set_use_markup
+champlain_marker_get_use_markup
 champlain_marker_set_alignment
+champlain_marker_get_alignment
 champlain_marker_set_color
+champlain_marker_get_color
 champlain_marker_set_text_color
+champlain_marker_get_text_color
 champlain_marker_set_font_name
+champlain_marker_get_font_name
 champlain_marker_set_wrap
+champlain_marker_get_wrap
 champlain_marker_set_wrap_mode
+champlain_marker_get_wrap_mode
 champlain_marker_set_attributes
 champlain_marker_set_single_line_mode
+champlain_marker_get_single_line_mode
 champlain_marker_set_ellipsize
-champlain_marker_get_use_markup
-champlain_marker_get_text
-champlain_marker_get_image
-champlain_marker_get_alignment
-champlain_marker_get_color
-champlain_marker_get_text_color
-champlain_marker_get_font_name
-champlain_marker_get_wrap
-champlain_marker_get_wrap_mode
 champlain_marker_get_ellipsize
-champlain_marker_get_single_line_mode
-champlain_marker_get_draw_background
 champlain_marker_set_draw_background
+champlain_marker_get_draw_background
 <SUBSECTION Standard>
 CHAMPLAIN_MARKER
 CHAMPLAIN_IS_MARKER
@@ -76,6 +79,9 @@ champlain_marker_get_type
 CHAMPLAIN_MARKER_CLASS
 CHAMPLAIN_IS_MARKER_CLASS
 CHAMPLAIN_MARKER_GET_CLASS
+<SUBSECTION Private>
+ChamplainMarkerClass
+ChamplainMarkerPrivate
 </SECTION>
 
 <SECTION>
@@ -88,8 +94,8 @@ champlain_base_marker_animate_in
 champlain_base_marker_animate_in_with_delay
 champlain_base_marker_animate_out
 champlain_base_marker_animate_out_with_delay
-champlain_base_marker_get_highlighted
 champlain_base_marker_set_highlighted
+champlain_base_marker_get_highlighted
 <SUBSECTION Standard>
 CHAMPLAIN_BASE_MARKER
 CHAMPLAIN_IS_BASE_MARKER
@@ -98,6 +104,9 @@ champlain_base_marker_get_type
 CHAMPLAIN_BASE_MARKER_CLASS
 CHAMPLAIN_IS_BASE_MARKER_CLASS
 CHAMPLAIN_BASE_MARKER_GET_CLASS
+<SUBSECTION Private>
+ChamplainBaseMarkerClass
+ChamplainBaseMarkerPrivate
 </SECTION>
 
 <SECTION>
@@ -105,13 +114,13 @@ CHAMPLAIN_BASE_MARKER_GET_CLASS
 <TITLE>ChamplainZoomLevel</TITLE>
 ChamplainZoomLevel
 champlain_zoom_level_new
+champlain_zoom_level_set_width
 champlain_zoom_level_get_width
+champlain_zoom_level_set_height
 champlain_zoom_level_get_height
+champlain_zoom_level_set_zoom_level
 champlain_zoom_level_get_zoom_level
 champlain_zoom_level_get_actor
-champlain_zoom_level_set_width
-champlain_zoom_level_set_height
-champlain_zoom_level_set_zoom_level
 champlain_zoom_level_add_tile
 champlain_zoom_level_remove_tile
 champlain_zoom_level_tile_count
@@ -124,6 +133,9 @@ champlain_zoom_level_get_type
 CHAMPLAIN_ZOOM_LEVEL_CLASS
 CHAMPLAIN_IS_ZOOM_LEVEL_CLASS
 CHAMPLAIN_ZOOM_LEVEL_GET_CLASS
+<SUBSECTION Private>
+ChamplainZoomLevelClass
+ChamplainZoomLevelPrivate
 </SECTION>
 
 <SECTION>



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]