[libchamplain] Update BoundingBox documentation
- From: Pierre-Luc Beaudoin <plbeaudoin src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [libchamplain] Update BoundingBox documentation
- Date: Sun, 24 Jan 2010 20:12:46 +0000 (UTC)
commit 65768ff6ba14fa9849c2571d143493459576bd06
Author: Simon Wenner <simon wenner ch>
Date: Sat Aug 1 15:51:24 2009 +0200
Update BoundingBox documentation
champlain/champlain-bounding-box.c | 41 ++++++++++++++++++++---------------
champlain/champlain-bounding-box.h | 4 +-
2 files changed, 25 insertions(+), 20 deletions(-)
---
diff --git a/champlain/champlain-bounding-box.c b/champlain/champlain-bounding-box.c
index 4cb0d9c..5b1a026 100644
--- a/champlain/champlain-bounding-box.c
+++ b/champlain/champlain-bounding-box.c
@@ -33,7 +33,8 @@ champlain_bounding_box_get_type (void)
if (G_UNLIKELY (type == 0))
{
- type = g_boxed_type_register_static (g_intern_static_string ("ChamplainBoundingBox"),
+ type = g_boxed_type_register_static (
+ g_intern_static_string ("ChamplainBoundingBox"),
(GBoxedCopyFunc) champlain_bounding_box_copy,
(GBoxedFreeFunc) champlain_bounding_box_free);
}
@@ -42,13 +43,29 @@ champlain_bounding_box_get_type (void)
}
/**
+ * champlain_bounding_box_new:
+ *
+ * Creates a newly allocated #ChamplainBoundingBox to be freed
+ * with champlain_bounding_box_free().
+ *
+ * Returns: a #ChamplainBoundingBox
+ *
+ * Since: 0.6
+ */
+ChamplainBoundingBox *
+champlain_bounding_box_new (void)
+{
+ return g_slice_new (ChamplainBoundingBox);
+}
+
+/**
* champlain_bounding_box_copy:
* @bbox: a #ChamplainBoundingBox
*
* Makes a copy of the bounding box structure. The result must be
* freed using champlain_bounding_box_free().
*
- * Return value: an allocated copy of @bbox.
+ * Returns: an allocated copy of @bbox.
*
* Since: 0.6
*/
@@ -65,8 +82,8 @@ champlain_bounding_box_copy (const ChamplainBoundingBox *bbox)
* champlain_bounding_box_free:
* @bbox: a #ChamplainBoundingBox
*
- * Frees a bounding box structure created with #champlain_bounding_box_new or
- * #champlain_bounding_box_copy
+ * Frees a bounding box structure created with champlain_bounding_box_new() or
+ * champlain_bounding_box_copy().
*
* Since: 0.6
*/
@@ -81,25 +98,13 @@ champlain_bounding_box_free (ChamplainBoundingBox *bbox)
}
/**
- * champlain_bounding_box_new:
- *
- * Return value: a newly allocated #ChamplainBoundingBox to be freed
- * with #champlain_bounding_box_free
- *
- * Since: 0.6
- */
-ChamplainBoundingBox *
-champlain_bounding_box_new ()
-{
- return g_slice_new (ChamplainBoundingBox);
-}
-
-/**
* champlain_bounding_box_get_center:
* @bbox: a #ChamplainBoundingBox
* @lat: the latitude of the box center
* @lon: the longitude of the box center
*
+ * Sets the latitude and longitude of the box to @lat and @lon.
+ *
* Since: 0.6
*/
void
diff --git a/champlain/champlain-bounding-box.h b/champlain/champlain-bounding-box.h
index 0d7969c..28b33ec 100644
--- a/champlain/champlain-bounding-box.h
+++ b/champlain/champlain-bounding-box.h
@@ -48,12 +48,12 @@ struct _ChamplainBoundingBox {
GType champlain_bounding_box_get_type (void) G_GNUC_CONST;
#define CHAMPLAIN_TYPE_BOUNDING_BOX (champlain_bounding_box_get_type ())
+ChamplainBoundingBox * champlain_bounding_box_new (void);
+
ChamplainBoundingBox * champlain_bounding_box_copy (const ChamplainBoundingBox *bbox);
void champlain_bounding_box_free (ChamplainBoundingBox *bbox);
-ChamplainBoundingBox * champlain_bounding_box_new (void);
-
void champlain_bounding_box_get_center (ChamplainBoundingBox *bbox,
gdouble *lat,
gdouble *lon);
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]