From: Pierre-Luc Beaudoin Date: Sat, 6 Sep 2008 15:37:22 +0000 (-0400) Subject: Fix doc X-Git-Url: https://err.no/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=fc923e289e61b5b819262b1c41dc11a043b9c2e6;p=libchamplain Fix doc --- diff --git a/champlain/champlainview.c b/champlain/champlainview.c index fbdf400..94dc82d 100644 --- a/champlain/champlainview.c +++ b/champlain/champlainview.c @@ -350,16 +350,16 @@ champlain_view_class_init (ChamplainViewClass *champlainViewClass) "The level of zoom of the map", 0, 20, - 1.0f, + 3, CHAMPLAIN_PARAM_READWRITE)); /** - * ChamplainView:zoom-level: + * ChamplainView:map-source: * - * The level of zoom of the content. + * The #ChamplainMapSource being displayed * - * Since: 0.1 + * Since: 0.2 */ g_object_class_install_property(object_class, PROP_MAP_SOURCE, g_param_spec_int("map-source", @@ -385,9 +385,9 @@ champlain_view_class_init (ChamplainViewClass *champlainViewClass) CHAMPLAIN_PARAM_READWRITE)); /** - * ChamplainView:offline: + * ChamplainView:decel-rate: * - * If true, will fetch tiles from the Internet, otherwise, will only use cached content. + * The deceleration rate for the kinetic mode. * * Since: 0.2 */ @@ -398,8 +398,8 @@ champlain_view_class_init (ChamplainViewClass *champlainViewClass) "Rate at which the view " "will decelerate in " "kinetic mode.", - CLUTTER_FIXED_TO_FLOAT (CFX_ONE + CFX_MIN), - CLUTTER_FIXED_TO_FLOAT (CFX_MAX), + 1.0, + 2.0, 1.1, G_PARAM_READWRITE)); } @@ -410,7 +410,7 @@ champlain_view_init (ChamplainView *champlainView) ChamplainViewPrivate *priv = CHAMPLAIN_VIEW_GET_PRIVATE (champlainView); priv->mapSource = CHAMPLAIN_MAP_SOURCE_OPENSTREETMAP; - priv->zoomLevel = 0; + priv->zoomLevel = 3; priv->offline = FALSE; } @@ -449,7 +449,7 @@ view_size_allocated_cb (GtkWidget *view, GtkAllocation *allocation, ChamplainVie /** * champlain_view_new: - * + * @mode: a #ChamplainViewMode, the scrolling mode * Returns a new #ChamplainWidget ready to be used as a #GtkWidget. * * Since: 0.1 @@ -549,7 +549,6 @@ champlain_view_center_on (ChamplainView *champlainView, gdouble longitude, gdoub anchor->y = 0; } - //FIXME: Inform tiles that there is a new anchor int i; for (i = 0; i < priv->map->current_level->tiles->len; i++) { @@ -571,7 +570,7 @@ champlain_view_center_on (ChamplainView *champlainView, gdouble longitude, gdoub /** * champlain_view_zoom_in: - * @view: a #ChamplainView + * @champlainView: a #ChamplainView * * Zoom in the map by one level. * @@ -597,7 +596,7 @@ champlain_view_zoom_in (ChamplainView *champlainView) /** * champlain_view_zoom_out: - * @view: a #ChamplainView + * @champlainView: a #ChamplainView * * Zoom out the map by one level. * diff --git a/champlain/champlainview.h b/champlain/champlainview.h index f9d1a0b..ae55ab7 100644 --- a/champlain/champlainview.h +++ b/champlain/champlainview.h @@ -25,14 +25,20 @@ #include #include +/** + * ChamplainMapSource: + * @CHAMPLAIN_MAP_SOURCE_DEBUG: Debug map, untested as of 0.2 + * @CHAMPLAIN_MAP_SOURCE_OPENSTREETMAP: Open Street Map - Mapnick tiles + * @CHAMPLAIN_MAP_SOURCE_OPENARIALMAP: Open Arial Map + * @CHAMPLAIN_MAP_SOURCE_MAPSFORFREE_RELIEF: Maps for free - Relief tiles + * + * Type of scrolling. + */ typedef enum { CHAMPLAIN_MAP_SOURCE_DEBUG, CHAMPLAIN_MAP_SOURCE_OPENSTREETMAP, CHAMPLAIN_MAP_SOURCE_OPENARIALMAP, - //CHAMPLAIN_MAP_SOURCE_GOOGLE_MAP, - //CHAMPLAIN_MAP_SOURCE_GOOGLE_TERRAIN, - //CHAMPLAIN_MAP_SOURCE_GOOGLE_SATELITE CHAMPLAIN_MAP_SOURCE_MAPSFORFREE_RELIEF, CHAMPLAIN_MAP_SOURCE_COUNT } ChamplainMapSource; @@ -71,14 +77,14 @@ struct _ChamplainViewClass }; -CHAMPLAIN_API GType champlain_view_get_type (void); +GType champlain_view_get_type (void); -CHAMPLAIN_API GtkWidget *champlain_view_new (ChamplainViewMode mode); +GtkWidget *champlain_view_new (ChamplainViewMode mode); -CHAMPLAIN_API void champlain_view_center_on (ChamplainView *view, gdouble longitude, gdouble latitude); +void champlain_view_center_on (ChamplainView *view, gdouble longitude, gdouble latitude); -CHAMPLAIN_API void champlain_view_zoom_in (ChamplainView *champlainView); +void champlain_view_zoom_in (ChamplainView *champlainView); -CHAMPLAIN_API void champlain_view_zoom_out (ChamplainView *champlainView); +void champlain_view_zoom_out (ChamplainView *champlainView); #endif diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index c28b5ef..dabd9fe 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -19,7 +19,7 @@ SCANGOBJ_OPTIONS= # Extra options to supply to gtkdoc-scan. # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" -SCAN_OPTIONS= +SCAN_OPTIONS=--deprecated-guards="CHAMPLAIN_OBSOLETE_API" # Extra options to supply to gtkdoc-mkdb. # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml @@ -36,8 +36,8 @@ FIXXREF_OPTIONS= # Used for dependencies. The docs will be rebuilt if any of these change. # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c -HFILE_GLOB= -CFILE_GLOB= +HFILE_GLOB=$(top_srcdir)/champlain/*.h +CFILE_GLOB=$(top_srcdir)/champlain/*.c # Header files to ignore when scanning. # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h diff --git a/docs/reference/libchamplain-docs.sgml b/docs/reference/libchamplain-docs.sgml index 73a5b9d..7ce90b2 100644 --- a/docs/reference/libchamplain-docs.sgml +++ b/docs/reference/libchamplain-docs.sgml @@ -5,9 +5,9 @@ libchamplain Reference Manual - for libchamplain [VERSION] + for libchamplain 0.2 The latest version of this documentation can be found on-line at - http://[SERVER]/libchamplain/. + http://blog.squidy.info/projects/libchamplain/. diff --git a/docs/reference/libchamplain-sections.txt b/docs/reference/libchamplain-sections.txt index e92e418..666e59b 100644 --- a/docs/reference/libchamplain-sections.txt +++ b/docs/reference/libchamplain-sections.txt @@ -1,11 +1,18 @@
champlainview +ChamplainView +champlain/champlainview.h ChamplainMapSource +ChamplainViewMode CHAMPLAIN_CLASS CHAMPLAIN_GET_CLASS ChamplainViewPrivate -ChamplainView ChamplainView +champlain_view_get_type +champlain_view_new +champlain_view_center_on +champlain_view_zoom_in +champlain_view_zoom_out CHAMPLAIN_VIEW CHAMPLAIN_IS_VIEW @@ -21,45 +28,4 @@ CHAMPLAIN_MIN_LONG CHAMPLAIN_MAX_LONG
-
-champlain_defines -CHAMPLAIN_API -CHAMPLAIN_OBSOLETE_API -ChamplainView -ChamplainViewClass -Map -
- -
-zoomlevel -zoom_level_get_width -zoom_level_get_height -zoom_level_new -
- -
-map -Map -map_load_visible_tiles -map_zoom_in -
- -
-champlain-marshal -champlain_marshal_VOID__OBJECT_OBJECT -
- -
-tile -
- -
-openstreetmap -osm_init -
- -
-debugmap -debugmap_init -