* @stability: unstable
*
* #GtkMap is simple map widget for displaying bitmap tile (256x256) based maps.
- *
*
*/
}
/**
- * gtk_map_get_tile_reposotory:
+ * gtk_map_get_tile_repository:
*
* Get the active map tile repository object.
*/
* @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.
*/
*
* 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)
/**
* 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.
*/
*
* Create a new empty Map image tile repository.
*
+ * Returns: A new TileRepo object
*/
TileRepo *
tile_repo_new(void)
/**
* 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:
* 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)
/**
* 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 *
/**
* tile_repo_free:
- * @tr
+ * @tr: A TileRepo object to free
*
* Free a map image tile repository
*/
}
-/**
- * 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