[gtk+] Some documentation fixes



commit 3358c544da2cd079f5f565b5fec885a1e750f1f2
Author: Matthias Clasen <mclasen redhat com>
Date:   Fri Jul 26 14:10:37 2013 -0400

    Some documentation fixes
    
    Some incomplete renamings in the doc comments for the
    template child macros.

 gtk/gtkwidget.h |    8 +++++---
 1 files changed, 5 insertions(+), 3 deletions(-)
---
diff --git a/gtk/gtkwidget.h b/gtk/gtkwidget.h
index 9e0fc79..c5d4f92 100644
--- a/gtk/gtkwidget.h
+++ b/gtk/gtkwidget.h
@@ -1179,8 +1179,9 @@ void gtk_widget_remove_tick_callback (GtkWidget       *widget,
 /**
  * gtk_widget_class_bind_template_child:
  * @widget_class: a #GtkWidgetClass
- * @data_type: the type name of this widget
- * @member_name: name of the instance private member on @private_data_type
+ * @TypeName: the type name of this widget
+ * @member_name: name of the instance private member on the
+ *    private struct for @data_type
  *
  * Binds a child widget defined in a template to the @widget_class.
  *
@@ -1188,7 +1189,8 @@ void gtk_widget_remove_tick_callback (GtkWidget       *widget,
  * gtk_widget_class_bind_template_child_full() function.
  *
  * This macro will use the offset of the @member_name inside the @TypeName
- * private data structure.
+ * private data structure (it uses G_PRIVATE_OFFSET(), so the private struct
+ * must be added with G_ADD_PRIVATE()).
  *
  * Since: 3.10
  */


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