From 9293c8b8ce5580c3be0d29366ca4287a706ee03e Mon Sep 17 00:00:00 2001
From: Dave Davenport <qball@gmpclient.org>
Date: Fri, 14 Oct 2016 18:56:09 +0200
Subject: More docu updates

---
 include/widgets/widget-internal.h | 20 ++++++++++++++------
 1 file changed, 14 insertions(+), 6 deletions(-)

(limited to 'include/widgets/widget-internal.h')

diff --git a/include/widgets/widget-internal.h b/include/widgets/widget-internal.h
index b2f3b4f5..9e287cb3 100644
--- a/include/widgets/widget-internal.h
+++ b/include/widgets/widget-internal.h
@@ -1,6 +1,9 @@
 #ifndef WIDGET_INTERNAL_H
 #define WIDGET_INTERNAL_H
 
+/**
+ * Data structure holding the internal state of the Widget
+ */
 struct _widget
 {
     /** X position relative to parent */
@@ -13,26 +16,31 @@ struct _widget
     short             h;
     /** enabled or not */
     gboolean          enabled;
-    /** Information about packing. */
+    /** Expand the widget when packed */
     gboolean          expand;
+    /** Place widget at end of parent */
     gboolean          end;
-
+    /** Parent widget */
     struct _widget    *parent;
     /** Internal */
     gboolean          need_redraw;
-    /** Function prototypes */
+    /** get width of widget implementation function */
     int               ( *get_width )( struct _widget * );
+    /** get height of widget implementation function */
     int               ( *get_height )( struct _widget * );
-
+    /** draw widget implementation function */
     void              ( *draw )( struct _widget *widget, cairo_t *draw );
+    /** resize widget implementation function */
     void              ( *resize )( struct _widget *, short, short );
+    /** update widget implementation function */
     void              ( *update )( struct _widget * );
 
-    // Signals.
+    /** widget clicked callback */
     widget_clicked_cb clicked;
+    /** user data for ::clicked callback */
     void              *clicked_cb_data;
 
-    // Free
+    /** Free widget callback */
     void              ( *free )( struct _widget *widget );
 };
 #endif // WIDGET_INTERNAL_H
-- 
cgit v1.2.3