From: Kaj-Michael Lang <milang@tal.org>
Date: Thu, 21 Aug 2008 14:26:42 +0000 (+0300)
Subject: Just some fixes to comments
X-Git-Url: https://err.no/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=cb026a64c07bcc4b82cded321eabf78678d3e141;p=mapper

Just some fixes to comments
---

diff --git a/libs/libgtkmap/gtkmap.c b/libs/libgtkmap/gtkmap.c
index 2de1fb6..9bf55a0 100644
--- a/libs/libgtkmap/gtkmap.c
+++ b/libs/libgtkmap/gtkmap.c
@@ -24,7 +24,6 @@
  * @stability: unstable
  * 
  * #GtkMap is simple map widget for displaying bitmap tile (256x256) based maps.
- * 
  *
  */
 
@@ -1855,7 +1854,7 @@ gtk_map_refresh(widget);
 }
 
 /**
- * gtk_map_get_tile_reposotory:
+ * gtk_map_get_tile_repository:
  *
  * Get the active map tile repository object.
  */
@@ -1894,9 +1893,11 @@ gdk_draw_rectangle(priv->buffer, widget->style->black_gc, TRUE, destx, desty, GT
  * @desty
  * @fast_fail
  *
- * Renders given tile x,y on buffer pixmap at dest x,y. If an exact tile is not found then it tries to load a
- * tile for a another zoom level and scale it to match.
- * If no suitable tile is found, a black box will be drawn on the buffer at dest x,y instead.
+ * Renders given tile x,y on buffer pixmap at dest x,y. If an exact tile 
+ * is not found then it tries to load a tile for a another zoom level 
+ * and scale it to match.
+ * If no suitable tile is found, a black box will be drawn on the map buffer 
+ * at dest x,y instead.
  *
  * Returns: TRUE if a tile is found. FALSE on error. 
  */
@@ -2160,7 +2161,7 @@ unit2latlon(priv->center.unitx, priv->center.unity, lat, lon);
  *
  * Centers map view on given Position if it's valid.
  *
- * Returns TRUE if Position was valid and view was centered. FALSE otherwise.
+ * Returns: TRUE if Position was valid and view was centered. FALSE otherwise.
  */
 gboolean
 gtk_map_goto_position(GtkWidget *widget, Position *pos)
@@ -2176,8 +2177,8 @@ return TRUE;
 
 /**
  * gtk_map_pan:
- * @delta_x:
- * @delta_y:
+ * @delta_x: Panning delta in x direction +-amount, can be 0
+ * @delta_y: Panning delta in y direction +-amount, can be 0
  * 
  * Pan map view using the given deltas.
  */
diff --git a/libs/libgtkmap/tilerepo.c b/libs/libgtkmap/tilerepo.c
index c7441f2..a93a5c9 100644
--- a/libs/libgtkmap/tilerepo.c
+++ b/libs/libgtkmap/tilerepo.c
@@ -204,6 +204,7 @@ g_slice_free(ProgressUpdateInfo, pui);
  *
  * Create a new empty Map image tile repository.
  *
+ * Returns: A new TileRepo object
  */
 TileRepo *
 tile_repo_new(void)
@@ -243,7 +244,7 @@ curl_multi_setopt(tr->download.curl_multi, CURLMOPT_PIPELINING, 1);
 
 /**
  * tile_repo_new_from_string:
- * @str
+ * @str: A configuration string
  *
  * Create a new Map image tile repository structure by filling in values from given configuration string.
  * Parses an string with components, delimited by newline characters:
@@ -253,6 +254,8 @@ curl_multi_setopt(tr->download.curl_multi, CURLMOPT_PIPELINING, 1);
  * 4. dl_zoom_steps
  * 5. view_zoom_steps
  *
+ * Returns: A new TileRepo object with parameters set from the given string.
+ *
  */
 TileRepo *
 tile_repo_new_from_string(gchar *str)
@@ -304,8 +307,9 @@ return tr;
 
 /**
  * tile_repo_get_string:
+ * @tr: a TileRepo object
  * 
- * Returns a string representation of the tile repository. Caller must free the returned string.
+ * Returns: a string representation of the tile repository. Caller must free the returned string.
  *
  */
 gchar *
@@ -324,7 +328,7 @@ download_stop(TileRepo *tr)
 
 /**
  * tile_repo_free:
- * @tr
+ * @tr: A TileRepo object to free 
  *
  * Free a map image tile repository
  */
@@ -421,8 +425,7 @@ for (n = 16 - zoomlevel; n >= 0; n--) {
 }
 
 
-/**
- * til
+/*
  * Construct the URL that we should fetch, based on the current URI format.
  * This method works differently depending on if a "%s" string is present in
  * the URI format, since that would indicate a quadtree-based map coordinate