From: Andy Spencer <andy753421@gmail.com>
Date: Mon, 8 Feb 2010 22:29:55 +0000 (+0000)
Subject: Document GisMarker
X-Git-Tag: v0.4~56
X-Git-Url: http://pileus.org/git/?p=grits;a=commitdiff_plain;h=715cf80f0277fa64b45afbed5e4b27c7f4347879

Document GisMarker
---

diff --git a/src/objects/gis-marker.c b/src/objects/gis-marker.c
index f3a5079..fc4beb1 100644
--- a/src/objects/gis-marker.c
+++ b/src/objects/gis-marker.c
@@ -15,10 +15,35 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * SECTION:gis-marker
+ * @short_description: Single point markers
+ *
+ * Each #GisMarker represents some point on the earth with some form of
+ * content. Commonly this is used to mark geographic features such as cities or
+ * states.
+ * 
+ * While markers represent a place in three dimensions somewhere on, below, or
+ * above the surface of the earth, they are drawn in 2 dimensions so that they
+ * look normal and readable by the user. Due to this, GisObjects should almost
+ * always be added to the GIS_LEVEL_OVERLAY level so they are drawn "above" the
+ * actual earth.
+ */
+
 #include <config.h>
 #include "gis-marker.h"
 
-/* GisMarker */
+/*************
+ * GisMarker *
+ *************/
+/**
+ * gis_marker_new:
+ * @label: a short description of the marker
+ *
+ * Create a new GisMarker which shows the given label when drawn.
+ *
+ * Returns: the new #GisMarker.
+ */
 GisMarker *gis_marker_new(const gchar *label)
 {
 	//g_debug("GisMarker: new - %s", label);