[libchamplain] Improvements to the documentation and moving around some definitions
- From: Jiří Techet <jiritechet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libchamplain] Improvements to the documentation and moving around some definitions
- Date: Sun, 9 May 2010 23:56:51 +0000 (UTC)
commit 02ceb5ec8249e9632d7ca72a5f780280d78f9b54
Author: JiÅ?Ã Techet <techet gmail com>
Date: Sun May 9 23:47:32 2010 +0200
Improvements to the documentation and moving around some definitions
Signed-off-by: JiÅ?Ã Techet <techet gmail com>
bindings/python/champlain/pychamplainmodule.c | 5 -
champlain/champlain-base-marker.c | 8 ++
champlain/champlain-bounding-box.c | 5 +-
champlain/champlain-defines.h | 22 ----
champlain/champlain-file-cache.c | 10 +-
champlain/champlain-layer.c | 2 +
champlain/champlain-local-map-data-source.c | 6 +-
champlain/champlain-map-data-source.c | 4 +-
champlain/champlain-map-source-desc.c | 7 +-
champlain/champlain-map-source-factory.c | 12 ++-
champlain/champlain-map-source-factory.h | 56 +++++++++--
champlain/champlain-map-source.c | 2 +-
champlain/champlain-map-source.h | 6 +
champlain/champlain-marker.c | 50 ++++++++--
champlain/champlain-memphis-tile-source.c | 10 ++
champlain/champlain-network-map-data-source.c | 6 +-
champlain/champlain-network-tile-source.c | 25 ++++-
champlain/champlain-point.c | 7 +-
champlain/champlain-point.h | 7 ++
champlain/champlain-polygon.c | 22 ++++-
champlain/champlain-private.h | 8 ++
champlain/champlain-selection-layer.c | 14 ++-
champlain/champlain-tile.c | 52 ++++-----
champlain/champlain-tile.h | 16 +++-
champlain/champlain-view.c | 49 ++++++++-
champlain/champlain-view.h | 17 +++-
champlain/champlain.h | 5 -
docs/reference/Makefile.am | 14 ++--
docs/reference/libchamplain-docs.sgml | 5 +-
docs/reference/libchamplain-sections.txt | 141 +++++++-----------------
30 files changed, 376 insertions(+), 217 deletions(-)
---
diff --git a/bindings/python/champlain/pychamplainmodule.c b/bindings/python/champlain/pychamplainmodule.c
index b39db20..ddb76a2 100644
--- a/bindings/python/champlain/pychamplainmodule.c
+++ b/bindings/python/champlain/pychamplainmodule.c
@@ -44,11 +44,6 @@ initchamplain (void)
PyModule_AddObject(m, "MAP_SOURCE_MFF_RELIEF", Py_BuildValue("s",
CHAMPLAIN_MAP_SOURCE_MFF_RELIEF));
- PyModule_AddObject(m, "MIN_LAT", Py_BuildValue("i", CHAMPLAIN_MIN_LAT));
- PyModule_AddObject(m, "MAX_LAT", Py_BuildValue("i", CHAMPLAIN_MAX_LAT));
- PyModule_AddObject(m, "MIN_LONG", Py_BuildValue("i", CHAMPLAIN_MIN_LONG));
- PyModule_AddObject(m, "MAX_LONG", Py_BuildValue("i", CHAMPLAIN_MAX_LONG));
-
if (PyErr_Occurred ()) {
PyErr_Print();
Py_FatalError ("can't initialise module champlain");
diff --git a/champlain/champlain-base-marker.c b/champlain/champlain-base-marker.c
index 2af08ba..c143eac 100644
--- a/champlain/champlain-base-marker.c
+++ b/champlain/champlain-base-marker.c
@@ -204,6 +204,8 @@ champlain_base_marker_init (ChamplainBaseMarker *marker)
/**
* champlain_base_marker_new:
*
+ * Creates a new instance of #ChamplainBaseMarker.
+ *
* Returns: a new #ChamplainBaseMarker ready to be used as a #ClutterActor.
*
* Since: 0.4
@@ -248,6 +250,8 @@ champlain_base_marker_set_position (ChamplainBaseMarker *marker,
* champlain_base_marker_get_latitude:
* @marker: a #ChamplainBaseMarker
*
+ * Gets the latitude of the marker.
+ *
* Returns: the latitude of the marker.
*
* Since: 0.6
@@ -263,6 +267,8 @@ gdouble champlain_base_marker_get_latitude (ChamplainBaseMarker *marker)
* champlain_base_marker_get_longitude:
* @marker: a #ChamplainBaseMarker
*
+ * Gets the longitude of the marker.
+ *
* Returns: the longitude of the marker.
*
* Since: 0.6
@@ -299,6 +305,8 @@ champlain_base_marker_set_highlighted (ChamplainBaseMarker *marker,
* champlain_base_marker_get_highlighted:
* @marker: a #ChamplainBaseMarker
*
+ * Checks whether the marker is highlighted.
+ *
* Returns: the highlighted or not state of the marker.
*
* Since: 0.4
diff --git a/champlain/champlain-bounding-box.c b/champlain/champlain-bounding-box.c
index 0dd4353..74d1cca 100644
--- a/champlain/champlain-bounding-box.c
+++ b/champlain/champlain-bounding-box.c
@@ -21,7 +21,10 @@
/**
* SECTION:champlain-bounding-box
- * @short_description: A basic struct to describe a bounding box
+ * @short_description: A basic struct to describe a bounding box.
+ *
+ * A basic struct to describe a bounding box.
+ *
*/
#include "champlain-bounding-box.h"
diff --git a/champlain/champlain-defines.h b/champlain/champlain-defines.h
index 95757ee..767e8d7 100644
--- a/champlain/champlain-defines.h
+++ b/champlain/champlain-defines.h
@@ -24,32 +24,10 @@
#define CHAMPLAIN_DEFINES_H
#define CHAMPLAIN_API __attribute__((visibility("default")))
-#define CHAMPLAIN_OBSOLETE_API CHAMPLAIN_API __attribute__((deprecated))
typedef struct _ChamplainView ChamplainView;
typedef struct _ChamplainViewClass ChamplainViewClass;
typedef struct _ChamplainMapSource ChamplainMapSource;
-#define CHAMPLAIN_PARAM_READABLE \
- (G_PARAM_READABLE | \
- G_PARAM_STATIC_NICK | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB)
-
-#define CHAMPLAIN_PARAM_READWRITE \
- (G_PARAM_READABLE | G_PARAM_WRITABLE | \
- G_PARAM_STATIC_NICK | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB)
-
-typedef enum
-{
- CHAMPLAIN_STATE_NONE,
- CHAMPLAIN_STATE_LOADING,
- CHAMPLAIN_STATE_DONE
-} ChamplainState;
-
-typedef enum
-{
- CHAMPLAIN_UNIT_KM,
- CHAMPLAIN_UNIT_MILES,
-} ChamplainUnit;
-
#endif
diff --git a/champlain/champlain-file-cache.c b/champlain/champlain-file-cache.c
index 3a1904d..c629f54 100644
--- a/champlain/champlain-file-cache.c
+++ b/champlain/champlain-file-cache.c
@@ -484,7 +484,7 @@ ChamplainFileCache* champlain_file_cache_new_full (guint size_limit,
/**
* champlain_file_cache_get_size_limit:
- * @file_cache: a #ChamplainCache
+ * @file_cache: a #ChamplainFileCache
*
* Gets the cache size limit in bytes.
*
@@ -502,7 +502,7 @@ champlain_file_cache_get_size_limit (ChamplainFileCache *file_cache)
/**
* champlain_file_cache_get_cache_dir:
- * @file_cache: a #ChamplainCache
+ * @file_cache: a #ChamplainFileCache
*
* Gets the directory where the cache database is stored.
*
@@ -520,7 +520,7 @@ champlain_file_cache_get_cache_dir (ChamplainFileCache *file_cache)
/**
* champlain_file_cache_set_size_limit:
- * @file_cache: a #ChamplainCache
+ * @file_cache: a #ChamplainFileCache
* @size_limit: the cache limit in bytes
*
* Sets the cache size limit in bytes.
@@ -962,7 +962,7 @@ purge_on_idle (gpointer data)
/**
* champlain_file_cache_purge_on_idle:
- * @file_cache: a #ChamplainCache
+ * @file_cache: a #ChamplainFileCache
*
* Purge the cache from the less popular tiles until cache's size limit is reached.
* This is a non blocking call as the purge will happen when the application is idle
@@ -978,7 +978,7 @@ champlain_file_cache_purge_on_idle (ChamplainFileCache *file_cache)
/**
* champlain_file_cache_purge:
- * @file_cache: a #ChamplainCache
+ * @file_cache: a #ChamplainFileCache
*
* Purge the cache from the less popular tiles until cache's size limit is reached.
*
diff --git a/champlain/champlain-layer.c b/champlain/champlain-layer.c
index 59928a4..6704ac8 100644
--- a/champlain/champlain-layer.c
+++ b/champlain/champlain-layer.c
@@ -179,6 +179,8 @@ layer_remove_cb (ClutterGroup *layer,
/**
* champlain_layer_new:
*
+ * Creates a new instance of #ChamplainLayer.
+ *
* Returns: a new #ChamplainLayer ready to be used as a #ClutterContainer for the markers.
*
* Since: 0.2.2
diff --git a/champlain/champlain-local-map-data-source.c b/champlain/champlain-local-map-data-source.c
index 3987a2b..df62de9 100644
--- a/champlain/champlain-local-map-data-source.c
+++ b/champlain/champlain-local-map-data-source.c
@@ -18,7 +18,7 @@
/**
* SECTION:champlain-local-map-data-source
- * @short_description: Loads local map data for #ChamplainMemphisMapSource.
+ * @short_description: Loads local map data for #ChamplainMemphisTileSource.
*
* This map data source loads local <ulink role="online-location"
* url="http://wiki.openstreetmap.org/wiki/.osm";>
@@ -129,7 +129,9 @@ champlain_local_map_data_source_init (ChamplainLocalMapDataSource *self)
/**
* champlain_local_map_data_source_new:
*
- * Returns: a new ChamplainLocalMapDataSource.
+ * Creates a new instance of #ChamplainLocalMapDataSource.
+ *
+ * Returns: a new #ChamplainLocalMapDataSource.
*
* Since: 0.6
*/
diff --git a/champlain/champlain-map-data-source.c b/champlain/champlain-map-data-source.c
index b83e2fa..e5ecfbc 100644
--- a/champlain/champlain-map-data-source.c
+++ b/champlain/champlain-map-data-source.c
@@ -21,7 +21,7 @@
* @short_description: Base class for map data sources.
*
* ChamplainMapDataSource provides the interface for
- * #ChamplainMemphisMapSource to aquire map data.
+ * #ChamplainMemphisTileSource to aquire map data.
*
*/
@@ -194,6 +194,8 @@ champlain_map_data_source_init (ChamplainMapDataSource *self)
* champlain_map_data_source_get_map_data:
* @data_source: a #ChamplainMapDataSource
*
+ * Gets the #MemphisMap of the data source.
+ *
* Returns: the #MemphisMap of the data source or NULL.
*
* Since: 0.6
diff --git a/champlain/champlain-map-source-desc.c b/champlain/champlain-map-source-desc.c
index 161492c..99c9530 100644
--- a/champlain/champlain-map-source-desc.c
+++ b/champlain/champlain-map-source-desc.c
@@ -21,7 +21,10 @@
/**
* SECTION:champlain-map-source-desc
- * @short_description: A basic struct to describe map sources
+ * @short_description: A basic struct to describe map sources.
+ *
+ * A basic struct to describe map sources.
+ *
*/
#include "champlain-map-source-desc.h"
@@ -120,6 +123,8 @@ champlain_map_source_desc_free (ChamplainMapSourceDesc *desc)
/**
* champlain_map_source_desc_new:
*
+ * Creates a new instance of #ChamplainMapSourceDesc.
+ *
* Returns: a newly allocated #ChamplainMapSourceDesc to be freed with #champlain_map_source_desc_free
*
* Since: 0.4
diff --git a/champlain/champlain-map-source-factory.c b/champlain/champlain-map-source-factory.c
index 7a1791c..e4a062c 100644
--- a/champlain/champlain-map-source-factory.c
+++ b/champlain/champlain-map-source-factory.c
@@ -323,6 +323,8 @@ champlain_map_source_factory_init (ChamplainMapSourceFactory *factory)
/**
* champlain_map_source_factory_dup_default:
*
+ * A method to obtain the singleton object.
+ *
* Returns: the singleton #ChamplainMapSourceFactory, it should be freed
* using #g_object_unref when not needed.
*
@@ -338,6 +340,8 @@ champlain_map_source_factory_dup_default (void)
* champlain_map_source_factory_dup_list:
* @factory: the Factory
*
+ * Get the list of registered map sources.
+ *
* Returns: the list of registered map sources, the items should not be freed,
* the list should be freed with #g_slist_free.
*
@@ -354,12 +358,12 @@ champlain_map_source_factory_dup_list (ChamplainMapSourceFactory *factory)
* @factory: the Factory
* @id: the wanted map source id
*
- * Returns: a ready to use #ChamplainMapSource matching the given name, returns
- * NULL is none match.
- *
* The id should not contain any character that can't be in a filename as it
* will be used as the cache directory name for that map source.
*
+ * Returns: a ready to use #ChamplainMapSource matching the given name, returns
+ * NULL is none match.
+ *
* Since: 0.4
*/
ChamplainMapSource *
@@ -386,6 +390,8 @@ champlain_map_source_factory_create (ChamplainMapSourceFactory *factory,
* @factory: the Factory
* @id: the wanted map source id
*
+ * Creates a cached map source.
+ *
* Returns: a ready to use #ChamplainMapSourceChain consisting of
* #ChamplainFileCache, #ChamplainMapSource matching the given name, and
* #ChamplainErrorTileSource.
diff --git a/champlain/champlain-map-source-factory.h b/champlain/champlain-map-source-factory.h
index 6a8f84a..b5fcfc1 100644
--- a/champlain/champlain-map-source-factory.h
+++ b/champlain/champlain-map-source-factory.h
@@ -70,24 +70,64 @@ champlain_map_source_factory_register (ChamplainMapSourceFactory *factory,
ChamplainMapSourceDesc *desc, ChamplainMapSourceConstructor constructor,
gpointer data);
-#ifdef CHAMPLAIN_HAS_MAEMO
+#ifndef CHAMPLAIN_HAS_MAEMO
+/**
+ * CHAMPLAIN_MAP_SOURCE_OSM_MAPNIK:
+ *
+ * OpenStreetMap Mapnik
+ */
+#define CHAMPLAIN_MAP_SOURCE_OSM_MAPNIK "osm-mapnik"
+/**
+ * CHAMPLAIN_MAP_SOURCE_OSM_OSMARENDER:
+ *
+ * OpenStreetMap Osmarender
+ */
+#define CHAMPLAIN_MAP_SOURCE_OSM_OSMARENDER "osm-osmarender"
+/**
+ * CHAMPLAIN_MAP_SOURCE_OSM_CYCLE_MAP:
+ *
+ * OpenStreetMap Cycle Map
+ */
+#define CHAMPLAIN_MAP_SOURCE_OSM_CYCLE_MAP "osm-cyclemap"
+/**
+ * CHAMPLAIN_MAP_SOURCE_OSM_TRANSPORT_MAP:
+ *
+ * OpenStreetMap Transport Map
+ */
+#define CHAMPLAIN_MAP_SOURCE_OSM_TRANSPORT_MAP "osm-transportmap"
+/**
+ * CHAMPLAIN_MAP_SOURCE_OAM:
+ *
+ * OpenAerialMap
+ */
+#define CHAMPLAIN_MAP_SOURCE_OAM "OpenAerialMap"
+/**
+ * CHAMPLAIN_MAP_SOURCE_MFF_RELIEF:
+ *
+ * Maps for Free Relief
+ */
+#define CHAMPLAIN_MAP_SOURCE_MFF_RELIEF "mff-relief"
+#else
#define CHAMPLAIN_MAP_SOURCE_OSM_MAPNIK "OpenStreetMap I"
#define CHAMPLAIN_MAP_SOURCE_OSM_OSMARENDER "OpenStreetMap II"
#define CHAMPLAIN_MAP_SOURCE_OSM_CYCLE_MAP "OpenCycleMap"
#define CHAMPLAIN_MAP_SOURCE_OSM_TRANSPORT_MAP "Public Transport"
#define CHAMPLAIN_MAP_SOURCE_OAM "OpenAerialMap"
#define CHAMPLAIN_MAP_SOURCE_MFF_RELIEF "MapsForFree Relief"
-#else
-#define CHAMPLAIN_MAP_SOURCE_OSM_MAPNIK "osm-mapnik"
-#define CHAMPLAIN_MAP_SOURCE_OSM_OSMARENDER "osm-osmarender"
-#define CHAMPLAIN_MAP_SOURCE_OSM_CYCLE_MAP "osm-cyclemap"
-#define CHAMPLAIN_MAP_SOURCE_OSM_TRANSPORT_MAP "osm-transportmap"
-#define CHAMPLAIN_MAP_SOURCE_OAM "oam"
-#define CHAMPLAIN_MAP_SOURCE_MFF_RELIEF "mff-relief"
#endif
#ifdef CHAMPLAIN_HAS_MEMPHIS
+/**
+ * CHAMPLAIN_MAP_SOURCE_MEMPHIS_LOCAL:
+ *
+ * OpenStreetMap Memphis Local Map
+ */
#define CHAMPLAIN_MAP_SOURCE_MEMPHIS_LOCAL "memphis-local"
+/**
+ * CHAMPLAIN_MAP_SOURCE_MEMPHIS_NETWORK:
+ *
+ * OpenStreetMap Memphis Network Map
+ */
#define CHAMPLAIN_MAP_SOURCE_MEMPHIS_NETWORK "memphis-network"
#endif
diff --git a/champlain/champlain-map-source.c b/champlain/champlain-map-source.c
index 6320750..28f7367 100644
--- a/champlain/champlain-map-source.c
+++ b/champlain/champlain-map-source.c
@@ -30,7 +30,7 @@
*
* Apart from being a base class of all map sources, #ChamplainMapSource
* also supports cooperation of multiple map sources by arranging them into
- * chains. Every map source has the #ChamplainMapSource::next-source property
+ * chains. Every map source has the #ChamplainMapSource:next-source property
* that determines the next map source in the chain. When a function of
* a #ChamplainMapSource object is invoked, the map source may decide to
* delegate the work to the next map source in the chain by invoking the
diff --git a/champlain/champlain-map-source.h b/champlain/champlain-map-source.h
index 62ca090..4300388 100644
--- a/champlain/champlain-map-source.h
+++ b/champlain/champlain-map-source.h
@@ -39,6 +39,12 @@ typedef struct _ChamplainMapSourcePrivate ChamplainMapSourcePrivate;
typedef struct _ChamplainMapSourceClass ChamplainMapSourceClass;
+/**
+ * ChamplainMapProjection:
+ * @CHAMPLAIN_MAP_PROJECTION_MERCATOR: Currently the only supported projection
+ *
+ * Projections supported by the library.
+ */
typedef enum
{
CHAMPLAIN_MAP_PROJECTION_MERCATOR
diff --git a/champlain/champlain-marker.c b/champlain/champlain-marker.c
index 116562f..e3b6489 100644
--- a/champlain/champlain-marker.c
+++ b/champlain/champlain-marker.c
@@ -113,10 +113,9 @@ G_DEFINE_TYPE (ChamplainMarker, champlain_marker, CHAMPLAIN_TYPE_BASE_MARKER);
static void draw_marker (ChamplainMarker *marker);
/**
- * champlain_marker_set_hightlight_color:
+ * champlain_marker_set_highlight_color:
* @color: a #ClutterColor
*
- *
* Changes the highlight color, this is to ensure a better integration with
* the desktop, this is automatically done by GtkChamplainEmbed.
*
@@ -132,7 +131,9 @@ champlain_marker_set_highlight_color (ClutterColor *color)
}
/**
- * champlain_marker_get_hightlight_color:
+ * champlain_marker_get_highlight_color:
+ *
+ * Gets the highlight color.
*
* Returns: the highlight color. Should not be freed.
*
@@ -145,10 +146,9 @@ champlain_marker_get_highlight_color ()
}
/**
- * champlain_marker_set_hightlight_text_color:
+ * champlain_marker_set_highlight_text_color:
* @color: a #ClutterColor
*
- *
* Changes the highlight text color, this is to ensure a better integration with
* the desktop, this is automatically done by GtkChamplainEmbed.
*
@@ -164,7 +164,9 @@ champlain_marker_set_highlight_text_color (ClutterColor *color)
}
/**
- * champlain_marker_get_hightlight_text_color:
+ * champlain_marker_get_highlight_text_color:
+ *
+ * Gets the highlight text color.
*
* Returns: the highlight text color. Should not be freed.
*
@@ -821,6 +823,8 @@ champlain_marker_init (ChamplainMarker *marker)
/**
* champlain_marker_new:
*
+ * Creates a new instance of #ChamplainMarker.
+ *
* Returns: a new #ChamplainMarker ready to be used as a #ClutterActor.
*
* Since: 0.2
@@ -838,6 +842,8 @@ champlain_marker_new (void)
* @text_color: a #ClutterColor, the color of the text, can be NULL
* @marker_color: a #ClutterColor, the color of the marker, can be NULL
*
+ * Creates a new instance of #ChamplainMarker with text value.
+ *
* Returns: a new #ChamplainMarker with a drawn marker containing the given text.
*
* Since: 0.2
@@ -868,6 +874,8 @@ champlain_marker_new_with_text (const gchar *text,
* champlain_marker_new_with_image:
* @actor: The actor of the image.
*
+ * Creates a new instance of #ChamplainMarker with image.
+ *
* Returns: a new #ChamplainMarker with a drawn marker containing the given
* image.
*
@@ -890,6 +898,8 @@ champlain_marker_new_with_image (ClutterActor *actor)
* @filename: The filename of the image.
* @error: Return location for an error.
*
+ * Creates a new instance of #ChamplainMarker with image loaded from file.
+ *
* Returns: a new #ChamplainMarker with a drawn marker containing the given
* image.
*
@@ -918,6 +928,8 @@ champlain_marker_new_from_file (const gchar *filename,
* @text: The text
* @actor: The image
*
+ * Creates a new instance of #ChamplainMarker consisting of a custom #ClutterActor.
+ *
* Returns: a new #ChamplainMarker with a drawn marker containing the given
* image.
*
@@ -1256,6 +1268,8 @@ champlain_marker_set_draw_background (ChamplainMarker *marker,
* champlain_marker_get_image:
* @marker: The marker
*
+ * Get the marker's image.
+ *
* Returns: the marker's image.
*
* Since: 0.4
@@ -1272,6 +1286,8 @@ champlain_marker_get_image (ChamplainMarker *marker)
* champlain_marker_get_use_markup:
* @marker: The marker
*
+ * Check whether the marker uses markup.
+ *
* Returns: if the marker's text contains markup.
*
* Since: 0.4
@@ -1288,6 +1304,8 @@ champlain_marker_get_use_markup (ChamplainMarker *marker)
* champlain_marker_get_text:
* @marker: The marker
*
+ * Get the marker's text.
+ *
* Returns: the marker's text.
*
* Since: 0.4
@@ -1304,6 +1322,8 @@ champlain_marker_get_text (ChamplainMarker *marker)
* champlain_marker_get_alignment:
* @marker: The marker
*
+ * Get the marker's text alignment.
+ *
* Returns: the marker's text alignment.
*
* Since: 0.4
@@ -1320,6 +1340,8 @@ champlain_marker_get_alignment (ChamplainMarker *marker)
* champlain_marker_get_color:
* @marker: The marker
*
+ * Gets the marker's color.
+ *
* Returns: the marker's color.
*
* Since: 0.4
@@ -1336,6 +1358,8 @@ champlain_marker_get_color (ChamplainMarker *marker)
* champlain_marker_get_text_color:
* @marker: The marker
*
+ * Gets the marker's text color.
+ *
* Returns: the marker's text color.
*
* Since: 0.4
@@ -1352,6 +1376,8 @@ champlain_marker_get_text_color (ChamplainMarker *marker)
* champlain_marker_get_font_name:
* @marker: The marker
*
+ * Gets the marker's font name.
+ *
* Returns: the marker's font name.
*
* Since: 0.4
@@ -1368,6 +1394,8 @@ champlain_marker_get_font_name (ChamplainMarker *marker)
* champlain_marker_get_wrap:
* @marker: The marker
*
+ * Check whether the marker text wraps.
+ *
* Returns: if the marker's text wraps.
*
* Since: 0.4
@@ -1384,6 +1412,8 @@ champlain_marker_get_wrap (ChamplainMarker *marker)
* champlain_marker_get_wrap_mode:
* @marker: The marker
*
+ * Get the marker's text wrap mode.
+ *
* Returns: the marker's text wrap mode.
*
* Since: 0.4
@@ -1400,6 +1430,8 @@ champlain_marker_get_wrap_mode (ChamplainMarker *marker)
* champlain_marker_get_ellipsize:
* @marker: The marker
*
+ * Get the marker's text ellipsize mode.
+ *
* Returns: the marker's text ellipsize mode.
*
* Since: 0.4
@@ -1416,7 +1448,9 @@ champlain_marker_get_ellipsize (ChamplainMarker *marker)
* champlain_marker_get_single_line_mode:
* @marker: The marker
*
- * Returns: the marker's text single side mode.
+ * Checks the marker's single line mode.
+ *
+ * Returns: the marker's text single line mode.
*
* Since: 0.4
*/
@@ -1432,6 +1466,8 @@ champlain_marker_get_single_line_mode (ChamplainMarker *marker)
* champlain_marker_get_draw_background:
* @marker: The marker
*
+ * Checks whether the marker has a background.
+ *
* Returns: if the marker's has a background.
*
* Since: 0.4
diff --git a/champlain/champlain-memphis-tile-source.c b/champlain/champlain-memphis-tile-source.c
index d87e104..f2790dd 100644
--- a/champlain/champlain-memphis-tile-source.c
+++ b/champlain/champlain-memphis-tile-source.c
@@ -261,6 +261,8 @@ champlain_memphis_tile_source_init (ChamplainMemphisTileSource *tile_source)
* @projection: the map source's projection
* @map_data_source: a #ChamplainMapDataSource
*
+ * Creates a new instance of ChamplainMemphisTileSource.
+ *
* Returns: a new ChamplainMemphisTileSource.
*
* Since: 0.6
@@ -608,6 +610,8 @@ champlain_memphis_tile_source_set_map_data_source (
* champlain_memphis_tile_source_get_map_data_source:
* @tile_source: a #ChamplainMemphisTileSource
*
+ * Gets the assigned #ChamplainMapDataSource.
+ *
* Returns: the #ChamplainMapDataSource.
*
* Since: 0.6
@@ -625,6 +629,8 @@ champlain_memphis_tile_source_get_map_data_source (
* champlain_memphis_tile_source_get_background_color:
* @tile_source: a #ChamplainMemphisTileSource
*
+ * Gets the background color of the map.
+ *
* Returns: the background color of the map as a newly-allocated
* #ClutterColor.
*
@@ -703,6 +709,8 @@ champlain_memphis_tile_source_set_rule (ChamplainMemphisTileSource *tile_source,
* @tile_source: a #ChamplainMemphisTileSource
* @id: an id string
*
+ * Gets the requested #MemphisRule.
+ *
* Returns: the requested #MemphisRule or NULL if none is found.
*
* Since: 0.6
@@ -727,6 +735,8 @@ champlain_memphis_tile_source_get_rule (ChamplainMemphisTileSource *tile_source,
* champlain_memphis_tile_source_get_rule_ids:
* @tile_source: a #ChamplainMemphisTileSource
*
+ * Get a list of rule id's.
+ *
* Returns: a #GList of id strings of the form:
* key1|key2|...|keyN:value1|value2|...|valueM
*
diff --git a/champlain/champlain-network-map-data-source.c b/champlain/champlain-network-map-data-source.c
index 6a9bb47..ad65871 100644
--- a/champlain/champlain-network-map-data-source.c
+++ b/champlain/champlain-network-map-data-source.c
@@ -18,7 +18,7 @@
/**
* SECTION:champlain-network-map-data-source
- * @short_description: Downloads map data for #ChamplainMemphisMapSource.
+ * @short_description: Downloads map data for #ChamplainMemphisTileSource.
*
* This map data source downloads the map data from an OpenStreetMap API
* server. It supports protocol version 0.5 and 0.6.
@@ -220,6 +220,8 @@ champlain_network_map_data_source_init (ChamplainNetworkMapDataSource *self)
/**
* champlain_network_map_data_source_new:
*
+ * Creates an instance of #ChamplainNetworkMapDataSource.
+ *
* Returns: a new #ChamplainNetworkMapDataSource
*
* Since: 0.6
@@ -348,6 +350,8 @@ champlain_network_map_data_source_load_map_data (
* champlain_network_map_data_source_get_api_uri:
* @map_data_source: a #ChamplainNetworkMapDataSource
*
+ * Gets the URI of the API server.
+ *
* Returns: the URI of the API server.
*
* Since: 0.6
diff --git a/champlain/champlain-network-tile-source.c b/champlain/champlain-network-tile-source.c
index 9910c19..cc82831 100644
--- a/champlain/champlain-network-tile-source.c
+++ b/champlain/champlain-network-tile-source.c
@@ -641,6 +641,29 @@ finish:
g_object_unref (map_source);
}
+static gchar *
+get_modified_time_string (ChamplainTile *tile)
+{
+ const GTimeVal *time;
+ g_return_val_if_fail (CHAMPLAIN_TILE (tile), NULL);
+
+ time = champlain_tile_get_modified_time(tile);
+
+ if (time == NULL)
+ return NULL;
+
+ struct tm *other_time = gmtime (&time->tv_sec);
+ char value [100];
+
+#ifdef G_OS_WIN32
+ strftime (value, 100, "%a, %d %b %Y %H:%M:%S %Z", other_time);
+#else
+ strftime (value, 100, "%a, %d %b %Y %T %Z", other_time);
+#endif
+
+ return g_strdup (value);
+}
+
static void
fill_tile (ChamplainMapSource *map_source,
ChamplainTile *tile)
@@ -669,7 +692,7 @@ fill_tile (ChamplainMapSource *map_source,
/* validate tile */
const gchar *etag = champlain_tile_get_etag (tile);
- gchar *date = champlain_tile_get_modified_time_string (tile);
+ gchar *date = get_modified_time_string (tile);
/* If an etag is available, only use it.
* OSM servers seems to send now as the modified time for all tiles
diff --git a/champlain/champlain-point.c b/champlain/champlain-point.c
index ed0ed3c..37cd303 100644
--- a/champlain/champlain-point.c
+++ b/champlain/champlain-point.c
@@ -21,7 +21,10 @@
/**
* SECTION:champlain-point
- * @short_description: A base struct to store a latitude and longitude
+ * @short_description: A base struct to store a latitude and longitude.
+ *
+ * A base struct to store a latitude and longitude.
+ *
*/
#include "champlain-point.h"
@@ -82,6 +85,8 @@ champlain_point_free (ChamplainPoint *point)
* @lat: the latitude
* @lon: the longitude
*
+ * Creates an instance of #ChamplainPoint.
+ *
* Return value: a newly allocated #ChamplainPoint to be freed with #champlain_point_free
*
* Since: 0.4
diff --git a/champlain/champlain-point.h b/champlain/champlain-point.h
index 06a2083..4784aae 100644
--- a/champlain/champlain-point.h
+++ b/champlain/champlain-point.h
@@ -27,6 +27,13 @@
typedef struct _ChamplainPoint ChamplainPoint;
+/**
+ * ChamplainPoint:
+ * @lat: latitude
+ * @lon: longitude
+ *
+ * A base struct to store a latitude and longitude.
+ */
struct _ChamplainPoint
{
double lat;
diff --git a/champlain/champlain-polygon.c b/champlain/champlain-polygon.c
index f2c4a69..6f3dded 100644
--- a/champlain/champlain-polygon.c
+++ b/champlain/champlain-polygon.c
@@ -27,7 +27,7 @@
#include "champlain-polygon.h"
-#include "champlain-defines.h"
+#include "champlain-private.h"
#include "champlain-map-source.h"
#include <clutter/clutter.h>
@@ -320,6 +320,8 @@ champlain_polygon_init (ChamplainPolygon *polygon)
/**
* champlain_polygon_new:
*
+ * Create an instance of #ChamplainPolygon.
+ *
* Returns: a new empty #ChamplainPolygon
*
* Since: 0.4
@@ -439,6 +441,8 @@ champlain_polygon_clear_points (ChamplainPolygon *polygon)
* champlain_polygon_get_points:
* @polygon: The polygon
*
+ * Gets a list of polygon points.
+ *
* Returns: a list of all points from the polygon, it shouldn't be freed.
*
* Since: 0.4
@@ -480,7 +484,7 @@ champlain_polygon_set_fill_color (ChamplainPolygon *polygon,
}
/**
- * champlain_polygon_set_stoke_color:
+ * champlain_polygon_set_stroke_color:
* @polygon: The polygon
* @color: The polygon's stroke color or NULL to reset to the
* default color. The color parameter is copied.
@@ -508,9 +512,11 @@ champlain_polygon_set_stroke_color (ChamplainPolygon *polygon,
}
/**
- * champlain_polygon_get_color:
+ * champlain_polygon_get_fill_color:
* @polygon: The polygon
*
+ * Gets the polygon's fill color.
+ *
* Returns: the polygon's fill color.
*
* Since: 0.4
@@ -527,6 +533,8 @@ champlain_polygon_get_fill_color (ChamplainPolygon *polygon)
* champlain_polygon_get_stroke_color:
* @polygon: The polygon
*
+ * Gets the polygon's stroke color.
+ *
* Returns: the polygon's stroke color.
*
* Since: 0.4
@@ -562,6 +570,8 @@ champlain_polygon_set_stroke (ChamplainPolygon *polygon,
* champlain_polygon_get_stroke:
* @polygon: The polygon
*
+ * Checks whether the polygon has a stroke.
+ *
* Returns: TRUE if the polygon has a stroke, FALSE otherwise.
*
* Since: 0.4
@@ -597,6 +607,8 @@ champlain_polygon_set_fill (ChamplainPolygon *polygon,
* champlain_polygon_get_fill:
* @polygon: The polygon
*
+ * Checks whether the polygon is filled.
+ *
* Returns: TRUE if the polygon is filled, FALSE otherwise.
*
* Since: 0.4
@@ -632,6 +644,8 @@ champlain_polygon_set_stroke_width (ChamplainPolygon *polygon,
* champlain_polygon_get_stroke_width:
* @polygon: The polygon
*
+ * Gets the width of the stroke.
+ *
* Returns: the width of the stroke
*
* Since: 0.4
@@ -668,6 +682,8 @@ champlain_polygon_set_mark_points (ChamplainPolygon *polygon,
* champlain_polygon_get_mark_points:
* @polygon: The polygon
*
+ * Checks whether the polygon points are marked.
+ *
* Returns: wether points in polygon gets marked for extra visibility.
*
* Since: 0.4.3
diff --git a/champlain/champlain-private.h b/champlain/champlain-private.h
index d26d3c0..5f2d317 100644
--- a/champlain/champlain-private.h
+++ b/champlain/champlain-private.h
@@ -42,4 +42,12 @@ typedef struct
gint height;
} ChamplainRectangle;
+#define CHAMPLAIN_PARAM_READABLE \
+ (G_PARAM_READABLE | \
+ G_PARAM_STATIC_NICK | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB)
+
+#define CHAMPLAIN_PARAM_READWRITE \
+ (G_PARAM_READABLE | G_PARAM_WRITABLE | \
+ G_PARAM_STATIC_NICK | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB)
+
#endif
diff --git a/champlain/champlain-selection-layer.c b/champlain/champlain-selection-layer.c
index dfb54a2..b7a71b5 100644
--- a/champlain/champlain-selection-layer.c
+++ b/champlain/champlain-selection-layer.c
@@ -31,7 +31,7 @@
#include "champlain-selection-layer.h"
-#include "champlain-defines.h"
+#include "champlain-private.h"
#include "champlain-base-marker.h"
#include "champlain-enum-types.h"
@@ -111,7 +111,7 @@ champlain_selection_layer_class_init (ChamplainSelectionLayerClass *klass)
object_class->set_property = champlain_selection_layer_set_property;
/**
- * ChamplainView:selection-mode:
+ * ChamplainSelectionLayer:selection-mode:
*
* Determines the type of selection that will be performed.
*
@@ -255,6 +255,8 @@ champlain_selection_layer_init (ChamplainSelectionLayer *self)
/**
* champlain_selection_layer_new:
*
+ * Creates an instance of #ChamplainSelectionLayer.
+ *
* Returns: a new #ChamplainSelectionLayer ready to be used as a #ClutterContainer for the markers.
*
* Since: 0.4
@@ -291,6 +293,8 @@ champlain_selection_layer_get_selected (ChamplainSelectionLayer *layer)
* champlain_selection_layer_get_selected_markers:
* @layer: a #ChamplainSelectionLayer
*
+ * Gets the list of selected markers.
+ *
* Returns: the list of selected #ChamplainBaseMarker or NULL if none is selected.
* You shouldn't free that list.
*
@@ -306,6 +310,8 @@ champlain_selection_layer_get_selected_markers (ChamplainSelectionLayer *layer)
* champlain_selection_layer_count_selected_markers:
* @layer: a #ChamplainSelectionLayer
*
+ * Gets the number of selected markers.
+ *
* Returns: the number of selected #ChamplainBaseMarker
*
* Since: 0.4
@@ -435,6 +441,8 @@ champlain_selection_layer_unselect (ChamplainSelectionLayer *layer,
* @layer: a #ChamplainSelectionLayer
* @marker: a #ChamplainBaseMarker
*
+ * Checks whether the marker is selected.
+ *
* Returns: whether the marker is selected or not.
*
* Since: 0.4
@@ -486,6 +494,8 @@ champlain_selection_layer_set_selection_mode (ChamplainSelectionLayer *layer,
* champlain_selection_layer_get_selection_mode:
* @layer: a #ChamplainSelectionLayer
*
+ * Gets the selection mode of the layer.
+ *
* Returns: the selection mode of the layer.
*
* Since: 0.4
diff --git a/champlain/champlain-tile.c b/champlain/champlain-tile.c
index 02c7ad6..1be8277 100644
--- a/champlain/champlain-tile.c
+++ b/champlain/champlain-tile.c
@@ -326,6 +326,8 @@ champlain_tile_init (ChamplainTile *self)
/**
* champlain_tile_new:
*
+ * Creates an instance of #ChamplainTile.
+ *
* Returns: a new #ChamplainTile
*
* Since: 0.4
@@ -340,6 +342,8 @@ champlain_tile_new (void)
* champlain_tile_get_x:
* @self: the #ChamplainTile
*
+ * Gets the tile's x position.
+ *
* Returns: the tile's x position
*
* Since: 0.4
@@ -356,6 +360,8 @@ champlain_tile_get_x (ChamplainTile *self)
* champlain_tile_get_y:
* @self: the #ChamplainTile
*
+ * Gets the tile's y position.
+ *
* Returns: the tile's y position
*
* Since: 0.4
@@ -372,6 +378,8 @@ champlain_tile_get_y (ChamplainTile *self)
* champlain_tile_get_zoom_level:
* @self: the #ChamplainTile
*
+ * Gets the tile's zoom level.
+ *
* Returns: the tile's zoom level
*
* Since: 0.4
@@ -388,6 +396,8 @@ champlain_tile_get_zoom_level (ChamplainTile *self)
* champlain_tile_get_size:
* @self: the #ChamplainTile
*
+ * Gets the tile's size.
+ *
* Returns: the tile's size in pixels
*
* Since: 0.4
@@ -404,6 +414,8 @@ champlain_tile_get_size (ChamplainTile *self)
* champlain_tile_get_state:
* @self: the #ChamplainTile
*
+ * Gets the current state of tile loading.
+ *
* Returns: the tile's #ChamplainState
*
* Since: 0.4
@@ -563,6 +575,8 @@ champlain_tile_set_state (ChamplainTile *self,
* @size: the size in pixels
* @zoom_level: the zoom level
*
+ * Creates an instance of #ChamplainTile.
+ *
* Returns: a #ChamplainTile
*
* Since: 0.4
@@ -581,6 +595,8 @@ champlain_tile_new_full (gint x,
* champlain_tile_get_modified_time:
* @self: the #ChamplainTile
*
+ * Gets the tile's last modified time.
+ *
* Returns: the tile's last modified time
*
* Since: 0.4
@@ -616,39 +632,11 @@ champlain_tile_set_modified_time (ChamplainTile *self,
}
/**
- * champlain_tile_get_modified_time_string:
- * @self: the #ChamplainTile
- *
- * Returns: the tile's modified time as a string (formated as per RFC 1123)
- *
- * Since: 0.4
- */
-gchar *
-champlain_tile_get_modified_time_string (ChamplainTile *self)
-{
- g_return_val_if_fail (CHAMPLAIN_TILE (self), NULL);
-
- ChamplainTilePrivate *priv = self->priv;
-
- if (priv->modified_time == NULL)
- return NULL;
-
- struct tm *other_time = gmtime (&priv->modified_time->tv_sec);
- char value [100];
-
-#ifdef G_OS_WIN32
- strftime (value, 100, "%a, %d %b %Y %H:%M:%S %Z", other_time);
-#else
- strftime (value, 100, "%a, %d %b %Y %T %Z", other_time);
-#endif
-
- return g_strdup (value);
-}
-
-/**
* champlain_tile_get_etag:
* @self: the #ChamplainTile
*
+ * Gets the tile's ETag.
+ *
* Returns: the tile's ETag
*
* Since: 0.4
@@ -714,6 +702,8 @@ champlain_tile_set_content (ChamplainTile *self,
* champlain_tile_get_content:
* @self: the #ChamplainTile
*
+ * Gets the tile's content actor.
+ *
* Returns: the tile's content, this actor will change each time the tile's content changes.
* You should not unref this content, it is owned by the tile.
*
@@ -731,6 +721,8 @@ champlain_tile_get_content (ChamplainTile *self)
* champlain_tile_get_fade_in:
* @self: the #ChamplainTile
*
+ * Checks whether the tile should fade in.
+ *
* Returns: the return value determines whether the tile should fade in when loading.
*
* Since: 0.6
diff --git a/champlain/champlain-tile.h b/champlain/champlain-tile.h
index 23e1f2b..08a14e7 100644
--- a/champlain/champlain-tile.h
+++ b/champlain/champlain-tile.h
@@ -45,6 +45,21 @@ G_BEGIN_DECLS
typedef struct _ChamplainTilePrivate ChamplainTilePrivate;
+/**
+ * ChamplainState:
+ * @CHAMPLAIN_STATE_NONE: Initial or undefined state
+ * @CHAMPLAIN_STATE_LOADING: Tile is loading
+ * @CHAMPLAIN_STATE_DONE: Tile loading finished
+ *
+ * Tile loading state.
+ */
+typedef enum
+{
+ CHAMPLAIN_STATE_NONE,
+ CHAMPLAIN_STATE_LOADING,
+ CHAMPLAIN_STATE_DONE
+} ChamplainState;
+
typedef struct _ChamplainTile ChamplainTile;
typedef struct _ChamplainTileClass ChamplainTileClass;
@@ -73,7 +88,6 @@ guint champlain_tile_get_size (ChamplainTile *self);
ChamplainState champlain_tile_get_state (ChamplainTile *self);
ClutterActor * champlain_tile_get_content (ChamplainTile *self);
const GTimeVal * champlain_tile_get_modified_time (ChamplainTile *self);
-gchar * champlain_tile_get_modified_time_string (ChamplainTile *self);
const gchar * champlain_tile_get_etag (ChamplainTile *self);
gboolean champlain_tile_get_fade_in (ChamplainTile *self);
diff --git a/champlain/champlain-view.c b/champlain/champlain-view.c
index 0896b9b..1114e69 100644
--- a/champlain/champlain-view.c
+++ b/champlain/champlain-view.c
@@ -108,6 +108,11 @@ static guint signals[LAST_SIGNAL] = { 0, };
level < champlain_map_source_get_min_zoom_level (priv->map_source) || \
level > champlain_map_source_get_max_zoom_level (priv->map_source))
+#define CHAMPLAIN_MIN_LAT -90
+#define CHAMPLAIN_MAX_LAT 90
+#define CHAMPLAIN_MIN_LONG -180
+#define CHAMPLAIN_MAX_LONG 180
+
/* Between state values for go_to */
typedef struct {
ChamplainView *view;
@@ -1707,6 +1712,8 @@ finger_scroll_key_press_cb (ClutterActor *actor,
/**
* champlain_view_new:
*
+ * Creates an instance of #ChamplainView.
+ *
* Returns: a new #ChamplainView ready to be used as a #ClutterActor.
*
* Since: 0.4
@@ -2125,6 +2132,8 @@ champlain_view_remove_layer (ChamplainView *view,
* @lat: a variable where to put the latitude of the event
* @lon: a variable where to put the longitude of the event
*
+ * Gets coordinates from button-press-event and button-release-event signals.
+ *
* Returns: the latitude, longitude coordinates for the given ClutterEvent.
*
* Since: 0.2.8
@@ -2188,8 +2197,10 @@ champlain_view_get_coords_from_event (ChamplainView *view,
* @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.
+ * Gets latitude and longitude for the given x, y position in
+ * the view. Use if you get coordinates from GtkEvents for example.
+ *
+ * Returns: TRUE when successful.
*
* Since: 0.4
*/
@@ -2773,7 +2784,7 @@ champlain_view_ensure_visible (ChamplainView *view,
/**
* champlain_view_ensure_markers_visible:
* @view: a #ChamplainView
- * @markers: a NULL terminated array of #ChamplainMarkers
+ * @markers: a NULL terminated array of #ChamplainMarker elements
* @animate: a #gboolean
*
* Changes the map's zoom level and center to make sure those markers are
@@ -2877,6 +2888,8 @@ view_set_zoom_level_at (ChamplainView *view,
* champlain_view_get_zoom_level:
* @view: The view
*
+ * Gets the view's current zoom level.
+ *
* Returns: the view's current zoom level.
*
* Since: 0.4
@@ -2893,7 +2906,9 @@ champlain_view_get_zoom_level (ChamplainView *view)
* champlain_view_get_min_zoom_level:
* @view: The view
*
- * Returns: the view's minimal zoom level allowed.
+ * Gets the view's minimal allowed zoom level.
+ *
+ * Returns: the view's minimal allowed zoom level.
*
* Since: 0.4
*/
@@ -2909,7 +2924,9 @@ champlain_view_get_min_zoom_level (ChamplainView *view)
* champlain_view_get_max_zoom_level:
* @view: The view
*
- * Returns: the view's maximal zoom level allowed.
+ * Gets the view's maximal allowed zoom level.
+ *
+ * Returns: the view's maximal allowed zoom level.
*
* Since: 0.4
*/
@@ -2925,6 +2942,8 @@ champlain_view_get_max_zoom_level (ChamplainView *view)
* champlain_view_get_map_source:
* @view: The view
*
+ * Gets the view's current map source.
+ *
* Returns: the view's current map source. If you need to keep a reference to the
* map source then you have to call #g_object_ref.
*
@@ -2942,6 +2961,8 @@ champlain_view_get_map_source (ChamplainView *view)
* champlain_view_get_decel_rate:
* @view: The view
*
+ * Gets the view's deceleration rate.
+ *
* Returns: the view's deceleration rate.
*
* Since: 0.4
@@ -2960,6 +2981,8 @@ champlain_view_get_decel_rate (ChamplainView *view)
* champlain_view_get_scroll_mode:
* @view: The view
*
+ * Gets the view's scroll mode behaviour.
+ *
* Returns: the view's scroll mode behaviour.
*
* Since: 0.4
@@ -2976,7 +2999,9 @@ champlain_view_get_scroll_mode (ChamplainView *view)
* champlain_view_get_keep_center_on_resize:
* @view: The view
*
- * Returns: TRUE if the view keeps the center or resize, FALSE otherwise.
+ * Checks whether to keep the center on resize
+ *
+ * Returns: TRUE if the view keeps the center on resize, FALSE otherwise.
*
* Since: 0.4
*/
@@ -2992,6 +3017,8 @@ champlain_view_get_keep_center_on_resize (ChamplainView *view)
* champlain_view_get_show_license:
* @view: The view
*
+ * Checks whether the view displays the license.
+ *
* Returns: TRUE if the view displays the license, FALSE otherwise.
*
* Since: 0.4
@@ -3008,6 +3035,8 @@ champlain_view_get_show_license (ChamplainView *view)
* champlain_view_get_license_text:
* @view: The view
*
+ * Gets the additional license text.
+ *
* Returns: the additional license text
*
* Since: 0.4.3
@@ -3025,6 +3054,8 @@ champlain_view_get_license_text (ChamplainView *view)
* champlain_view_get_show_scale:
* @view: The view
*
+ * Checks whether the view displays the scale.
+ *
* Returns: TRUE if the view displays the scale, FALSE otherwise.
*
* Since: 0.4.3
@@ -3041,6 +3072,8 @@ champlain_view_get_show_scale (ChamplainView *view)
* champlain_view_get_max_scale_width:
* @view: The view
*
+ * Gets the maximal scale width.
+ *
* Returns: The max scale width in pixels.
*
* Since: 0.4.3
@@ -3057,6 +3090,8 @@ champlain_view_get_max_scale_width (ChamplainView *view)
* champlain_view_get_scale_unit:
* @view: The view
*
+ * Gets the unit used by the scale.
+ *
* Returns: The unit used by the scale
*
* Since: 0.4.3
@@ -3073,6 +3108,8 @@ champlain_view_get_scale_unit (ChamplainView *view)
* champlain_view_get_zoom_on_double_click:
* @view: The view
*
+ * Checks whether the view zooms on double click.
+ *
* Returns: TRUE if the view zooms on double click, FALSE otherwise.
*
* Since: 0.4
diff --git a/champlain/champlain-view.h b/champlain/champlain-view.h
index f0f5348..469fe8f 100644
--- a/champlain/champlain-view.h
+++ b/champlain/champlain-view.h
@@ -56,6 +56,20 @@ typedef enum {
CHAMPLAIN_SCROLL_MODE_KINETIC
} ChamplainScrollMode;
+
+/**
+ * ChamplainUnit:
+ * @CHAMPLAIN_UNIT_KM: kilometers
+ * @CHAMPLAIN_UNIT_MILES: miles
+ *
+ * Units used by the scale.
+ */
+typedef enum
+{
+ CHAMPLAIN_UNIT_KM,
+ CHAMPLAIN_UNIT_MILES,
+} ChamplainUnit;
+
struct _ChamplainView
{
ClutterGroup group;
@@ -103,8 +117,7 @@ void champlain_view_set_map_source (ChamplainView *view,
ChamplainMapSource *map_source);
void champlain_view_set_size (ChamplainView *view,
guint width,
- guint height)
- CHAMPLAIN_OBSOLETE_API;
+ guint height);
void champlain_view_set_decel_rate (ChamplainView *view,
gdouble rate);
void champlain_view_set_scroll_mode (ChamplainView *view,
diff --git a/champlain/champlain.h b/champlain/champlain.h
index 05d1e45..bbd57f1 100644
--- a/champlain/champlain.h
+++ b/champlain/champlain.h
@@ -21,11 +21,6 @@
#define __CHAMPLAIN_CHAMPLAIN_H_INSIDE__
-#define CHAMPLAIN_MIN_LAT -90
-#define CHAMPLAIN_MAX_LAT 90
-#define CHAMPLAIN_MIN_LONG -180
-#define CHAMPLAIN_MAX_LONG 180
-
#include <glib.h>
#include "champlain/champlain-features.h"
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index b2b8959..e003604 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -24,7 +24,7 @@ SCANGOBJ_OPTIONS=--type-init-func 'g_type_init(); g_thread_init(NULL)'
# Extra options to supply to gtkdoc-scan.
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
-SCAN_OPTIONS=--deprecated-guards="CHAMPLAIN_OBSOLETE_API" --rebuild-types
+SCAN_OPTIONS=--rebuild-types
# Extra options to supply to gtkdoc-mkdb.
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
@@ -40,9 +40,9 @@ MKHTML_OPTIONS=
# Extra options to supply to gtkdoc-fixref. Not normally needed.
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
FIXXREF_OPTIONS= \
- --extra-dir=$(PREFIX)/share/gtk-doc/html/gobject \
- --extra-dir=$(PREFIX)/share/gtk-doc/html/glib \
- --extra-dir=$(PREFIX)/share/gtk-doc/html/clutter
+ --extra-dir=$(PREFIX)/share/gtk-doc/html/gobject \
+ --extra-dir=$(PREFIX)/share/gtk-doc/html/glib \
+ --extra-dir=$(PREFIX)/share/gtk-doc/html/clutter
# Used for dependencies. The docs will be rebuilt if any of these change.
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
@@ -56,8 +56,8 @@ EXTRA_HFILES=
# Header files to ignore when scanning. Use base file name, no paths
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES= champlain-debug.h champlain-defines.h champlain-enum-types.h champlain-private.h \
- champlain.h
+IGNORE_HFILES= champlain-debug.h champlain-enum-types.h champlain-private.h \
+ champlain.h champlain-marshal.h champlain-defines.h champlain-features.h
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
@@ -76,7 +76,7 @@ expand_content_files=
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
# signals and properties.
# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
-# e.g.
+# e.g.
GTKDOC_CFLAGS=$(DEPS_CFLAGS) -I$(top_srcdir) -I$(top_builddir)
GTKDOC_LIBS=$(DEPS_LIBS) $(top_builddir)/champlain/libchamplain-0.5.la
diff --git a/docs/reference/libchamplain-docs.sgml b/docs/reference/libchamplain-docs.sgml
index 4f141cd..39cbd59 100644
--- a/docs/reference/libchamplain-docs.sgml
+++ b/docs/reference/libchamplain-docs.sgml
@@ -8,11 +8,13 @@
<title>libchamplain Reference Manual</title>
<releaseinfo>
for libchamplain &version;
+ <para>
The latest version of this documentation can be found on-line at
<ulink role="online-location" url="http://projects.gnome.org/libchamplain/";>http://projects.gnome.org/libchamplain/</ulink>.
+ </para>
</releaseinfo>
<copyright>
- <year>2008, 2009</year>
+ <year>2008-2010</year>
<holder>libchamplain contributors</holder>
</copyright>
<legalnotice>
@@ -70,7 +72,6 @@
</chapter>
<chapter>
<title>IV. Utility API Reference</title>
- <xi:include href="xml/champlain.xml"/>
<xi:include href="xml/champlain-version.xml"/>
</chapter>
<index>
diff --git a/docs/reference/libchamplain-sections.txt b/docs/reference/libchamplain-sections.txt
index afe9237..5dd08c2 100644
--- a/docs/reference/libchamplain-sections.txt
+++ b/docs/reference/libchamplain-sections.txt
@@ -29,14 +29,27 @@ CHAMPLAIN_MAP_SOURCE_CLASS
CHAMPLAIN_IS_MAP_SOURCE_CLASS
CHAMPLAIN_MAP_SOURCE_GET_CLASS
<SUBSECTION Private>
-ChamplainMapSourceClass
ChamplainMapSource
+ChamplainMapSourceClass
+ChamplainMapSourcePrivate
+</SECTION>
+
+<SECTION>
+<FILE>champlain-map-source-desc</FILE>
+<TITLE>ChamplainMapSourceDesc</TITLE>
+champlain_map_source_desc_copy
+champlain_map_source_desc_free
+champlain_map_source_desc_new
+<SUBSECTION Standard>
+champlain_map_source_desc_get_type
+CHAMPLAIN_MAP_SOURCE_DESC
+CHAMPLAIN_TYPE_MAP_SOURCE_DESC
+CHAMPLAIN_MAP_SOURCE_CONSTRUCTOR
</SECTION>
<SECTION>
<FILE>champlain-marker</FILE>
<TITLE>ChamplainMarker</TITLE>
-champlain_marker_set_highlight_color
champlain_marker_new
champlain_marker_new_with_text
champlain_marker_new_with_image
@@ -67,6 +80,11 @@ champlain_marker_set_ellipsize
champlain_marker_get_ellipsize
champlain_marker_set_draw_background
champlain_marker_get_draw_background
+champlain_marker_set_highlight_text_color
+champlain_marker_get_highlight_text_color
+champlain_marker_set_highlight_color
+champlain_marker_get_highlight_color
+champlain_marker_queue_redraw
<SUBSECTION Standard>
CHAMPLAIN_MARKER
CHAMPLAIN_IS_MARKER
@@ -78,7 +96,6 @@ CHAMPLAIN_MARKER_GET_CLASS
<SUBSECTION Private>
ChamplainMarkerClass
ChamplainMarkerPrivate
-ChamplainMarker
</SECTION>
<SECTION>
@@ -87,6 +104,8 @@ ChamplainMarker
ChamplainBaseMarker
champlain_base_marker_new
champlain_base_marker_set_position
+champlain_base_marker_get_latitude
+champlain_base_marker_get_longitude
champlain_base_marker_animate_in
champlain_base_marker_animate_in_with_delay
champlain_base_marker_animate_out
@@ -107,38 +126,10 @@ ChamplainBaseMarkerPrivate
</SECTION>
<SECTION>
-<FILE>champlain-zoom-level</FILE>
-<TITLE>ChamplainZoomLevel</TITLE>
-ChamplainZoomLevel
-champlain_zoom_level_new
-champlain_zoom_level_set_width
-champlain_zoom_level_get_width
-champlain_zoom_level_set_height
-champlain_zoom_level_get_height
-champlain_zoom_level_set_zoom_level
-champlain_zoom_level_get_zoom_level
-champlain_zoom_level_get_actor
-champlain_zoom_level_add_tile
-champlain_zoom_level_remove_tile
-champlain_zoom_level_tile_count
-champlain_zoom_level_get_nth_tile
-<SUBSECTION Standard>
-CHAMPLAIN_ZOOM_LEVEL
-CHAMPLAIN_IS_ZOOM_LEVEL
-CHAMPLAIN_TYPE_ZOOM_LEVEL
-champlain_zoom_level_get_type
-CHAMPLAIN_ZOOM_LEVEL_CLASS
-CHAMPLAIN_IS_ZOOM_LEVEL_CLASS
-CHAMPLAIN_ZOOM_LEVEL_GET_CLASS
-<SUBSECTION Private>
-ChamplainZoomLevelClass
-ChamplainZoomLevelPrivate
-</SECTION>
-
-<SECTION>
<FILE>champlain-view</FILE>
<TITLE>ChamplainView</TITLE>
ChamplainScrollMode
+ChamplainUnit
ChamplainView
champlain_view_new
champlain_view_center_on
@@ -190,6 +181,7 @@ CHAMPLAIN_VIEW_CLASS
CHAMPLAIN_IS_VIEW_CLASS
CHAMPLAIN_VIEW_GET_CLASS
<SUBSECTION Private>
+ChamplainViewClass
ChamplainViewPrivate
</SECTION>
@@ -214,11 +206,13 @@ CHAMPLAIN_IS_NETWORK_TILE_SOURCE_CLASS
CHAMPLAIN_NETWORK_TILE_SOURCE_GET_CLASS
<SUBSECTION Private>
ChamplainNetworkTileSourceClass
+ChamplainNetworkTileSourcePrivate
</SECTION>
<SECTION>
<FILE>champlain-tile</FILE>
<TITLE>ChamplainTile</TITLE>
+ChamplainState
ChamplainTile
champlain_tile_new
champlain_tile_new_full
@@ -227,16 +221,16 @@ champlain_tile_get_y
champlain_tile_get_zoom_level
champlain_tile_get_size
champlain_tile_get_state
-champlain_tile_get_actor
+champlain_tile_get_fade_in
champlain_tile_set_x
champlain_tile_set_y
champlain_tile_set_zoom_level
champlain_tile_set_size
champlain_tile_set_state
+champlain_tile_set_fade_in
champlain_tile_get_content
champlain_tile_get_etag
champlain_tile_get_modified_time
-champlain_tile_get_modified_time_string
champlain_tile_set_content
champlain_tile_set_etag
champlain_tile_set_modified_time
@@ -279,17 +273,6 @@ ChamplainLayerClass
</SECTION>
<SECTION>
-<FILE>champlain-private</FILE>
-<TITLE>ChamplainPrivate</TITLE>
-Map
-</SECTION>
-
-<SECTION>
-<FILE>champlain-marshal</FILE>
-<TITLE>ChamplainMarshal</TITLE>
-</SECTION>
-
-<SECTION>
<FILE>champlain-version</FILE>
<TITLE>ChamplainVersion</TITLE>
CHAMPLAIN_MAJOR_VERSION
@@ -302,61 +285,6 @@ CHAMPLAIN_CHECK_VERSION
</SECTION>
<SECTION>
-<FILE>champlain-map</FILE>
-<TITLE>ChamplainMap</TITLE>
-Map
-map_new
-map_load_visible_tiles
-map_free
-map_zoom_in
-map_zoom_out
-map_zoom_to
-map_load_level
-</SECTION>
-
-<SECTION>
-<FILE>champlain-debug</FILE>
-<TITLE>ChamplainDebug</TITLE>
-ChamplainDebugFlags
-champlain_debug_flag_is_set
-champlain_debug
-champlain_debug_set_flags
-DEBUG
-DEBUGGING
-</SECTION>
-
-<SECTION>
-<FILE>champlain-enum-types</FILE>
-<TITLE>ChamplainEnumTypes</TITLE>
-CHAMPLAIN_TYPE_STATE
-champlain_state_get_type
-CHAMPLAIN_TYPE_SCROLL_MODE
-champlain_scroll_mode_get_type
-CHAMPLAIN_TYPE_MAP_PROJECTION
-champlain_map_projection_get_type
-</SECTION>
-
-<SECTION>
-<FILE>champlain</FILE>
-<TITLE>Champlain</TITLE>
-CHAMPLAIN_MIN_LAT
-CHAMPLAIN_MAX_LAT
-CHAMPLAIN_MIN_LONG
-CHAMPLAIN_MAX_LONG
-</SECTION>
-
-<SECTION>
-<FILE>champlain-defines</FILE>
-CHAMPLAIN_API
-CHAMPLAIN_OBSOLETE_API
-ChamplainView
-ChamplainViewClass
-CHAMPLAIN_PARAM_READABLE
-CHAMPLAIN_PARAM_READWRITE
-ChamplainState
-</SECTION>
-
-<SECTION>
<FILE>champlain-point</FILE>
<TITLE>ChamplainPoint</TITLE>
ChamplainPoint
@@ -388,6 +316,7 @@ CHAMPLAIN_IS_TILE_CACHE_CLASS
CHAMPLAIN_TILE_CACHE_GET_CLASS
<SUBSECTION Private>
ChamplainTileCacheClass
+ChamplainTileCachePrivate
</SECTION>
<SECTION>
@@ -433,18 +362,21 @@ champlain_polygon_remove_point
champlain_polygon_clear_points
champlain_polygon_get_fill
champlain_polygon_get_fill_color
+champlain_polygon_get_mark_points
champlain_polygon_get_points
champlain_polygon_get_stroke
champlain_polygon_get_stroke_color
champlain_polygon_get_stroke_width
champlain_polygon_set_fill
champlain_polygon_set_fill_color
+champlain_polygon_set_mark_points
champlain_polygon_set_stroke
champlain_polygon_set_stroke_color
champlain_polygon_set_stroke_width
champlain_polygon_show
champlain_polygon_hide
<SUBSECTION Standard>
+CHAMPLAIN_POLYGON
CHAMPLAIN_IS_POLYGON
CHAMPLAIN_TYPE_POLYGON
champlain_polygon_get_type
@@ -454,6 +386,7 @@ CHAMPLAIN_POLYGON_GET_CLASS
<SUBSECTION Private>
ChamplainPolygonClass
ChamplainPolygonPrivate
+champlain_polygon_draw_polygon
</SECTION>
<SECTION>
@@ -509,6 +442,7 @@ CHAMPLAIN_IS_MEMPHIS_TILE_SOURCE_CLASS
CHAMPLAIN_MEMPHIS_TILE_SOURCE_GET_CLASS
<SUBSECTION Private>
ChamplainMemphisTileSourceClass
+ChamplainMemphisTileSourcePrivate
</SECTION>
<SECTION>
@@ -526,6 +460,7 @@ CHAMPLAIN_IS_MAP_DATA_SOURCE_CLASS
CHAMPLAIN_MAP_DATA_SOURCE_GET_CLASS
<SUBSECTION Private>
ChamplainMapDataSourceClass
+ChamplainMapDataSourcePrivate
</SECTION>
<SECTION>
@@ -544,6 +479,7 @@ CHAMPLAIN_IS_LOCAL_MAP_DATA_SOURCE_CLASS
CHAMPLAIN_LOCAL_MAP_DATA_SOURCE_GET_CLASS
<SUBSECTION Private>
ChamplainLocalMapDataSourceClass
+ChamplainLocalMapDataSourcePrivate
</SECTION>
<SECTION>
@@ -564,6 +500,7 @@ CHAMPLAIN_IS_NETWORK_MAP_DATA_SOURCE_CLASS
CHAMPLAIN_NETWORK_MAP_DATA_SOURCE_GET_CLASS
<SUBSECTION Private>
ChamplainNetworkMapDataSourceClass
+ChamplainNetworkMapDataSourcePrivate
</SECTION>
<SECTION>
@@ -597,6 +534,7 @@ CHAMPLAIN_IS_MAP_SOURCE_CHAIN_CLASS
CHAMPLAIN_MAP_SOURCE_CHAIN_GET_CLASS
<SUBSECTION Private>
ChamplainMapSourceChainClass
+ChamplainMapSourceChainPrivate
</SECTION>
<SECTION>
@@ -623,6 +561,7 @@ CHAMPLAIN_IS_TILE_SOURCE_CLASS
CHAMPLAIN_TILE_SOURCE_GET_CLASS
<SUBSECTION Private>
ChamplainTileSourceClass
+ChamplainTileSourcePrivate
</SECTION>
<SECTION>
@@ -640,6 +579,7 @@ CHAMPLAIN_IS_ERROR_TILE_SOURCE_CLASS
CHAMPLAIN_ERROR_TILE_SOURCE_GET_CLASS
<SUBSECTION Private>
ChamplainErrorTileSourceClass
+ChamplainErrorTileSourcePrivate
</SECTION>
<SECTION>
@@ -663,4 +603,5 @@ CHAMPLAIN_IS_FILE_CACHE_CLASS
CHAMPLAIN_FILE_CACHE_GET_CLASS
<SUBSECTION Private>
ChamplainFileCacheClass
+ChamplainFileCachePrivate
</SECTION>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
