[gtk-doc] tests: add a code example to signal docs



commit 5ca528fe92464b12140630a19a113f67e08eb74c
Author: Stefan Sauer <ensonic users sf net>
Date:   Mon Feb 25 22:19:38 2013 +0100

    tests: add a code example to signal docs

 tests/gobject/src/gobject.c |   19 +++++++++++++++----
 1 files changed, 15 insertions(+), 4 deletions(-)
---
diff --git a/tests/gobject/src/gobject.c b/tests/gobject/src/gobject.c
index 01fdd04..82ed94a 100644
--- a/tests/gobject/src/gobject.c
+++ b/tests/gobject/src/gobject.c
@@ -19,7 +19,7 @@
  * GObject *myobj;
  *
  * myobj = gtkdoc_object_new();
- * // do somehing
+ * // do something
  * g_object_unref (myobj);
  * ]|
  *
@@ -79,8 +79,8 @@ enum {
  * <note><para>
  *   This will only work if you have called g_type_init() before.
  * </para></note>
- * Returns: the instance or %NULL in case of an error
  *
+ * Returns: the instance or %NULL in case of an error
  * Since: 0.1
  */
 GtkdocObject *gtkdoc_object_new (void) {
@@ -100,7 +100,6 @@ GtkdocObject *gtkdoc_object_new (void) {
  * Oh, btw. setting the property directly saves us one method.
  *
  * Deprecated: Use g_object_set(obj,&quot;otest&quot;,value,NULL); instead.
- *
  * Since: 0.5
  */
 void gtkdoc_object_set_otest (GObject *self, const gchar *value) {
@@ -178,7 +177,19 @@ static void gtkdoc_object_class_init (GtkdocObjectClass *klass) {
    * GtkdocObject::dep-otest:
    * @self: myself
    *
-   * The event has been triggered.
+   * Here's an example signal handler.
+   * |[
+   * static gchar*
+   * otest_callback (GObject  *o,
+   *                 gpointer  user_data)
+   * {
+   *   gdouble      value;
+   *
+   *   value = abs (o->value);
+   *
+   *   return value;
+   * }
+   * ]|
    *
    * Deprecated: Use the #GtkdocObject::otest signal instead.
    */


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