summaryrefslogtreecommitdiff
path: root/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.method.page
diff options
context:
space:
mode:
Diffstat (limited to 'tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.method.page')
-rw-r--r--tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.method.page40
1 files changed, 34 insertions, 6 deletions
diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.method.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.method.page
index f6c2eba5..5f27f96f 100644
--- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.method.page
+++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.method.page
@@ -10,7 +10,7 @@
<link type="guide" xref="DocExamples.Obj" group="method"/>
<api:function>
<api:returns>
- <api:type>void</api:type>
+ <api:type>gboolean</api:type>
</api:returns>
<api:name>doc_examples_obj_method</api:name>
<api:arg>
@@ -25,28 +25,56 @@
<api:type>gfloat</api:type>
<api:name>second_arg</api:name>
</api:arg>
+ <api:arg>
+ <api:type>gboolean</api:type>
+ <api:name>boolean_arg</api:name>
+ </api:arg>
+ <api:arg>
+ <api:type>gpointer</api:type>
+ <api:name>pointer_arg</api:name>
+ </api:arg>
+ <api:arg>
+ <api:type>gchar*</api:type>
+ <api:name>string</api:name>
+ </api:arg>
</api:function>
</info>
<title>doc_examples_obj_method</title>
<synopsis><code mime="text/x-csrc">
-void doc_examples_obj_method (DocExamplesObj *self,
+gboolean doc_examples_obj_method (DocExamplesObj *self,
gint first_arg,
- gfloat second_arg);
+ gfloat second_arg,
+ gboolean boolean_arg,
+ gpointer pointer_arg,
+ gchar* string);
</code></synopsis>
-<p>This is an example of how to document a method.</p>
+<p>This is an example of how to document a method.</p><p>You should call this on a <link xref="DocExamples.Obj">DocExamples.Obj</link> that was
+created with <link xref="DocExamples.Obj.new">doc_examples_obj_new</link>.</p><p>This should be a %FALSEALARM.</p>
<table>
<tr>
<td><p>first_arg :</p></td>
-<td><p>first argument</p></td>
+<td><p>A <link xref="DocExamples.Obj">DocExamples.Obj</link>.</p></td>
</tr>
<tr>
<td><p>second_arg :</p></td>
<td><p>second argument</p></td>
</tr>
<tr>
+<td><p>boolean_arg :</p></td>
+<td><p>You should always pass TRUE.</p></td>
+</tr>
+<tr>
+<td><p>pointer_arg :</p></td>
+<td><p>If not NULL, do a thing.</p></td>
+</tr>
+<tr>
+<td><p>string :</p></td>
+<td><p>A NULL-terminated string.</p></td>
+</tr>
+<tr>
<td><p>Returns :</p></td>
-<td></td>
+<td><p>Either FALSE or something FALSE-y.</p></td>
</tr>
</table>
<p>Since 0.99</p>