Document GisCallback

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

diff --git a/src/objects/gis-callback.h b/src/objects/gis-callback.h
index f3eee6de59a4e71ef95ddb4e7049a6a3d720f4c1..b9c77da8a8fbefb9d96e2b56610ca4431e5434e3 100644 (file)
--- a/src/objects/gis-callback.h
+++ b/src/objects/gis-callback.h
@@ -33,7 +33,14 @@
 typedef struct _GisCallback      GisCallback;
 typedef struct _GisCallbackClass GisCallbackClass;
 
-typedef gpointer (*GisCallbackFunc)(GisCallback *callback, gpointer user_data);
+/**
+ * GisCallbackFunc:
+ * @callback:  the callback object to be drawn
+ * @user_data: the user data associated with the callback 
+ *
+ * A function to be called when the callback object is being rendered
+ */
+typedef void (*GisCallbackFunc)(GisCallback *callback, gpointer user_data);
 
 struct _GisCallback {
        GisObject       parent;