[libchamplain] Update documentation of all MapDataSources



commit 650bf468e37df9245277d1034b4b8d3a7f3e959c
Author: Simon Wenner <simon wenner ch>
Date:   Sun Aug 2 00:06:00 2009 +0200

    Update documentation of all MapDataSources

 champlain/champlain-local-map-data-source.c   |   14 ++++++++++----
 champlain/champlain-map-data-source.c         |    2 +-
 champlain/champlain-network-map-data-source.c |   13 ++++++-------
 3 files changed, 17 insertions(+), 12 deletions(-)
---
diff --git a/champlain/champlain-local-map-data-source.c b/champlain/champlain-local-map-data-source.c
index d241310..f6f7b38 100644
--- a/champlain/champlain-local-map-data-source.c
+++ b/champlain/champlain-local-map-data-source.c
@@ -18,11 +18,10 @@
 
 /**
  * SECTION:champlain-local-map-data-source
- * @short_description: ChamplainLocalMapDataSource loads local data for
- *  ChamplainMemphisMapSource.
+ * @short_description: Loads local map data for #ChamplainMemphisMapSource.
  *
  * This map data source loads local <ulink role="online-location"
- *  url="http://wiki.openstreetmap.org/wiki/.osm";>
+ * url="http://wiki.openstreetmap.org/wiki/.osm";>
  * OpenStreetMap XML data files</ulink> (*.osm).
  *
  */
@@ -122,6 +121,13 @@ champlain_local_map_data_source_init (ChamplainLocalMapDataSource *self)
   priv->map = memphis_map_new ();
 }
 
+/**
+ * champlain_local_map_data_source_new:
+ *
+ * Returns: a new ChamplainLocalMapDataSource.
+ *
+ * Since: 0.6
+ */
 ChamplainLocalMapDataSource *
 champlain_local_map_data_source_new (void)
 {
@@ -130,7 +136,7 @@ champlain_local_map_data_source_new (void)
 
 /**
  * champlain_local_map_data_source_load_map_data:
- * @data_source: a #ChamplainLocalMapDataSource
+ * @map_data_source: a #ChamplainLocalMapDataSource
  * @map_path: a path to a map data file
  *
  * Loads the OpenStreetMap XML file at the given path.
diff --git a/champlain/champlain-map-data-source.c b/champlain/champlain-map-data-source.c
index a916f1f..7b22797 100644
--- a/champlain/champlain-map-data-source.c
+++ b/champlain/champlain-map-data-source.c
@@ -199,7 +199,7 @@ champlain_map_data_source_new (void)
  * champlain_map_data_source_get_map_data:
  * @data_source: a #ChamplainMapDataSource
  *
- * Returns the #MemphisMap of the data source.
+ * Returns the #MemphisMap of the data source or NULL.
  *
  * Since: 0.6
  */
diff --git a/champlain/champlain-network-map-data-source.c b/champlain/champlain-network-map-data-source.c
index 382e697..7a1c62c 100644
--- a/champlain/champlain-network-map-data-source.c
+++ b/champlain/champlain-network-map-data-source.c
@@ -18,8 +18,7 @@
 
 /**
  * SECTION:champlain-network-map-data-source
- * @short_description: ChamplainNetworkMapDataSource downloads data for
- *  ChamplainMemphisMapSource.
+ * @short_description: Downloads map data for #ChamplainMemphisMapSource.
  *
  * This map data source downloads the map data from an OpenStreetMap API
  * server. It supports protocol version 0.5 and 0.6.
@@ -270,9 +269,9 @@ load_map_data_cb (SoupSession *session, SoupMessage *msg,
 
 /**
  * champlain_network_map_data_source_load_map_data:
- * @source: a #ChamplainNetworkMapDataSource
+ * @map_data_source: a #ChamplainNetworkMapDataSource
  * @bound_left: the left bound in degree
- * @bound_buttom: the lower bound in degree
+ * @bound_bottom: the lower bound in degree
  * @bound_right: the right bound in degree
  * @bound_top: the upper bound in degree
  *
@@ -281,7 +280,7 @@ load_map_data_cb (SoupSession *session, SoupMessage *msg,
  * limitations on the maximum number of nodes that can be requested.
  *
  * For details, see: <ulink role="online-location"
- *  url="http://api.openstreetmap.org/api/capabilities";>
+ * url="http://api.openstreetmap.org/api/capabilities";>
  * http://api.openstreetmap.org/api/capabilities</ulink>
  *
  * Since: 0.6
@@ -334,7 +333,7 @@ champlain_network_map_data_source_load_map_data (
 
 /**
  * champlain_network_map_data_source_get_api_uri:
- * @source: a #ChamplainNetworkMapDataSource
+ * @map_data_source: a #ChamplainNetworkMapDataSource
  *
  * Returns the URI of the API server.
  *
@@ -353,7 +352,7 @@ champlain_network_map_data_source_get_api_uri (
 
 /**
  * champlain_network_map_data_source_set_api_uri:
- * @source: a #ChamplainNetworkMapDataSource
+ * @map_data_source: a #ChamplainNetworkMapDataSource
  * @api_uri: an URI of an API server
  *
  * Sets the URI of the API server.



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