[libchamplain/libchamplain-0-8] Add some extra annotations



commit abd701a55a73f809e82acf997980ff71c34cc81f
Author: JiÅ?í Techet <techet gmail com>
Date:   Mon Jan 3 00:14:06 2011 +0100

    Add some extra annotations
    
    Add the annotations we have in the vala .metadata file directly to the
    sources.

 champlain/champlain-bounding-box.c |    4 ++--
 champlain/champlain-marker.c       |    6 +++---
 champlain/champlain-view.c         |   28 ++++++++++++++--------------
 3 files changed, 19 insertions(+), 19 deletions(-)
---
diff --git a/champlain/champlain-bounding-box.c b/champlain/champlain-bounding-box.c
index 531706b..decb55c 100644
--- a/champlain/champlain-bounding-box.c
+++ b/champlain/champlain-bounding-box.c
@@ -106,8 +106,8 @@ champlain_bounding_box_free (ChamplainBoundingBox *bbox)
 /**
  * champlain_bounding_box_get_center:
  * @bbox: a #ChamplainBoundingBox
- * @lat: the latitude of the box center
- * @lon: the longitude of the box center
+ * @lat: (out): the latitude of the box center
+ * @lon: (out): the longitude of the box center
  *
  * Sets the latitude and longitude of the box to @lat and @lon.
  *
diff --git a/champlain/champlain-marker.c b/champlain/champlain-marker.c
index e9444f7..476a4d1 100644
--- a/champlain/champlain-marker.c
+++ b/champlain/champlain-marker.c
@@ -887,9 +887,9 @@ champlain_marker_new (void)
 /**
  * champlain_marker_new_with_text:
  * @text: the text of the text
- * @font: the font to use to draw the text, for example "Courrier Bold 11", can be NULL
- * @text_color: a #ClutterColor, the color of the text, can be NULL
- * @marker_color: a #ClutterColor, the color of the marker, can be NULL
+ * @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
+ * @marker_color: (allow-none): a #ClutterColor, the color of the marker, can be NULL
  *
  * Creates a new instance of #ChamplainMarker with text value.
  *
diff --git a/champlain/champlain-view.c b/champlain/champlain-view.c
index 6d4a727..a9df999 100644
--- a/champlain/champlain-view.c
+++ b/champlain/champlain-view.c
@@ -2376,8 +2376,8 @@ champlain_view_remove_layer (ChamplainView *view,
  * champlain_view_get_coords_from_event:
  * @view: a #ChamplainView
  * @event: a #ClutterEvent
- * @lat: a variable where to put the latitude of the event
- * @lon: a variable where to put the longitude of the event
+ * @lat: (out): a variable where to put the latitude of the event
+ * @lon: (out): a variable where to put the longitude of the event
  *
  * Gets coordinates from button-press-event and button-release-event signals.
  *
@@ -2388,8 +2388,8 @@ champlain_view_remove_layer (ChamplainView *view,
 gboolean
 champlain_view_get_coords_from_event (ChamplainView *view,
     ClutterEvent *event,
-    gdouble *latitude,
-    gdouble *longitude)
+    gdouble *lat,
+    gdouble *lon)
 {
   DEBUG_LOG ()
 
@@ -2439,7 +2439,7 @@ champlain_view_get_coords_from_event (ChamplainView *view,
       return FALSE;
     }
 
-  return champlain_view_get_coords_at (view, x, y, latitude, longitude);
+  return champlain_view_get_coords_at (view, x, y, lat, lon);
 }
 
 
@@ -2448,8 +2448,8 @@ champlain_view_get_coords_from_event (ChamplainView *view,
  * @view: a #ChamplainView
  * @x: the x position in the view
  * @y: the y position in the view
- * @lat: a variable where to put the latitude of the event
- * @lon: a variable where to put the longitude of the event
+ * @lat: (out): a variable where to put the latitude of the event
+ * @lon: (out): a variable where to put the longitude of the event
  *
  * Gets latitude and longitude for the given x, y position in
  * the view. Use if you get coordinates from GtkEvents for example.
@@ -2462,8 +2462,8 @@ gboolean
 champlain_view_get_coords_at (ChamplainView *view,
     guint x,
     guint y,
-    gdouble *latitude,
-    gdouble *longitude)
+    gdouble *lat,
+    gdouble *lon)
 {
   DEBUG_LOG ()
 
@@ -2477,11 +2477,11 @@ champlain_view_get_coords_at (ChamplainView *view,
   rel_x = x - actor_x;
   rel_y = y - actor_y;
 
-  if (latitude)
-    *latitude = viewport_get_latitude_at (priv,
+  if (lat)
+    *lat = viewport_get_latitude_at (priv,
           priv->viewport_size.y + rel_y + priv->anchor.y);
-  if (longitude)
-    *longitude = viewport_get_longitude_at (priv,
+  if (lon)
+    *lon = viewport_get_longitude_at (priv,
           priv->viewport_size.x + rel_x + priv->anchor.x);
 
   return TRUE;
@@ -3088,7 +3088,7 @@ champlain_view_ensure_visible (ChamplainView *view,
 /**
  * champlain_view_ensure_markers_visible:
  * @view: a #ChamplainView
- * @markers: a NULL terminated array of #ChamplainMarker elements
+ * @markers: (array zero-terminated=1): a NULL terminated array of #ChamplainMarker elements
  * @animate: a #gboolean
  *
  * Changes the map's zoom level and center to make sure those markers are



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