[libchamplain] Fix documentation issues



commit c630ed1873ca9601f4bfee6124d4aa1c9cdb268d
Author: Jiří Techet <techet gmail com>
Date:   Sun Apr 28 01:27:47 2013 +0200

    Fix documentation issues

 champlain/champlain-bounding-box.c       |    2 ++
 champlain/champlain-custom-marker.c      |   11 +++++++----
 champlain/champlain-custom-marker.h      |    7 +++++++
 champlain/champlain-marker.c             |    5 +++--
 champlain/champlain-view.h               |    3 ++-
 docs/reference/Makefile.am               |    2 +-
 docs/reference/libchamplain-sections.txt |    6 +++++-
 docs/reference/libchamplain.types        |    1 +
 8 files changed, 28 insertions(+), 9 deletions(-)
---
diff --git a/champlain/champlain-bounding-box.c b/champlain/champlain-bounding-box.c
index 01e883f..5cd1b8e 100644
--- a/champlain/champlain-bounding-box.c
+++ b/champlain/champlain-bounding-box.c
@@ -220,6 +220,8 @@ champlain_bounding_box_is_valid (ChamplainBoundingBox *bbox)
 /**
  * champlain_bounding_box_covers:
  * @bbox: a #ChamplainBoundingBox
+ * @latitude: the latitude of the point
+ * @longitude: the longitude of the point
  *
  * Checks whether @bbox covers the given coordinates.
  *
diff --git a/champlain/champlain-custom-marker.c b/champlain/champlain-custom-marker.c
index 4ca745b..99943f9 100644
--- a/champlain/champlain-custom-marker.c
+++ b/champlain/champlain-custom-marker.c
@@ -18,12 +18,12 @@
 
 /**
  * SECTION:champlain-custom-marker
- * @short_description: #ChamplainCustomMarker A marker implementing the
- * #ClutterContainer interface.
+ * @short_description: A marker implementing the
+ * #ClutterContainer interface. Deprecated.
  *
  * 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.
+ * your custom actors into the container. Don't forget to set the marker's
+ * pointer position using #clutter_actor_set_translation.
  */
 
 #include "config.h"
@@ -81,6 +81,9 @@ champlain_custom_marker_init (ChamplainCustomMarker *custom_marker)
  * Returns: a new #ChamplainCustomMarker.
  *
  * Since: 0.10
+ * 
+ * Deprecated: 0.12.4: #ChamplainMarker is a concrete class now and can be used
+ * instead.
  */
 ClutterActor *
 champlain_custom_marker_new (void)
diff --git a/champlain/champlain-custom-marker.h b/champlain/champlain-custom-marker.h
index 8750e31..3828082 100644
--- a/champlain/champlain-custom-marker.h
+++ b/champlain/champlain-custom-marker.h
@@ -30,6 +30,8 @@
 
 G_BEGIN_DECLS
 
+#ifndef GTK_DISABLE_DEPRECATED
+
 #define CHAMPLAIN_TYPE_CUSTOM_MARKER champlain_custom_marker_get_type ()
 
 #define CHAMPLAIN_CUSTOM_MARKER(obj) \
@@ -59,6 +61,9 @@ typedef struct _ChamplainCustomMarkerClass ChamplainCustomMarkerClass;
  * and should be accessed using the provided API
  *
  * Since: 0.10
