summaryrefslogtreecommitdiff
path: root/gtk/gtkbuildable.c
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.van.berkom@gmail.com>2010-05-20 00:30:13 -0400
committerTristan Van Berkom <tristan.van.berkom@gmail.com>2010-05-20 00:33:20 -0400
commit80ee7f793aeeda199ad8f8fe32e64b4bb7f08a23 (patch)
tree1d6c9a723d79d34db6ccb8d47e5319c6bfbc3e8a /gtk/gtkbuildable.c
parent68701c828c00e6ae826cc6a6df66da78457329ff (diff)
downloadgtk+-80ee7f793aeeda199ad8f8fe32e64b4bb7f08a23.tar.gz
Amending GtkBuildable documentation.
GtkBuildable documentation has forever stated that "only objects which implement GtkBuildable can parsed by GtkBuilder" fixed.
Diffstat (limited to 'gtk/gtkbuildable.c')
-rw-r--r--gtk/gtkbuildable.c12
1 files changed, 7 insertions, 5 deletions
diff --git a/gtk/gtkbuildable.c b/gtk/gtkbuildable.c
index 68e6f8f89c..12fc07791d 100644
--- a/gtk/gtkbuildable.c
+++ b/gtk/gtkbuildable.c
@@ -23,17 +23,19 @@
* @Short_description: Interface for objects that can be built by GtkBuilder
* @Title: GtkBuildable
*
- * In order to allow construction from a <link linkend="BUILDER-UI">GtkBuilder
- * UI description</link>, an object class must implement the
- * GtkBuildable interface. The interface includes methods for setting
- * names and properties of objects, parsing custom tags, constructing
- * child objects.
+ * GtkBuildable allows objects to extend and customize thier deserialization
+ * from <link linkend="BUILDER-UI">GtkBuilder UI descriptions</link>.
+ * The interface includes methods for setting names and properties of objects,
+ * parsing custom tags and constructing child objects.
*
* The GtkBuildable interface is implemented by all widgets and
* many of the non-widget objects that are provided by GTK+. The
* main user of this interface is #GtkBuilder, there should be
* very little need for applications to call any
* <function>gtk_buildable_...</function> functions.
+ *
+ * <note><para>An object only needs to implement this interface if it needs
+ * to extend the #GtkBuilder format or run any extra routines at deserialization time</para></note>
*/
#include "config.h"