[libchamplain/libchamplain-0-12] Improvements in several files

From: JiÅÃ Techet <jiritechet src gnome org>
To: commits-list gnome org
Cc:
Subject: [libchamplain/libchamplain-0-12] Improvements in several files
Date: Mon, 28 May 2012 20:51:16 +0000 (UTC)
commit dc1d0ba2fdc2aca99dd9a32f05a5fec9b8a0a19b
Author: Pablo Castellano <pablo anche no>
Date:   Sun May 27 01:28:30 2012 +0200

    Improvements in several files

 champlain/champlain-bounding-box.c       |    8 +-
 champlain/champlain-coordinate.c         |    2 +-
 champlain/champlain-custom-marker.c      |    8 +-
 champlain/champlain-file-cache.c         |    2 +-
 champlain/champlain-label.c              |   94 +++++++++++++++---------------
 champlain/champlain-layer.c              |    2 +-
 champlain/champlain-license.c            |    6 +-
 champlain/champlain-map-source-chain.c   |    2 +-
 champlain/champlain-map-source-factory.c |    4 +-
 champlain/champlain-map-source.c         |    4 +-
 champlain/champlain-marker-layer.c       |   18 +++---
 champlain/champlain-marker.c             |   12 ++--
 champlain/champlain-memory-cache.c       |   12 ++--
 champlain/champlain-path-layer.c         |    1 +
 champlain/champlain-point.c              |    2 +-
 champlain/champlain-scale.c              |   16 +++---
 champlain/champlain-tile-cache.c         |    2 +-
 champlain/champlain-tile-source.c        |    4 +-
 champlain/champlain-version.h.in         |    2 +-
 champlain/champlain-view.c               |   64 ++++++++++----------
 20 files changed, 133 insertions(+), 132 deletions(-)
---
diff --git a/champlain/champlain-bounding-box.c b/champlain/champlain-bounding-box.c
index bd1cc7d..e84e58b 100644
--- a/champlain/champlain-bounding-box.c
+++ b/champlain/champlain-bounding-box.c
@@ -119,7 +119,7 @@ champlain_bounding_box_free (ChamplainBoundingBox *bbox)
  * @latitude: (out): the latitude of the box center
  * @longitude: (out): the longitude of the box center
  *
- * Sets the latitude and longitude of the box to @lat and @lon.
+ * Gets the center's latitude and longitude of the box to @latitude and @longitude.
  *
  * Since: 0.6
  */
