[gtk+] gtk-doc fixup for gtk_widget_class_bind_template_child_full()



commit 28a3638448924acf69c9ac5b77b856d6ec138aec
Author: Tristan Van Berkom <tristanvb openismus com>
Date:   Mon Aug 19 20:03:45 2013 +0200

    gtk-doc fixup for gtk_widget_class_bind_template_child_full()
    
    Updated documentation to specify that '0' should be specified if
    one does not need to automatically assign a bound child to a public
    or private instance member (now that negative values are private
    structure offsets).

 gtk/gtkwidget.c |    8 ++++----
 1 files changed, 4 insertions(+), 4 deletions(-)
---
diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c
index b29396e..9adf3e4 100644
--- a/gtk/gtkwidget.c
+++ b/gtk/gtkwidget.c
@@ -393,7 +393,7 @@
 typedef struct {
   gchar               *name;           /* Name of the template automatic child */
   gboolean             internal_child; /* Whether the automatic widget should be exported as an 
<internal-child> */
-  gssize               offset;         /* Instance private data offset where to set the automatic child (or 
-1) */
+  gssize               offset;         /* Instance private data offset where to set the automatic child (or 
0) */
 } AutomaticChildClass;
 
 typedef struct {
@@ -15938,7 +15938,7 @@ gtk_widget_class_set_connect_func (GtkWidgetClass        *widget_class,
  * @internal_child: Whether the child should be accessible as an "internal-child"
  *                  when this class is used in GtkBuilder XML
  * @struct_offset: The structure offset into the composite widget's instance public or private structure
- *                 where the automated child pointer should be set, or -1 to not assign the pointer.
+ *                 where the automated child pointer should be set, or 0 to not assign the pointer.
  *
  * Automatically assign an object declared in the class template XML to be set to a location
  * on a freshly built instance's private data, or alternatively accessible via 
gtk_widget_get_automated_child().
@@ -15948,8 +15948,8 @@ gtk_widget_class_set_connect_func (GtkWidgetClass        *widget_class,
  *
  * An explicit strong reference will be held automatically for the duration of your
  * instance's life cycle, it will be released automatically when #GObjectClass.dispose() runs
- * on your instance and if a @struct_offset that is >= 0 is specified, then the automatic location
- * in your instance private data will be set to %NULL. You can however access an automated child
+ * on your instance and if a @struct_offset that is != 0 is specified, then the automatic location
+ * in your instance public or private data will be set to %NULL. You can however access an automated child
  * pointer the first time your classes #GObjectClass.dispose() runs, or alternatively in
  * #GtkWidgetClass.destroy().
  *


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]