Document GisMarker
authorAndy Spencer <andy753421@gmail.com>
Mon, 8 Feb 2010 22:29:55 +0000 (22:29 +0000)
committerAndy Spencer <andy753421@gmail.com>
Mon, 8 Feb 2010 22:29:55 +0000 (22:29 +0000)
src/objects/gis-marker.c

index f3a5079a66db4b6d4f75a9e2b2bbceedaeebb181..fc4beb1bf956cd0a0f2097444a4100c2ccd5f62c 100644 (file)
  * 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);