@@ -167,8 +167,8 @@ champlain_bounding_box_compose (ChamplainBoundingBox *bbox,
 /**
  * champlain_bounding_box_extend:
  * @bbox: a #ChamplainBoundingBox
- * @latitude: latitude
- * @longitude: longitude
+ * @latitude: the latitude of the point
+ * @longitude: the longitude of the point
  *
  * Extend the bounding box so it contains a point with @latitude and @longitude.
  * Do nothing if the point is already inside the bounding box.
@@ -199,7 +199,7 @@ champlain_bounding_box_extend (ChamplainBoundingBox *bbox,
  * champlain_bounding_box_is_valid:
  * @bbox: a #ChamplainBoundingBox
  *
- * Checks whether bbox represents a valid bounding box on the map.
+ * Checks whether @bbox represents a valid bounding box on the map.
  *
  * Returns: TRUE when the bounding box is valid, FALSE otherwise.
  *
diff --git a/champlain/champlain-coordinate.c b/champlain/champlain-coordinate.c
index a12af00..241a1e2 100644
--- a/champlain/champlain-coordinate.c
+++ b/champlain/champlain-coordinate.c
@@ -18,7 +18,7 @@
 
 /**
  * SECTION:champlain-coordinate
- * @short_description: The simpliest implementation of #ChamplainLocation
+ * @short_description: The simplest implementation of #ChamplainLocation
  *
  * #ChamplainCoordinate is a simple object implementing #ChamplainLocation.
  */
diff --git a/champlain/champlain-custom-marker.c b/champlain/champlain-custom-marker.c
index 6c372f6..f8dcfce 100644
--- a/champlain/champlain-custom-marker.c
+++ b/champlain/champlain-custom-marker.c
@@ -18,12 +18,12 @@
 
 /**
  * SECTION:champlain-custom-marker
- * @short_description: #ChamplainCustomMarker is a marker implementing the
+ * @short_description: #ChamplainCustomMarker A marker implementing the
  * #ClutterContainer interface.
  *
- * #ChamplainCustomMarker is a marker implementing the #ClutterContainer
- * interface. You can insert your custom actors into the container. Don't forget
- * to set the anchor position in the marker using #clutter_actor_set_anchor_point.
+ * A marker implementing the #ClutterContainer interface. You can insert
+ * your custom actors into the container. Don't forget to set the anchor
+ * position in the marker using #clutter_actor_set_anchor_point.
  */
 
 #include "config.h"
diff --git a/champlain/champlain-file-cache.c b/champlain/champlain-file-cache.c
index 873a00b..fb0abc4 100644
--- a/champlain/champlain-file-cache.c
+++ b/champlain/champlain-file-cache.c
@@ -370,7 +370,7 @@ champlain_file_cache_init (ChamplainFileCache *file_cache)
 
 /**
  * champlain_file_cache_new_full:
- * @size_limit: maximal size of the cache in bytes
+ * @size_limit: maximum size of the cache in bytes
  * @cache_dir: (allow-none): the directory where the cache is created. When cache_dir == NULL,
  * a cache in ~/.cache/champlain is used.
  * @renderer: the #ChamplainRenderer used for tiles rendering
diff --git a/champlain/champlain-label.c b/champlain/champlain-label.c
index 55d6726..b2127cf 100644
--- a/champlain/champlain-label.c
+++ b/champlain/champlain-label.c
@@ -987,7 +987,7 @@ champlain_label_new (void)
 
 /**
  * champlain_label_new_with_text:
- * @text: the text of the text
+ * @text: the text of the label
  * @font: (allow-none): the font to use to draw the text, for example "Courrier Bold 11", can be NULL
  * @text_color: (allow-none): a #ClutterColor, the color of the text, can be NULL
  * @label_color: (allow-none): a #ClutterColor, the color of the label, can be NULL
@@ -1023,7 +1023,7 @@ champlain_label_new_with_text (const gchar *text,
 
 /**
  * champlain_label_new_with_image:
- * @actor: The actor of the image.
+ * @actor: The image as a @ClutterActor.
  *
  * Creates a new instance of #ChamplainLabel with image.
  *
@@ -1077,8 +1077,8 @@ champlain_label_new_from_file (const gchar *filename,
 
 /**
  * champlain_label_new_full:
- * @text: The text
- * @actor: The image
+ * @text: The text of the label
+ * @actor: The image as a @ClutterActor
  *
  * Creates a new instance of #ChamplainLabel consisting of a custom #ClutterActor.
  *
@@ -1105,8 +1105,8 @@ champlain_label_new_full (const gchar *text,
 
 /**
  * champlain_label_set_text:
- * @label: The label
- * @text: The text
+ * @label: a #ChamplainLabel
+ * @text: The new text of the label
  *
  * Sets the label's text.
  *
@@ -1131,7 +1131,7 @@ champlain_label_set_text (ChamplainLabel *label,
 
 /**
  * champlain_label_set_image:
- * @label: The label.
+ * @label: a #ChamplainLabel
  * @image: (allow-none): The image as a @ClutterActor or NULL to remove the current image.
  *
  * Sets the label's image.
@@ -1164,7 +1164,7 @@ champlain_label_set_image (ChamplainLabel *label,
 
 /**
  * champlain_label_set_use_markup:
- * @label: The label
+ * @label: a #ChamplainLabel
  * @use_markup: The value
  *
  * Sets if the label's text uses markup.
@@ -1185,10 +1185,10 @@ champlain_label_set_use_markup (ChamplainLabel *label,
 
 /**
  * champlain_label_set_alignment:
- * @label: The label
+ * @label: a #ChamplainLabel
  * @alignment: The label's alignment
  *
- * Set the label's text alignment.
+ * Sets the label's text alignment.
  *
  * Since: 0.10
  */
@@ -1206,11 +1206,11 @@ champlain_label_set_alignment (ChamplainLabel *label,
 
 /**
  * champlain_label_set_color:
- * @label: The label
+ * @label: a #ChamplainLabel
  * @color: (allow-none): The label's background color or NULL to reset the background to the
  *         default color. The color parameter is copied.
  *
- * Set the label's background color.
+ * Sets the label's background color.
  *
  * Since: 0.10
  */
@@ -1236,11 +1236,11 @@ champlain_label_set_color (ChamplainLabel *label,
 
 /**
  * champlain_label_set_text_color:
- * @label: The label
+ * @label: a #ChamplainLabel
  * @color: (allow-none): The label's text color or NULL to reset the text to the default
  *         color. The color parameter is copied.
  *
- * Set the label's text color.
+ * Sets the label's text color.
  *
  * Since: 0.10
  */
@@ -1266,11 +1266,11 @@ champlain_label_set_text_color (ChamplainLabel *label,
 
 /**
  * champlain_label_set_font_name:
- * @label: The label
+ * @label: a #ChamplainLabel
  * @font_name: (allow-none): The label's font name or NULL to reset the font to the default
  *             value.
  *
- * Set the label's font name such as "Sans 12".
+ * Sets the label's font name such as "Sans 12".
  *
  * Since: 0.10
  */
@@ -1296,10 +1296,10 @@ champlain_label_set_font_name (ChamplainLabel *label,
 
 /**
  * champlain_label_set_wrap:
- * @label: The label
+ * @label: a #ChamplainLabel
  * @wrap: The label's wrap.
  *
- * Set if the label's text wrap.
+ * Sets if the label's text wrap.
  *
  * Since: 0.10
  */
@@ -1317,10 +1317,10 @@ champlain_label_set_wrap (ChamplainLabel *label,
 
 /**
  * champlain_label_set_wrap_mode:
- * @label: The label
- * @wrap_mode: The label's wrap.
+ * @label: a #ChamplainLabel
+ * @wrap_mode: The label's wrap mode.
  *
- * Set the label's text color.
+ * Sets the label's text wrap mode.
  *
  * Since: 0.10
  */
@@ -1338,10 +1338,10 @@ champlain_label_set_wrap_mode (ChamplainLabel *label,
 
 /**
  * champlain_label_set_attributes:
- * @label: The label
+ * @label: a #ChamplainLabel
  * @list: The label's text attributes.
  *
- * Set the label's text attribute.
+ * Sets the label's text attributes.
  *
  * Since: 0.10
  */
@@ -1368,10 +1368,10 @@ champlain_label_set_attributes (ChamplainLabel *label,
 
 /**
  * champlain_label_set_ellipsize:
- * @label: The label
+ * @label: a #ChamplainLabel
  * @mode: The label's ellipsize mode.
  *
- * Set the label's text ellipsize mode.
+ * Sets the label's text ellipsize mode.
  *
  * Since: 0.10
  */
@@ -1389,10 +1389,10 @@ champlain_label_set_ellipsize (ChamplainLabel *label,
 
 /**
  * champlain_label_set_single_line_mode:
- * @label: The label
+ * @label: a #ChamplainLabel
  * @mode: The label's single line mode
  *
- * Set if the label's text is on a single line.
+ * Sets if the label's text is on a single line.
  *
  * Since: 0.10
  */
@@ -1411,10 +1411,10 @@ champlain_label_set_single_line_mode (ChamplainLabel *label,
 
 /**
  * champlain_label_set_draw_background:
- * @label: The label
+ * @label: a #ChamplainLabel
  * @background: value.
  *
- * Set if the label has a background.
+ * Sets if the label has a background.
  *
  * Since: 0.10
  */
@@ -1432,7 +1432,7 @@ champlain_label_set_draw_background (ChamplainLabel *label,
 
 /**
  * champlain_label_get_image:
- * @label: The label
+ * @label: a #ChamplainLabel
  *
  * Get the label's image.
  *
@@ -1451,7 +1451,7 @@ champlain_label_get_image (ChamplainLabel *label)
 
 /**
  * champlain_label_get_use_markup:
- * @label: The label
+ * @label: a #ChamplainLabel
  *
  * Check whether the label uses markup.
  *
@@ -1470,7 +1470,7 @@ champlain_label_get_use_markup (ChamplainLabel *label)
 
 /**
  * champlain_label_get_text:
- * @label: The label
+ * @label: a #ChamplainLabel
  *
  * Get the label's text.
  *
@@ -1489,7 +1489,7 @@ champlain_label_get_text (ChamplainLabel *label)
 
 /**
  * champlain_label_get_alignment:
- * @label: The label
+ * @label: a #ChamplainLabel
  *
  * Get the label's text alignment.
  *
@@ -1508,11 +1508,11 @@ champlain_label_get_alignment (ChamplainLabel *label)
 
 /**
  * champlain_label_get_color:
- * @label: The label
+ * @label: a #ChamplainLabel
  *
- * Gets the label's color.
+ * Gets the label's background color.
  *
- * Returns: the label's color.
+ * Returns: the label's background color.
  *
  * Since: 0.10
  */
@@ -1527,7 +1527,7 @@ champlain_label_get_color (ChamplainLabel *label)
 
 /**
  * champlain_label_get_text_color:
- * @label: The label
+ * @label: a #ChamplainLabel
  *
  * Gets the label's text color.
  *
@@ -1546,7 +1546,7 @@ champlain_label_get_text_color (ChamplainLabel *label)
 
 /**
  * champlain_label_get_font_name:
- * @label: The label
+ * @label: a #ChamplainLabel
  *
  * Gets the label's font name.
  *
@@ -1565,9 +1565,9 @@ champlain_label_get_font_name (ChamplainLabel *label)
 
 /**
  * champlain_label_get_wrap:
- * @label: The label
+ * @label: a #ChamplainLabel
  *
- * Check whether the label text wraps.
+ * Checks whether the label text wraps.
  *
  * Returns: if the label's text wraps.
  *
@@ -1584,9 +1584,9 @@ champlain_label_get_wrap (ChamplainLabel *label)
 
 /**
  * champlain_label_get_wrap_mode:
- * @label: The label
+ * @label: a #ChamplainLabel
  *
- * Get the label's text wrap mode.
+ * Gets the label's text wrap mode.
  *
  * Returns: the label's text wrap mode.
  *
@@ -1603,9 +1603,9 @@ champlain_label_get_wrap_mode (ChamplainLabel *label)
 
 /**
  * champlain_label_get_ellipsize:
- * @label: The label
+ * @label: a #ChamplainLabel
  *
- * Get the label's text ellipsize mode.
+ * Gets the label's text ellipsize mode.
  *
  * Returns: the label's text ellipsize mode.
  *
@@ -1622,7 +1622,7 @@ champlain_label_get_ellipsize (ChamplainLabel *label)
 
 /**
  * champlain_label_get_single_line_mode:
- * @label: The label
+ * @label: a #ChamplainLabel
  *
  * Checks the label's single line mode.
  *
@@ -1641,7 +1641,7 @@ champlain_label_get_single_line_mode (ChamplainLabel *label)
 
 /**
  * champlain_label_get_draw_background:
- * @label: The label
+ * @label: a #ChamplainLabel
  *
  * Checks whether the label has a background.
  *
@@ -1660,7 +1660,7 @@ champlain_label_get_draw_background (ChamplainLabel *label)
 
 /**
  * champlain_label_get_attributes:
- * @label: The label
+ * @label: a #ChamplainLabel
  *
  * Gets the label's text attributes.
  *
diff --git a/champlain/champlain-layer.c b/champlain/champlain-layer.c
index b685865..34c64bb 100644
--- a/champlain/champlain-layer.c
+++ b/champlain/champlain-layer.c
@@ -63,7 +63,7 @@ champlain_layer_class_init (ChamplainLayerClass *klass)
  * #ChamplainView calls this method to pass a reference to itself to the layer
  * when the layer is added to the view. When the layer is removed from the
  * view, it passes NULL to the layer. Custom layers can implement this method
- * and perform the necessary initialization. This method schould not be called
+ * and perform the necessary initialization. This method should not be called
  * by user code.
  *
  * Since: 0.10
diff --git a/champlain/champlain-license.c b/champlain/champlain-license.c
index dece260..c4ffbb7 100644
--- a/champlain/champlain-license.c
+++ b/champlain/champlain-license.c
@@ -433,7 +433,7 @@ champlain_license_disconnect_view (ChamplainLicense *license)
 /**
  * champlain_license_set_extra_text:
  * @license: a #ChamplainLicense
- * @text: a license
+ * @text: the additional license text
  *
  * Show the additional license text on the map view.  The text will preceed the
  * map's licence when displayed. Use "\n" to separate the lines.
@@ -478,8 +478,8 @@ champlain_license_get_extra_text (ChamplainLicense *license)
 
 /**
  * champlain_license_set_alignment:
- * @license: The license
- * @alignment: The license's alignment
+ * @license: a #ChamplainLicense
+ * @alignment: The license's text alignment
  *
  * Set the license's text alignment.
  *
diff --git a/champlain/champlain-map-source-chain.c b/champlain/champlain-map-source-chain.c
index d5deb2b..8da8e38 100644
--- a/champlain/champlain-map-source-chain.c
+++ b/champlain/champlain-map-source-chain.c
@@ -338,7 +338,7 @@ champlain_map_source_chain_push (ChamplainMapSourceChain *source_chain,
  * champlain_map_source_chain_pop:
  * @source_chain: a #ChamplainMapSourceChain
  *
- * Pops the map source from the top of the stack from the chain.
+ * Pops a map source from the top of the stack from the chain.
  *
  * Since: 0.6
  */
diff --git a/champlain/champlain-map-source-factory.c b/champlain/champlain-map-source-factory.c
index 11e0b23..59a4f6a 100644
--- a/champlain/champlain-map-source-factory.c
+++ b/champlain/champlain-map-source-factory.c
@@ -286,7 +286,7 @@ champlain_map_source_factory_init (ChamplainMapSourceFactory *factory)
  * A method to obtain the singleton object.
  *
  * Returns: (transfer full): the singleton #ChamplainMapSourceFactory, it should be freed
- * using #g_object_unref when not needed.
+ * using #g_object_unref() when not needed.
  *
  * Since: 0.4
  */
@@ -320,7 +320,7 @@ champlain_map_source_factory_get_registered (ChamplainMapSourceFactory *factory)
  * @factory: the Factory
  * @id: the wanted map source id
  *
- * The id should not contain any character that can't be in a filename as it
+ * Note: The id should not contain any character that can't be in a filename as it
  * will be used as the cache directory name for that map source.
  *
  * Returns: (transfer none): a ready to use #ChamplainMapSource matching the given name, returns
diff --git a/champlain/champlain-map-source.c b/champlain/champlain-map-source.c
index fb02a6b..a2ae7fc 100644
--- a/champlain/champlain-map-source.c
+++ b/champlain/champlain-map-source.c
@@ -36,7 +36,7 @@
  * delegate the work to the next map source in the chain by invoking the
  * same function on it.
 
- * To undertand the concept of chains, consider for instance a chain
+ * To understand the concept of chains, consider for instance a chain
  * consisting of #ChamplainFileCache whose next source is
  * #ChamplainNetworkTileSource whose next source is an error tile source
  * created with champlain_map_source_factory_create_error_source ().
@@ -676,7 +676,7 @@ champlain_map_source_get_meters_per_pixel (ChamplainMapSource *map_source,
 /**
  * champlain_map_source_fill_tile:
  * @map_source: a #ChamplainMapSource
- * @tile: A #ChamplainTile
+ * @tile: a #ChamplainTile
  *
  * Fills the tile with image data (either from cache, network or rendered
  * locally).
diff --git a/champlain/champlain-marker-layer.c b/champlain/champlain-marker-layer.c
index 16e05b7..750b7cb 100644
--- a/champlain/champlain-marker-layer.c
+++ b/champlain/champlain-marker-layer.c
@@ -315,7 +315,7 @@ champlain_marker_layer_new ()
  * champlain_marker_layer_new_full:
  * @mode: Selection mode
  *
- * Creates a new instance of #ChamplainMarkerLayer.
+ * Creates a new instance of #ChamplainMarkerLayer with the specified selection mode.
  *
  * Returns: a new #ChamplainMarkerLayer ready to be used as a container for the markers.
  *
@@ -523,7 +523,7 @@ champlain_marker_layer_get_markers (ChamplainMarkerLayer *layer)
  * champlain_marker_layer_get_selected:
  * @layer: a #ChamplainMarkerLayer
  *
- * Gets a list of selected markers.
+ * Gets a list of selected markers in the layer.
  *
  * Returns: (transfer container) (element-type ChamplainMarker): the list
  *
@@ -590,7 +590,7 @@ champlain_marker_layer_remove_marker (ChamplainMarkerLayer *layer,
  * champlain_marker_layer_animate_in_all_markers:
  * @layer: a #ChamplainMarkerLayer
  *
- * Fade in all markers with an animation
+ * Fade in all markers in the layer with an animation
  *
  * Since: 0.10
  */
@@ -622,7 +622,7 @@ champlain_marker_layer_animate_in_all_markers (ChamplainMarkerLayer *layer)
  * champlain_marker_layer_animate_out_all_markers:
  * @layer: a #ChamplainMarkerLayer
  *
- * Fade out all markers with an animation
+ * Fade out all markers in the layer with an animation
  *
  * Since: 0.10
  */
@@ -654,7 +654,7 @@ champlain_marker_layer_animate_out_all_markers (ChamplainMarkerLayer *layer)
  * champlain_marker_layer_show_all_markers:
  * @layer: a #ChamplainMarkerLayer
  *
- * Calls clutter_actor_show on all markers
+ * Shows all markers in the layer
  *
  * Since: 0.10
  */
@@ -684,7 +684,7 @@ champlain_marker_layer_show_all_markers (ChamplainMarkerLayer *layer)
  * champlain_marker_layer_hide_all_markers:
  * @layer: a #ChamplainMarkerLayer
  *
- * Calls clutter_actor_hide on all markers
+ * Hides all the markers in the layer
  *
  * Since: 0.10
  */
@@ -714,7 +714,7 @@ champlain_marker_layer_hide_all_markers (ChamplainMarkerLayer *layer)
  * champlain_marker_layer_set_all_markers_draggable:
  * @layer: a #ChamplainMarkerLayer
  *
- * Sets all markers draggable
+ * Sets all markers draggable in the layer
  *
  * Since: 0.10
  */
@@ -744,7 +744,7 @@ champlain_marker_layer_set_all_markers_draggable (ChamplainMarkerLayer *layer)
  * champlain_marker_layer_set_all_markers_undraggable:
  * @layer: a #ChamplainMarkerLayer
  *
- * Sets all markers undraggable
+ * Sets all markers undraggable in the layer
  *
  * Since: 0.10
  */
@@ -774,7 +774,7 @@ champlain_marker_layer_set_all_markers_undraggable (ChamplainMarkerLayer *layer)
  * champlain_marker_layer_unselect_all_markers:
  * @layer: a #ChamplainMarkerLayer
  *
- * Unselects all markers.
+ * Unselects all markers in the layer.
  *
  * Since: 0.10
  */
diff --git a/champlain/champlain-marker.c b/champlain/champlain-marker.c
index 28bd9bc..ec69989 100644
--- a/champlain/champlain-marker.c
+++ b/champlain/champlain-marker.c
@@ -19,9 +19,9 @@
 
 /**
  * SECTION:champlain-marker
- * @short_description: A marker to identify points of interest on a map
+ * @short_description: Base class of libchamplain markers
  *
- * Markers reprensent points of interest on a map. Markers need to be
+ * Markers represent points of interest on a map. Markers need to be
  * placed on a layer (a #ChamplainMarkerLayer). Layers have to be added to a
  * #champlainview for the markers to show on the map.
  *
@@ -734,7 +734,7 @@ champlain_marker_get_draggable (ChamplainMarker *marker)
 
 /**
  * champlain_marker_animate_in:
- * @marker: The marker
+ * @marker: a #ChamplainMarker
  *
  * Animates the marker as if it were falling from the sky onto the map.
  *
@@ -749,7 +749,7 @@ champlain_marker_animate_in (ChamplainMarker *marker)
 
 /**
  * champlain_marker_animate_in_with_delay :
- * @marker: The marker
+ * @marker: a #ChamplainMarker
  * @delay: The delay in milliseconds
  *
  * Animates the marker as if it were falling from the sky onto the map after
@@ -787,7 +787,7 @@ champlain_marker_animate_in_with_delay (ChamplainMarker *marker,
 
 /**
  * champlain_marker_animate_out:
- * @marker: The marker
+ * @marker: a #ChamplainMarker
  *
  * Animates the marker as if it were drawn through the sky.
  *
@@ -812,7 +812,7 @@ on_animation_completed (G_GNUC_UNUSED ClutterAnimation *animation,
 
 /**
  * champlain_marker_animate_out_with_delay :
- * @marker: The marker
+ * @marker: a #ChamplainMarker
  * @delay: The delay in milliseconds
  *
  * Animates the marker as if it were drawn through the sky after
diff --git a/champlain/champlain-memory-cache.c b/champlain/champlain-memory-cache.c
index 87ccadb..6f7863b 100644
--- a/champlain/champlain-memory-cache.c
+++ b/champlain/champlain-memory-cache.c
@@ -151,7 +151,7 @@ champlain_memory_cache_class_init (ChamplainMemoryCacheClass *klass)
   /**
    * ChamplainMemoryCache:size-limit:
    *
-   * The maximal number of tiles that are stored in the cache.
+   * The maximum number of tiles that are stored in the cache.
    *
    * Since: 0.8
    */
@@ -174,7 +174,7 @@ champlain_memory_cache_class_init (ChamplainMemoryCacheClass *klass)
 
 /**
  * champlain_memory_cache_new_full:
- * @size_limit: maximal number of tiles stored in the cache
+ * @size_limit: maximum number of tiles stored in the cache
  * @renderer: the #ChamplainRenderer used for tiles rendering
  *
  * Constructor of #ChamplainMemoryCache.
@@ -214,9 +214,9 @@ champlain_memory_cache_init (ChamplainMemoryCache *memory_cache)
  * champlain_memory_cache_get_size_limit:
  * @memory_cache: a #ChamplainMemoryCache
  *
- * Gets the maximal number of tiles stored in the cache.
+ * Gets the maximum number of tiles stored in the cache.
  *
- * Returns: maximal number of stored tiles
+ * Returns: maximum number of stored tiles
  *
  * Since: 0.8
  */
@@ -232,9 +232,9 @@ champlain_memory_cache_get_size_limit (ChamplainMemoryCache *memory_cache)
 /**
  * champlain_memory_cache_set_size_limit:
  * @memory_cache: a #ChamplainMemoryCache
- * @size_limit: maximal number of tiles stored in the cache
+ * @size_limit: maximum number of tiles stored in the cache
  *
- * Sets the maximal number of tiles stored in the cache.
+ * Sets the maximum number of tiles stored in the cache.
  *
  * Since: 0.8
  */
diff --git a/champlain/champlain-path-layer.c b/champlain/champlain-path-layer.c
index ce27522..fe62ea2 100644
--- a/champlain/champlain-path-layer.c
+++ b/champlain/champlain-path-layer.c
@@ -540,6 +540,7 @@ add_node (ChamplainPathLayer *layer,
  * @location: a #ChamplainLocation
  *
  * Adds a #ChamplainLocation object to the layer.
+ * The node is prepended to the list.
  *
  * Since: 0.10
  */
diff --git a/champlain/champlain-point.c b/champlain/champlain-point.c
index cb69714..7fb4c4a 100644
--- a/champlain/champlain-point.c
+++ b/champlain/champlain-point.c
@@ -18,7 +18,7 @@
 
 /**
  * SECTION:champlain-point
- * @short_description: Simple point to mark a coordinate
+ * @short_description: A simple point to mark a coordinate
  *
  * #ChamplainPoint is a simple variant of #ChamplainMarker. Contrary to
  * #ChamplainLabel, it is not capable of labelling the point with text and
diff --git a/champlain/champlain-scale.c b/champlain/champlain-scale.c
index b830094..0104568 100644
--- a/champlain/champlain-scale.c
+++ b/champlain/champlain-scale.c
@@ -537,7 +537,7 @@ champlain_scale_new (void)
 /**
  * champlain_scale_set_max_width:
  * @scale: a #ChamplainScale
- * @value: a #guint in pixels
+ * @value: the number of pixels
  *
  * Sets the maximum width of the scale on the screen in pixels
  *
@@ -561,7 +561,7 @@ champlain_scale_set_max_width (ChamplainScale *scale,
  * @scale: a #ChamplainScale
  * @unit: a #ChamplainUnit
  *
- * Sets the scales unit.
+ * Sets the scale unit.
  *
  * Since: 0.10
  */
@@ -579,11 +579,11 @@ champlain_scale_set_unit (ChamplainScale *scale,
 
 /**
  * champlain_scale_get_max_width:
- * @scale: The scale
+ * @scale: a #ChamplainScale
  *
- * Gets the maximal scale width.
+ * Gets the maximum scale width.
  *
- * Returns: The max scale width in pixels.
+ * Returns: The maximum scale width in pixels.
  *
  * Since: 0.10
  */
@@ -598,7 +598,7 @@ champlain_scale_get_max_width (ChamplainScale *scale)
 
 /**
  * champlain_scale_get_unit:
- * @scale: The scale
+ * @scale: a #ChamplainScale
  *
  * Gets the unit used by the scale.
  *
@@ -626,7 +626,7 @@ redraw_scale_cb (G_GNUC_UNUSED GObject *gobject,
 
 /**
  * champlain_scale_connect_view:
- * @scale: The scale
+ * @scale: a #ChamplainScale
  * @view: a #ChamplainView
  *
  * This method connects to the necessary signals of #ChamplainView to make the
@@ -649,7 +649,7 @@ champlain_scale_connect_view (ChamplainScale *scale,
 
 /**
  * champlain_scale_disconnect_view:
- * @scale: The scale
+ * @scale: a #ChamplainScale
  *
  * This method disconnects from the signals previously connected by champlain_scale_connect_view().
  *
diff --git a/champlain/champlain-tile-cache.c b/champlain/champlain-tile-cache.c
index 38a8e28..1415f30 100644
--- a/champlain/champlain-tile-cache.c
+++ b/champlain/champlain-tile-cache.c
@@ -20,7 +20,7 @@
  * SECTION:champlain-tile-cache
  * @short_description: A base class of tile caches
  *
- * This class defines properties and methods common to all caches (that is, map
+ * This class defines properties and methods commons to all caches (that is, map
  * sources that permit storage and retrieval of tiles). Tiles are typically
  * stored by #ChamplainTileSource objects.
  */
diff --git a/champlain/champlain-tile-source.c b/champlain/champlain-tile-source.c
index 793ad64..b2cc493 100644
--- a/champlain/champlain-tile-source.c
+++ b/champlain/champlain-tile-source.c
@@ -642,9 +642,9 @@ champlain_tile_source_set_min_zoom_level (ChamplainTileSource *tile_source,
 /**
  * champlain_tile_source_set_max_zoom_level:
  * @tile_source: a #ChamplainTileSource
- * @zoom_level: the maximal zoom level
+ * @zoom_level: the maximum zoom level
  *
- * Sets the tile source's maximal zoom level.
+ * Sets the tile source's maximum zoom level.
  *
  * Since: 0.6
  */
diff --git a/champlain/champlain-version.h.in b/champlain/champlain-version.h.in
index 5fe6337..614737b 100644
--- a/champlain/champlain-version.h.in
+++ b/champlain/champlain-version.h.in
@@ -40,7 +40,7 @@
 /**
  * CHAMPLAIN_MINOR_VERSION:
  *
- * The minor version of libchamplin (2, if %CHAMPLAIN_VERSION is 1.2.3)
+ * The minor version of libchamplain (2, if %CHAMPLAIN_VERSION is 1.2.3)
  */
 #define CHAMPLAIN_MINOR_VERSION   (@CHAMPLAIN_MINOR_VERSION@)
 
diff --git a/champlain/champlain-view.c b/champlain/champlain-view.c
index ddd6ad8..27baf1e 100644
--- a/champlain/champlain-view.c
+++ b/champlain/champlain-view.c
@@ -42,7 +42,7 @@
  * an error occurs during download, an error tile will be displayed.
  *
  * The button-press-event and button-release-event signals are emitted each
- * time a mouse button is pressed on the @view.
+ * time a mouse button is pressed and released on the @view.
  */
 
 #include "config.h"
@@ -998,7 +998,7 @@ champlain_view_class_init (ChamplainViewClass *champlainViewClass)
   /**
    * ChamplainView::layer-relocated:
    *
-   * Indicates that the layers hav been "relocated". In practice this means that
+   * Indicates that the layers have been "relocated". In practice this means that
    * every layer should connect to this signal and redraw itself when the signal is
    * emitted. Layer relocation happens when zooming in/out and when panning for more
    * than MAX_INT pixels.
@@ -1613,9 +1613,9 @@ champlain_view_zoom_out (ChamplainView *view)
 /**
  * champlain_view_set_zoom_level:
  * @view: a #ChamplainView
- * @zoom_level: a guint
+ * @zoom_level: the level of zoom, a guint between 1 and 20
  *
- * Changes the current zoom level
+ * Changes the current level of zoom
  *
  * Since: 0.4
  */
@@ -1634,9 +1634,9 @@ champlain_view_set_zoom_level (ChamplainView *view,
 /**
  * champlain_view_set_min_zoom_level:
  * @view: a #ChamplainView
- * @zoom_level: a guint
+ * @zoom_level: the level of zoom
  *
- * Changes the lowest allowed zoom level
+ * Changes the lowest allowed level of zoom
  *
  * Since: 0.4
  */
@@ -1666,9 +1666,9 @@ champlain_view_set_min_zoom_level (ChamplainView *view,
 /**
  * champlain_view_set_max_zoom_level:
  * @view: a #ChamplainView
- * @zoom_level: a guint
+ * @zoom_level: the level of zoom
  *
- * Changes the highest allowed zoom level
+ * Changes the highest allowed level of zoom
  *
  * Since: 0.4
  */
@@ -1725,7 +1725,7 @@ champlain_view_add_layer (ChamplainView *view,
  * @view: a #ChamplainView
  * @layer: a #ChamplainLayer
  *
- * Removes the layer from the view
+ * Removes the given layer from the view
  *
  * Since: 0.4.1
  */
@@ -2141,7 +2141,7 @@ tile_state_notify (ChamplainTile *tile,
  * @view: a #ChamplainView
  * @map_source: a #ChamplainMapSource
  *
- * Changes the currently used map source.  #g_object_unref will be called on
+ * Changes the currently used map source. #g_object_unref() will be called on
  * the previous one.
  *
  * Since: 0.4
@@ -2304,9 +2304,9 @@ champlain_view_set_animate_zoom (ChamplainView *view,
  * champlain_view_ensure_visible:
  * @view: a #ChamplainView
  * @bbox: bounding box of the area that should be visible
- * @animate: perform animation
+ * @animate: TRUE to perform animation, FALSE otherwise
  *
- * Changes the map's zoom level and center to make sure the two given area
+ * Changes the map's zoom level and center to make sure the given area
  * is visible
  *
  * Since: 0.10
@@ -2363,7 +2363,7 @@ champlain_view_ensure_visible (ChamplainView *view,
 /**
  * champlain_view_ensure_layers_visible:
  * @view: a #ChamplainView
- * @animate: perform animation
+ * @animate: TRUE to perform animation, FALSE otherwise
  *
  * Changes the map's zoom level and center to make sure that the bounding
  * boxes of all inserted layers are visible.
@@ -2614,7 +2614,7 @@ view_set_zoom_level_at (ChamplainView *view,
 
 /**
  * champlain_view_get_zoom_level:
- * @view: The view
+ * @view: a #ChamplainView
  *
  * Gets the view's current zoom level.
  *
@@ -2635,7 +2635,7 @@ champlain_view_get_zoom_level (ChamplainView *view)
 
 /**
  * champlain_view_get_min_zoom_level:
- * @view: The view
+ * @view: a #ChamplainView
  *
  * Gets the view's minimal allowed zoom level.
  *
@@ -2656,11 +2656,11 @@ champlain_view_get_min_zoom_level (ChamplainView *view)
 
 /**
  * champlain_view_get_max_zoom_level:
- * @view: The view
+ * @view: a #ChamplainView
  *
- * Gets the view's maximal allowed zoom level.
+ * Gets the view's maximum allowed zoom level.
  *
- * Returns: the view's maximal allowed zoom level.
+ * Returns: the view's maximum allowed zoom level.
  *
  * Since: 0.4
  */
@@ -2677,12 +2677,12 @@ champlain_view_get_max_zoom_level (ChamplainView *view)
 
 /**
  * champlain_view_get_map_source:
- * @view: The view
+ * @view: a #ChamplainView
  *
  * Gets the view's current map source.
  *
  * Returns: (transfer none): the view's current map source. If you need to keep a reference to the
- * map source then you have to call #g_object_ref.
+ * map source then you have to call #g_object_ref().
  *
  * Since: 0.4
  */
@@ -2699,7 +2699,7 @@ champlain_view_get_map_source (ChamplainView *view)
 
 /**
  * champlain_view_get_deceleration:
- * @view: The view
+ * @view: a #ChamplainView
  *
  * Gets the view's deceleration rate.
  *
@@ -2722,7 +2722,7 @@ champlain_view_get_deceleration (ChamplainView *view)
 
 /**
  * champlain_view_get_kinetic_mode:
- * @view: The view
+ * @view: a #ChamplainView
  *
  * Gets the view's scroll mode behaviour.
  *
@@ -2743,7 +2743,7 @@ champlain_view_get_kinetic_mode (ChamplainView *view)
 
 /**
  * champlain_view_get_keep_center_on_resize:
- * @view: The view
+ * @view: a #ChamplainView
  *
  * Checks whether to keep the center on resize
  *
@@ -2764,7 +2764,7 @@ champlain_view_get_keep_center_on_resize (ChamplainView *view)
 
 /**
  * champlain_view_get_zoom_on_double_click:
- * @view: The view
+ * @view: a #ChamplainView
  *
  * Checks whether the view zooms on double click.
  *
@@ -2785,7 +2785,7 @@ champlain_view_get_zoom_on_double_click (ChamplainView *view)
 
 /**
  * champlain_view_get_animate_zoom:
- * @view: The view
+ * @view: a #ChamplainView
  *
  * Checks whether the view animates zoom level changes.
  *
@@ -2806,12 +2806,12 @@ champlain_view_get_animate_zoom (ChamplainView *view)
 
 /**
  * champlain_view_bin_layout_add:
- * @view: The view
+ * @view: a #ChamplainView
  * @child: The child to be inserted
  * @x_align: x alignment
  * @y_align: y alignment
  *
- * This function iserts a custom actor to the undrelying #ClutterBinLayout
+ * This function inserts a custom actor to the undrelying #ClutterBinLayout
  * manager. The inserted actors appear on top of the map. See clutter_bin_layout_add()
  * for reference.
  *
@@ -2838,7 +2838,7 @@ champlain_view_bin_layout_add (ChamplainView *view,
 
 /**
  * champlain_view_get_license_actor:
- * @view: The view
+ * @view: a #ChamplainView
  *
  * Returns the #ChamplainLicense actor which is inserted by default into the
  * layout manager. It can be manipulated using standard #ClutterActor methods
@@ -2861,7 +2861,7 @@ champlain_view_get_license_actor (ChamplainView *view)
 
 /**
  * champlain_view_get_center_latitude:
- * @view: The view
+ * @view: a #ChamplainView
  *
  * Gets the latitude of the view's center.
  *
@@ -2882,11 +2882,11 @@ champlain_view_get_center_latitude (ChamplainView *view)
 
 /**
  * champlain_view_get_center_longitude:
- * @view: The view
+ * @view: a #ChamplainView
  *
  * Gets the longitude of the view's center.
  *
- * Returns: the latitude.
+ * Returns: the longitude.
  *
  * Since: 0.10
  */
@@ -2903,7 +2903,7 @@ champlain_view_get_center_longitude (ChamplainView *view)
 
 /**
  * champlain_view_get_state:
- * @view: The view
+ * @view: a #ChamplainView
  *
  * Gets the view's state.
  *
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]