Document GisPluginMap
authorAndy Spencer <andy753421@gmail.com>
Mon, 8 Feb 2010 22:30:40 +0000 (22:30 +0000)
committerAndy Spencer <andy753421@gmail.com>
Mon, 8 Feb 2010 22:30:40 +0000 (22:30 +0000)
src/plugins/map.c

index 0dbb79f38931333092fa91274610d77dabed7945..7395ef7792c7598d4220f356090550be70ecade5 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * SECTION:map
+ * @short_description: Map plugin
+ *
+ * #GisPluginMap provides map overlays. Much of this data is obtained from the
+ * OpenStreetMap project.
+ */
+
 #include <time.h>
 #include <stdlib.h>
 #include <glib/gstdio.h>
@@ -151,6 +159,14 @@ static void _on_location_changed(GisViewer *viewer,
 /***********
  * Methods *
  ***********/
+/**
+ * gis_plugin_map_new:
+ * @viewer: the #GisViewer to use for drawing
+ *
+ * Create a new instance of the map plugin.
+ *
+ * Returns: the new #GisPluginMap
+ */
 GisPluginMap *gis_plugin_map_new(GisViewer *viewer)
 {
        g_debug("GisPluginMap: new");