GNOME.org
 

[gobject-introspection] tests: sync with GTK-Doc test suite @ 1846fc7e904f6f56b74c366d205d6bb946eac17e

commit 0d17576deb4b72d29e60ed5d2d91ca8ecc0ef290
Author: Dieter Verfaillie <dieterv optionexplicit be>
Date:   Tue Jul 30 11:26:31 2013 +0200

    tests: sync with GTK-Doc test suite @ 1846fc7e904f6f56b74c366d205d6bb946eac17e

 tests/scanner/annotationparser/README              |    3 +-
 .../gtkdoc/annotations/tester.c.xml                |   49 +++++++++++++++++
 .../annotationparser/gtkdoc/bugs/tester.c.xml      |   32 +++++++++++
 .../annotationparser/gtkdoc/gobject/gobject.c.xml  |   57 +++++++++++++++++---
 4 files changed, 132 insertions(+), 9 deletions(-)
---
diff --git a/tests/scanner/annotationparser/README b/tests/scanner/annotationparser/README
index 03cdf59..236671e 100644
--- a/tests/scanner/annotationparser/README
+++ b/tests/scanner/annotationparser/README
@@ -43,7 +43,8 @@ gtk-doc/*.xml:
 
   GTK-Doc tests originally taken at revision:
   http://git.gnome.org/browse/gtk-doc/tree/tests?id=2a6b01253fe41412172a60f26705114b953d0a95
-
+  and should be updated regularly to reflect changes in the GTK-Doc project.
+    - updated 2013/07/30 to 1846fc7e904f6f56b74c366d205d6bb946eac17e
 
 gobject-introspection/*.xml:
   GTK-Doc comment blocks specifically designed to ensure AnnotationParser does the
diff --git a/tests/scanner/annotationparser/gtkdoc/annotations/tester.c.xml 
b/tests/scanner/annotationparser/gtkdoc/annotations/tester.c.xml
index bf94edb..d28d5d9 100644
--- a/tests/scanner/annotationparser/gtkdoc/annotations/tester.c.xml
+++ b/tests/scanner/annotationparser/gtkdoc/annotations/tester.c.xml
@@ -387,6 +387,55 @@
 
 <test>
   <input>/**
+ * annotation_skip_return: (skip)
+ * @list: a pointer to take a list
+ *
+ * Documentation for this function.
+ *
+ * Returns: (skip): %TRUE for success
+ */</input>
+  <parser>
+    <docblock>
+      <identifier>
+        <name>annotation_skip_return</name>
+        <annotations>
+          <annotation>
+            <name>skip</name>
+          </annotation>
+        </annotations>
+      </identifier>
+      <parameters>
+        <parameter>
+          <name>list</name>
+          <description>a pointer to take a list</description>
+        </parameter>
+      </parameters>
+      <description>Documentation for this function.</description>
+      <tags>
+        <tag>
+          <name>returns</name>
+          <annotations>
+            <annotation>
+              <name>skip</name>
+            </annotation>
+          </annotations>
+          <description>%TRUE for success</description>
+        </tag>
+      </tags>
+    </docblock>
+  </parser>
+  <output>/**
+ * annotation_skip_return: (skip)
+ * @list: a pointer to take a list
+ *
+ * Documentation for this function.
+ *
+ * Returns: (skip): %TRUE for success
+ */</output>
+</test>
+
+<test>
+  <input>/**
  * annotation_scope:
  * @callback: (scope async): a callback
  * @user_data: data to pass to callback
diff --git a/tests/scanner/annotationparser/gtkdoc/bugs/tester.c.xml 
b/tests/scanner/annotationparser/gtkdoc/bugs/tester.c.xml
index 7d766c6..09ab977 100644
--- a/tests/scanner/annotationparser/gtkdoc/bugs/tester.c.xml
+++ b/tests/scanner/annotationparser/gtkdoc/bugs/tester.c.xml
@@ -1073,4 +1073,36 @@ http://bugzilla.gnome.org/show_bug.cgi?id=380824</description>
  */</output>
 </test>
 
+<test>
+  <input>/**
+ * deprecation_notice:
+ *
+ * Foo.
+ *
+ * Deprecated: 3.10: Use named icon "bar" instead.
+ */</input>
+  <parser>
+    <docblock>
+      <identifier>
+        <name>deprecation_notice</name>
+      </identifier>
+      <description>Foo.</description>
+      <tags>
+        <tag>
+          <name>deprecated</name>
+          <value>3.10</value>
+          <description>Use named icon "bar" instead.</description>
+        </tag>
+      </tags>
+    </docblock>
+  </parser>
+  <output>/**
+ * deprecation_notice:
+ *
+ * Foo.
+ *
+ * Deprecated: 3.10: Use named icon "bar" instead.
+ */</output>
+</test>
+
 </tests>
diff --git a/tests/scanner/annotationparser/gtkdoc/gobject/gobject.c.xml 
b/tests/scanner/annotationparser/gtkdoc/gobject/gobject.c.xml
index 6b8b34f..b54a1a7 100644
--- a/tests/scanner/annotationparser/gtkdoc/gobject/gobject.c.xml
+++ b/tests/scanner/annotationparser/gtkdoc/gobject/gobject.c.xml
@@ -209,8 +209,8 @@ All the internal details go here or not:
  * <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
  */]]></input>
   <parser>
@@ -254,10 +254,11 @@ All the internal details go here or not:
  * @value: the new otest value, whose description extends further than one
  *  line will allow
  *
- * Set the #GtkdocObject:otest property.
+ * Set the #GtkdocObject:otest property. This is a long paragraph.
  *
- * Deprecated: Use g_object_set(obj,&quot;otest&quot;,value,NULL); instead.
+ * 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
  */]]></input>
   <parser>
@@ -276,7 +277,9 @@ All the internal details go here or not:
  line will allow</description>
         </parameter>
       </parameters>
-      <description>Set the #GtkdocObject:otest property.</description>
+      <description>Set the #GtkdocObject:otest property. This is a long paragraph.
+
+Oh, btw. setting the property directly saves us one method.</description>
       <tags>
         <tag>
           <name>deprecated</name>
@@ -295,7 +298,9 @@ All the internal details go here or not:
  * @value: the new otest value, whose description extends further than one
  *  line will allow
  *
- * Set the #GtkdocObject:otest property.
+ * Set the #GtkdocObject:otest property. This is a long paragraph.
+ *
+ * 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
@@ -444,7 +449,19 @@ complex algorithm (http://en.wikipedia.org/wiki/Algorithm).
    * 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.
    */</input>
@@ -459,7 +476,19 @@ complex algorithm (http://en.wikipedia.org/wiki/Algorithm).
           <description>myself</description>
         </parameter>
       </parameters>
-      <description>The event has been triggered.</description>
+      <description>Here's an example signal handler.
+|[
+static gchar*
+otest_callback (GObject  *o,
+                gpointer  user_data)
+{
+  gdouble      value;
+
+  value = abs (o->value);
+
+  return value;
+}
+]|</description>
       <tags>
         <tag>
           <name>deprecated</name>
@@ -472,7 +501,19 @@ complex algorithm (http://en.wikipedia.org/wiki/Algorithm).
    * 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.
    */</output>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]