X-Git-Url: http://pileus.org/git/?p=grits;a=blobdiff_plain;f=src%2Fobjects%2Fgis-object.c;h=84e5c4722eb3d07af753736cac19f80e2b8921a1;hp=ac01a294379b67c512ca585b815fad9407c7079b;hb=2ff4eb1f35e8300a2fdfdb6d38389284d483ba1d;hpb=a27f6ded65836d5bc66a81ec62875382fb73093e
diff --git a/src/objects/gis-object.c b/src/objects/gis-object.c
index ac01a29..84e5c47 100644
--- a/src/objects/gis-object.c
+++ b/src/objects/gis-object.c
@@ -15,16 +15,46 @@
* along with this program. If not, see .
*/
+/**
+ * SECTION:gis-object
+ * @short_description: Base classes for drawing operations
+ *
+ * Objects in libgis are things which can be added to the viewer and will be
+ * displayed to the user. Each object has information such as it's location and
+ * level of detail which are used by the viewer to determine which objects
+ * should be drawn.
+ *
+ * Each #GisObject is also a #GObject, but not every GObject in libgis is a
+ * GisObject. The "Object" part of the name is just coincidence.
+ */
+
#include
#include "gis-object.h"
-
-/* GisPoint */
+/************
+ * GisPoint *
+ ************/
+/**
+ * gis_point_new:
+ *
+ * Create a new #GisPoint
+ *
+ * Returns: the new point
+ */
GisPoint *gis_point_new()
{
return g_new0(GisPoint, 1);
}
+/**
+ * gis_point_set_lle:
+ * @point: the point to modify
+ * @lat: the new latitude
+ * @lon: the new longitude
+ * @elev: the new elevation
+ *
+ * Set the latitude, longitude, and elevation for a point.
+ */
void gis_point_set_lle(GisPoint *point, gdouble lat, gdouble lon, gdouble elev)
{
point->lat = lat;
@@ -32,13 +62,22 @@ void gis_point_set_lle(GisPoint *point, gdouble lat, gdouble lon, gdouble elev)
point->elev = elev;
}
+/**
+ * gis_point_free:
+ * @point: The point to free
+ *
+ * Free data used by a #GisPoint
+ */
void gis_point_free(GisPoint *point)
{
g_free(point);
}
-/* GisObject */
+/*************
+ * GisObject *
+ *************/
+/* GObject stuff */
G_DEFINE_ABSTRACT_TYPE(GisObject, gis_object, G_TYPE_OBJECT);
static void gis_object_init(GisObject *object)
{