+ * 
+ * Deprecated: 0.12.4: #ChamplainMarker is a concrete class now and can be used
+ * instead.
  */
 struct _ChamplainCustomMarker
 {
@@ -76,6 +81,8 @@ GType champlain_custom_marker_get_type (void);
 
 ClutterActor *champlain_custom_marker_new (void);
 
+#endif
+
 G_END_DECLS
 
 #endif
diff --git a/champlain/champlain-marker.c b/champlain/champlain-marker.c
index eb20a6c..3bb02c1 100644
--- a/champlain/champlain-marker.c
+++ b/champlain/champlain-marker.c
@@ -26,8 +26,9 @@
  * #champlainview for the markers to show on the map.
  *
  * A marker is nothing more than a regular #clutteractor. You can draw on
- * it what ever you want.  Set the markers position
- * on the map using #champlain_location_set_location.
+ * it what ever you want.  Set the marker's position
+ * on the map using #champlain_location_set_location. Don't forget to set the 
+ * marker's pointer position using #clutter_actor_set_translation.
  *
  * This is a base class of all markers. libchamplain has a more evoluted
  * type of markers with text and image support. See #ChamplainLabel for more details.
diff --git a/champlain/champlain-view.h b/champlain/champlain-view.h
index e361387..c1757b8 100644
--- a/champlain/champlain-view.h
+++ b/champlain/champlain-view.h
@@ -153,11 +153,12 @@ void champlain_view_get_viewport_origin (ChamplainView *view,
     gint *x,
     gint *y);
 
+#ifndef GTK_DISABLE_DEPRECATED
 void champlain_view_bin_layout_add (ChamplainView *view,
     ClutterActor *child,
     ClutterBinAlignment x_align,
     ClutterBinAlignment y_align);
-
+#endif
 ChamplainLicense *champlain_view_get_license_actor (ChamplainView *view);
 
 ChamplainBoundingBox *champlain_view_get_bounding_box (ChamplainView *view);
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index f3c766e..da1b301 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -24,7 +24,7 @@ SCANGOBJ_OPTIONS=--type-init-func="g_type_init()"
 
 # Extra options to supply to gtkdoc-scan.
 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
-SCAN_OPTIONS=--rebuild-types
+SCAN_OPTIONS=--rebuild-types --deprecated-guards="GTK_DISABLE_DEPRECATED"
 
 # Extra options to supply to gtkdoc-mkdb.
 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
diff --git a/docs/reference/libchamplain-sections.txt b/docs/reference/libchamplain-sections.txt
index 2d73892..f979f98 100644
--- a/docs/reference/libchamplain-sections.txt
+++ b/docs/reference/libchamplain-sections.txt
@@ -88,6 +88,7 @@ ChamplainLabelPrivate
 <FILE>champlain-marker</FILE>
 <TITLE>ChamplainMarker</TITLE>
 ChamplainMarker
+champlain_marker_new
 champlain_marker_set_selectable
 champlain_marker_get_selectable
 champlain_marker_set_draggable
@@ -136,6 +137,7 @@ champlain_view_set_kinetic_mode
 champlain_view_set_keep_center_on_resize
 champlain_view_set_zoom_on_double_click
 champlain_view_set_animate_zoom
+champlain_view_set_background_pattern
 champlain_view_add_layer
 champlain_view_remove_layer
 champlain_view_get_zoom_level
@@ -147,6 +149,7 @@ champlain_view_get_kinetic_mode
 champlain_view_get_keep_center_on_resize
 champlain_view_get_zoom_on_double_click
 champlain_view_get_animate_zoom
+champlain_view_get_background_pattern
 champlain_view_reload_tiles
 champlain_view_x_to_longitude
 champlain_view_y_to_latitude
@@ -157,6 +160,7 @@ champlain_view_bin_layout_add
 champlain_view_get_license_actor
 champlain_view_get_center_latitude
 champlain_view_get_center_longitude
+champlain_view_get_bounding_box
 champlain_view_get_state
 <SUBSECTION Standard>
 CHAMPLAIN_VIEW
@@ -441,7 +445,6 @@ CHAMPLAIN_MAP_SOURCE_OSM_CYCLE_MAP
 CHAMPLAIN_MAP_SOURCE_OSM_TRANSPORT_MAP
 CHAMPLAIN_MAP_SOURCE_OSM_AERIAL_MAP
 CHAMPLAIN_MAP_SOURCE_OSM_MAPQUEST
-CHAMPLAIN_MAP_SOURCE_OAM
 CHAMPLAIN_MAP_SOURCE_MFF_RELIEF
 CHAMPLAIN_MAP_SOURCE_MEMPHIS_LOCAL
 CHAMPLAIN_MAP_SOURCE_MEMPHIS_NETWORK
@@ -469,6 +472,7 @@ champlain_bounding_box_get_center
 champlain_bounding_box_compose
 champlain_bounding_box_extend
 champlain_bounding_box_is_valid
+champlain_bounding_box_covers
 <SUBSECTION Standard>
 CHAMPLAIN_BOUNDING_BOX
 CHAMPLAIN_TYPE_BOUNDING_BOX
diff --git a/docs/reference/libchamplain.types b/docs/reference/libchamplain.types
index 617b049..6b579ab 100644
--- a/docs/reference/libchamplain.types
+++ b/docs/reference/libchamplain.types
@@ -16,6 +16,7 @@ champlain_map_source_get_type
 champlain_marker_get_type
 champlain_marker_layer_get_type
 champlain_memory_cache_get_type
+champlain_memphis_renderer_get_type
 champlain_network_bbox_tile_source_get_type
 champlain_network_tile_source_get_type
 champlain_null_tile_source_get_type


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