Document GisCallback

[grits] / src / objects / gis-callback.c

diff --git a/src/objects/gis-callback.c b/src/objects/gis-callback.c
index b739159dbb7388fc04ce7839ca11ce15ef77d8c4..9e6373757166c17bd46c8dbe2c36dba4e537d480 100644 (file)
--- a/src/objects/gis-callback.c
+++ b/src/objects/gis-callback.c
@@ -15,18 +15,41 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * SECTION:gis-callback
+ * @short_description: Custom callback objects
+ *
+ * #GisCallback objects are used for custom drawing functions. A common example
+ * of this would be to render something which does not easily fit into a normal
+ * object. For instance, a Heads-Up-Display overlay.
+ */
+
 #include <config.h>
 #include "gis-callback.h"
 
 /* GisCallback */
 G_DEFINE_TYPE(GisCallback, gis_callback, GIS_TYPE_OBJECT);
-static void gis_callback_init(GisCallback *self) { }
-static void gis_callback_class_init(GisCallbackClass *klass) { }
+static void gis_callback_init(GisCallback *cb)
+{
+}
 
+static void gis_callback_class_init(GisCallbackClass *klass)
+{
+}
+
+/**
+ * gis_callback_new:
+ * @callback:  the function to call to draw the object
+ * @user_data: user data to pass to the drawing function
+ *
+ * Create a #GisCallback object with an associated function and user data.
+ *
+ * Returns: the new #GisCallback
+ */
 GisCallback *gis_callback_new(GisCallbackFunc callback, gpointer user_data)
 {
-       GisCallback *self = g_object_new(GIS_TYPE_CALLBACK, NULL);
-       self->callback  = callback;
-       self->user_data = user_data;
-       return self;
+       GisCallback *cb = g_object_new(GIS_TYPE_CALLBACK, NULL);
+       cb->callback  = callback;
+       cb->user_data = user_data;
+       return cb;
 }