From: Simon Wenner Date: Thu, 20 Aug 2009 14:11:33 +0000 (+0200) Subject: doc: cleanup ChamplainView X-Git-Url: https://err.no/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=bba639cc188b45ed0e43eaef2c324c3061c5453b;p=libchamplain doc: cleanup ChamplainView --- diff --git a/champlain/champlain-base-marker.c b/champlain/champlain-base-marker.c index 50aa54d..1179167 100644 --- a/champlain/champlain-base-marker.c +++ b/champlain/champlain-base-marker.c @@ -30,7 +30,7 @@ * 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" diff --git a/champlain/champlain-view.c b/champlain/champlain-view.c index f01c433..1cfda26 100644 --- a/champlain/champlain-view.c +++ b/champlain/champlain-view.c @@ -1111,6 +1111,7 @@ finger_scroll_button_press_cb (ClutterActor *actor, /** * champlain_view_new: + * * Returns a new #ChamplainView ready to be used as a #ClutterActor. * * Since: 0.4 @@ -1362,7 +1363,7 @@ champlain_view_set_zoom_level (ChamplainView *view, /** * champlain_view_set_min_zoom_level: * @view: a #ChamplainView - * @min_zoom_level: a gint + * @zoom_level: a gint * * Changes the lowest allowed zoom level * @@ -1390,7 +1391,7 @@ champlain_view_set_min_zoom_level (ChamplainView *view, /** * champlain_view_set_max_zoom_level: * @view: a #ChamplainView - * @max_zoom_level: a gint + * @zoom_level: a gint * * Changes the highest allowed zoom level * @@ -1450,8 +1451,8 @@ champlain_view_add_layer (ChamplainView *view, * champlain_view_get_coords_from_event: * @view: a #ChamplainView * @event: a #ClutterEvent - * @latitude: a variable where to put the latitude of the event - * @longitude: a variable where to put the longitude of the event + * @lat: a variable where to put the latitude of the event + * @lon: a variable where to put the longitude of the event * * Returns the latitude, longitude coordinates for the given ClutterEvent. * @@ -1513,8 +1514,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 - * @latitude: a variable where to put the latitude of the event - * @longitude: a variable where to put the longitude of the event + * @lat: a variable where to put the latitude of the event + * @lon: a variable where to put the longitude of the event * * Returns the latitude, longitude coordinates for the given x, y position in * the view. Use if you get coordinates from GtkEvents for example. @@ -1691,7 +1692,7 @@ view_update_state (ChamplainView *view) /** * champlain_view_set_map_source: * @view: a #ChamplainView - * @source: a #ChamplainMapSource + * @map_source: a #ChamplainMapSource * * Changes the currently used map source. #g_object_unref will be called on * the previous one. @@ -1865,6 +1866,7 @@ champlain_view_set_zoom_on_double_click (ChamplainView *view, * @lon1: the longitude of position 1 * @lat2: the latitude of position 2 * @lon2: the longitude of position 2 + * @animate: a #gboolean * * Changes the map's zoom level and center to make sure the two given * positions are visible @@ -1952,6 +1954,7 @@ champlain_view_ensure_visible (ChamplainView *view, * champlain_view_ensure_markers_visible: * @view: a #ChamplainView * @markers: a NULL terminated array of #ChamplainMarkers + * @animate: a #gboolean * * Changes the map's zoom level and center to make sure those markers are * visible. @@ -2187,7 +2190,7 @@ champlain_view_get_keep_center_on_resize (ChamplainView *view) } /** - * champlain_view_get_keep_center_on_resize: + * champlain_view_get_show_license: * @view: The view * * Returns TRUE if the view displays the license. diff --git a/champlain/champlain-view.h b/champlain/champlain-view.h index a1aac7e..cb46f13 100644 --- a/champlain/champlain-view.h +++ b/champlain/champlain-view.h @@ -82,9 +82,9 @@ void champlain_view_go_to (ChamplainView *view, gdouble longitude); void champlain_view_stop_go_to (ChamplainView *view); -void champlain_view_zoom_in (ChamplainView *champlainView); -void champlain_view_zoom_out (ChamplainView *champlainView); -void champlain_view_set_zoom_level (ChamplainView *champlainView, +void champlain_view_zoom_in (ChamplainView *view); +void champlain_view_zoom_out (ChamplainView *view); +void champlain_view_set_zoom_level (ChamplainView *view, gint zoom_level); void champlain_view_set_min_zoom_level (ChamplainView *view, gint zoom_level); @@ -101,7 +101,7 @@ void champlain_view_ensure_markers_visible (ChamplainView *view, ChamplainBaseMarker *markers[], gboolean animate); -void champlain_view_set_map_source (ChamplainView *champlainView, +void champlain_view_set_map_source (ChamplainView *view, ChamplainMapSource *map_source); void champlain_view_set_size (ChamplainView *view, guint width, @@ -116,7 +116,7 @@ void champlain_view_set_show_license (ChamplainView *view, gboolean value); void champlain_view_set_zoom_on_double_click (ChamplainView *view, gboolean value); -void champlain_view_add_layer (ChamplainView *champlainView, +void champlain_view_add_layer (ChamplainView *view, ChamplainLayer *layer); gboolean champlain_view_get_coords_from_event (ChamplainView *view, diff --git a/docs/reference/libchamplain-sections.txt b/docs/reference/libchamplain-sections.txt index ef0b562..c44683a 100644 --- a/docs/reference/libchamplain-sections.txt +++ b/docs/reference/libchamplain-sections.txt @@ -149,30 +149,30 @@ champlain_view_go_to champlain_view_stop_go_to champlain_view_zoom_in champlain_view_zoom_out -champlain_view_set_zoom_level -champlain_view_set_min_zoom_level -champlain_view_set_max_zoom_level champlain_view_ensure_visible champlain_view_ensure_markers_visible +champlain_view_set_min_zoom_level +champlain_view_get_min_zoom_level +champlain_view_set_max_zoom_level +champlain_view_get_max_zoom_level champlain_view_set_map_source +champlain_view_get_map_source champlain_view_set_size champlain_view_set_decel_rate +champlain_view_get_decel_rate champlain_view_set_scroll_mode +champlain_view_get_scroll_mode champlain_view_set_keep_center_on_resize +champlain_view_get_keep_center_on_resize champlain_view_set_show_license +champlain_view_get_show_license +champlain_view_set_zoom_level +champlain_view_get_zoom_level champlain_view_set_zoom_on_double_click +champlain_view_get_zoom_on_double_click champlain_view_add_layer champlain_view_get_coords_from_event champlain_view_get_coords_at -champlain_view_get_decel_rate -champlain_view_get_keep_center_on_resize -champlain_view_get_map_source -champlain_view_get_max_zoom_level -champlain_view_get_min_zoom_level -champlain_view_get_scroll_mode -champlain_view_get_show_license -champlain_view_get_zoom_level -champlain_view_get_zoom_on_double_click champlain_view_add_polygon champlain_view_remove_polygon @@ -183,6 +183,8 @@ champlain_view_get_type CHAMPLAIN_VIEW_CLASS CHAMPLAIN_IS_VIEW_CLASS CHAMPLAIN_VIEW_GET_CLASS + +ChamplainViewPrivate