[gobject-introspection] doc-examples-obj: Fix documentation for doc_examples_obj_method



commit 2a30f0be17b6244119ef20dcc9bdfabba3c0817f
Author: Jasper St. Pierre <jstpierre mecheye net>
Date:   Fri Feb 1 20:08:34 2013 -0500

    doc-examples-obj: Fix documentation for doc_examples_obj_method
    
    We need to properly document the first argument, here. We don't
    actually iterate over the instance parameter yet, so this will
    just affect the documentation for @first_arg.

 .../DocExamples.Obj.method.page                    |    2 +-
 .../DocExamples.Obj.method.page                    |    2 +-
 .../DocExamples.Obj.method.page                    |    2 +-
 tests/doctool/doc-examples-obj.c                   |    3 ++-
 4 files changed, 5 insertions(+), 4 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 df3168c..54d59f1 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
@@ -61,7 +61,7 @@ created with <link xref="DocExamples.Obj.new"/>.</p><p>This should be a %FALSEAL
   
 <dl>
 <dt><p>first_arg :</p></dt>
-<dd><p>A <link xref="DocExamples.Obj"/>.</p></dd>
+<dd><p>first argument</p></dd>
 <dt><p>second_arg :</p></dt>
 <dd><p>second argument</p></dd>
 <dt><p>boolean_arg :</p></dt>
diff --git a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj.method.page b/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj.method.page
index 16f951b..7d474ec 100644
--- a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj.method.page
+++ b/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj.method.page
@@ -58,7 +58,7 @@ created with <link xref="DocExamples.Obj.new"/>.</p><p>This should be a %FALSEAL
   
 <dl>
 <dt><p>first_arg :</p></dt>
-<dd><p>A <link xref="DocExamples.Obj"/>.</p></dd>
+<dd><p>first argument</p></dd>
 <dt><p>second_arg :</p></dt>
 <dd><p>second argument</p></dd>
 <dt><p>boolean_arg :</p></dt>
diff --git a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.method.page b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.method.page
index 8ebcb73..c190090 100644
--- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.method.page
+++ b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.method.page
@@ -59,7 +59,7 @@ created with <link xref="DocExamples.Obj.new"/>.</p><p>This should be a %FALSEAL
   
 <dl>
 <dt><p>first_arg :</p></dt>
-<dd><p>A <link xref="DocExamples.Obj"/>.</p></dd>
+<dd><p>first argument</p></dd>
 <dt><p>second_arg :</p></dt>
 <dd><p>second argument</p></dd>
 <dt><p>boolean_arg :</p></dt>
diff --git a/tests/doctool/doc-examples-obj.c b/tests/doctool/doc-examples-obj.c
index 08341c8..bd13481 100644
--- a/tests/doctool/doc-examples-obj.c
+++ b/tests/doctool/doc-examples-obj.c
@@ -104,7 +104,8 @@ doc_examples_obj_new (void)
 
 /**
  * doc_examples_obj_method:
- * @first_arg: A #DocExamplesObj.
+ * @self: A #DocExamplesObj.
+ * @first_arg: first argument
  * @second_arg: second argument
  * @boolean_arg: You should always pass %TRUE.
  * @pointer_arg: (allow-none): If not %NULL, do a thing.



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