diff options
| author | Jasper St. Pierre <jstpierre@mecheye.net> | 2013-02-01 20:08:34 -0500 |
|---|---|---|
| committer | Jasper St. Pierre <jstpierre@mecheye.net> | 2013-02-01 20:09:22 -0500 |
| commit | 2a30f0be17b6244119ef20dcc9bdfabba3c0817f (patch) | |
| tree | b26abdfdf168dd887edfab7f8c36459540222cc3 | |
| parent | 54734b195dda07a935470b64e0654101f5528b94 (diff) | |
| download | gobject-introspection-2a30f0be17b6244119ef20dcc9bdfabba3c0817f.tar.gz | |
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.
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 df3168c1..54d59f1e 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 16f951bc..7d474ec7 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 8ebcb732..c1900905 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 08341c83..bd134816 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. |