summaryrefslogtreecommitdiff
path: root/tests
diff options
context:
space:
mode:
authorJasper St. Pierre <jstpierre@mecheye.net>2013-01-31 12:52:23 -0500
committerJasper St. Pierre <jstpierre@mecheye.net>2013-02-01 19:47:41 -0500
commit7e0ab2b629691c5904e00f4890a2da052a0a9c37 (patch)
tree61682b838570c4ae2043871c446815e169d2191c /tests
parent9c68ba7c6f8b6b7367ccad1877d28cd526045961 (diff)
downloadgobject-introspection-7e0ab2b629691c5904e00f4890a2da052a0a9c37.tar.gz
doctool: Define a standard order of items for all pages
Diffstat (limited to 'tests')
-rw-r--r--tests/doctool/DocExamples-1.0-C-expected/DocExamples.Callback.page7
-rw-r--r--tests/doctool/DocExamples-1.0-C-expected/DocExamples.Enum.page7
-rw-r--r--tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-property-example.page8
-rw-r--r--tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-signal-example.page8
-rw-r--r--tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-vfunc.page7
-rw-r--r--tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.method.page7
-rw-r--r--tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.new.page5
-rw-r--r--tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.page17
-rw-r--r--tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.static_method.page5
-rw-r--r--tests/doctool/DocExamples-1.0-C-expected/DocExamples.ObjClass.page7
-rw-r--r--tests/doctool/DocExamples-1.0-C-expected/DocExamples.array_function.page5
-rw-r--r--tests/doctool/DocExamples-1.0-C-expected/DocExamples.callback_function.page5
-rw-r--r--tests/doctool/DocExamples-1.0-C-expected/index.page9
-rw-r--r--tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Callback.page7
-rw-r--r--tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Enum.page9
-rw-r--r--tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-property-example.page8
-rw-r--r--tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-signal-example.page10
-rw-r--r--tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-vfunc.page8
-rw-r--r--tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.method.page8
-rw-r--r--tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.page10
-rw-r--r--tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.static_method.page6
-rw-r--r--tests/doctool/DocExamples-1.0-Python-expected/DocExamples.array_function.page6
-rw-r--r--tests/doctool/DocExamples-1.0-Python-expected/DocExamples.callback_function.page6
-rw-r--r--tests/doctool/DocExamples-1.0-Python-expected/index.page9
24 files changed, 146 insertions, 38 deletions
diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Callback.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Callback.page
index c2c171b3..98d30f8c 100644
--- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Callback.page
+++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Callback.page
@@ -12,7 +12,14 @@
</info>
<title>DocExamples.Callback</title>
+
+
+
+
+
+
+
</page>
diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Enum.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Enum.page
index 06fec31b..97b15866 100644
--- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Enum.page
+++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Enum.page
@@ -12,7 +12,14 @@
</info>
<title>DocExamples.Enum</title>
+
+
<p>This is an example to document an enumeration.</p>
+
+
+
+
+
</page>
diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-property-example.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-property-example.page
index 465c018f..d1f44d49 100644
--- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-property-example.page
+++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-property-example.page
@@ -13,7 +13,15 @@
</info>
<title>DocExamples.Obj:property-example</title>
+
+
<p>This is an example of how to document a property.</p>
+ <p>Since 0.99</p>
+
+
+
+
+
</page>
diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-signal-example.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-signal-example.page
index 7d40713a..63d86354 100644
--- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-signal-example.page
+++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-signal-example.page
@@ -13,7 +13,15 @@
</info>
<title>DocExamples.Obj::signal-example</title>
+
+
<p>This is an example of how to document a signal.</p>
+ <p>Since 0.99</p>
+
+
+
+
+
</page>
diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-vfunc.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-vfunc.page
index 23a7c654..c4acf2c2 100644
--- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-vfunc.page
+++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-vfunc.page
@@ -15,8 +15,13 @@
<synopsis><code mime="text/x-csrc">
</code></synopsis>
+
<p>This is an example of how to document a vfunc.</p>
+
+ <p>Since 0.99</p>
+
+
<table>
<tr>
<td><p>first_arg :</p></td>
@@ -28,8 +33,6 @@
</tr>
</table>
- <p>Since 0.99</p>
-
</page>
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 4d2f6cd3..a08ecaa8 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
@@ -51,9 +51,14 @@ gint first_arg,
gchar* string);
</code></synopsis>
+
<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>
+
+ <p>Since 0.99</p>
+
+
<table>
<tr>
<td><p>first_arg :</p></td>
@@ -81,8 +86,6 @@ created with <link xref="DocExamples.Obj.new">doc_examples_obj_new</link>.</p><p
</tr>
</table>
- <p>Since 0.99</p>
-
</page>
diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.new.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.new.page
index 0f8c297a..4058a9a3 100644
--- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.new.page
+++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.new.page
@@ -22,8 +22,12 @@
DocExamplesObj* doc_examples_obj_new (void);
</code></synopsis>
+
+
+
+
<table>
<tr>
<td><p>Returns :</p></td>
@@ -32,6 +36,5 @@ DocExamplesObj* doc_examples_obj_new (void);
</table>
-
</page>
diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.page
index 9937b79b..eb90ad3f 100644
--- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.page
+++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.page
@@ -12,12 +12,6 @@
</info>
<title>DocExamples.Obj</title>
-
- <p>This is an example of how to document a class</p><p>This class has a signal: <link xref="DocExamples.Obj-signal-example">DocExamples.Obj::signal-example</link>.</p><p>And also has a property: <link xref="DocExamples.Obj-property-example">DocExamples.Obj:property-example</link>.</p>
-
-
- <p>Since 0.99</p>
-
<synopsis ui:expanded="no">
<title>Hierarchy</title>
<tree>
@@ -26,6 +20,16 @@
</item>
</tree>
</synopsis>
+
+
+ <p>This is an example of how to document a class</p><p>This class has a signal: <link xref="DocExamples.Obj-signal-example">DocExamples.Obj::signal-example</link>.</p><p>And also has a property: <link xref="DocExamples.Obj-property-example">DocExamples.Obj:property-example</link>.</p>
+
+
+ <p>Since 0.99</p>
+
+
+
+
<links type="topic" ui:expanded="yes"
api:type="function" api:mime="text/x-csrc"
groups="constructor" style="linklist">
@@ -51,5 +55,4 @@
<title>Other</title>
</links>
-
</page>
diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.static_method.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.static_method.page
index 358a220c..9de699a3 100644
--- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.static_method.page
+++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.static_method.page
@@ -26,9 +26,13 @@
gboolean doc_examples_obj_static_method (gint* out_arg);
</code></synopsis>
+
<p>This is an example of a function with an out argument
and a return value.</p>
+
+
+
<table>
<tr>
<td><p>out_arg :</p></td>
@@ -41,6 +45,5 @@ and a return value.</p>
</table>
-
</page>
diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.ObjClass.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.ObjClass.page
index cd8021ba..75bf1299 100644
--- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.ObjClass.page
+++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.ObjClass.page
@@ -12,7 +12,14 @@
</info>
<title>DocExamples.ObjClass</title>
+
+
+
+
+
+
+
</page>
diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.array_function.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.array_function.page
index f24da60e..bdae1415 100644
--- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.array_function.page
+++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.array_function.page
@@ -26,9 +26,13 @@
gint* doc_examples_array_function (gint* out_len);
</code></synopsis>
+
<p>This function returns an array with an explicit length,
and the length should be invisible in most introspected bindings.</p>
+
+
+
<table>
<tr>
<td><p>out_len :</p></td>
@@ -41,6 +45,5 @@ and the length should be invisible in most introspected bindings.</p>
</table>
-
</page>
diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.callback_function.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.callback_function.page
index 2af93305..93e77203 100644
--- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.callback_function.page
+++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.callback_function.page
@@ -36,10 +36,14 @@ DocExamplesEnum doc_examples_callback_function (DocExamplesCallback callback,
GDestroyNotify destroy_notify);
</code></synopsis>
+
<p>This is a function that takes a callback. Different languages
will expose this in different ways (e.g. Python keeps the
<code>user_data</code> parameter, while JS doesn't)</p>
+
+
+
<table>
<tr>
<td><p>callback :</p></td>
@@ -60,6 +64,5 @@ will expose this in different ways (e.g. Python keeps the
</table>
-
</page>
diff --git a/tests/doctool/DocExamples-1.0-C-expected/index.page b/tests/doctool/DocExamples-1.0-C-expected/index.page
index 5143b432..de98563c 100644
--- a/tests/doctool/DocExamples-1.0-C-expected/index.page
+++ b/tests/doctool/DocExamples-1.0-C-expected/index.page
@@ -12,6 +12,14 @@
</info>
<title>Index</title>
+
+
+
+
+
+
+
+
<links type="topic" ui:expanded="yes" groups="class" style="linklist">
<title>Classes</title>
</links>
@@ -22,5 +30,4 @@
<title>Other</title>
</links>
-
</page>
diff --git a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Callback.page b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Callback.page
index c2c171b3..98d30f8c 100644
--- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Callback.page
+++ b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Callback.page
@@ -12,7 +12,14 @@
</info>
<title>DocExamples.Callback</title>
+
+
+
+
+
+
+
</page>
diff --git a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Enum.page b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Enum.page
index 614b855e..3a5c17e1 100644
--- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Enum.page
+++ b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Enum.page
@@ -12,7 +12,13 @@
</info>
<title>DocExamples.Enum</title>
- <p>This is an example to document an enumeration.</p>
+
+
+ <p>This is an example to document an enumeration.</p>
+
+
+
+
<table>
<tr>
<td><p>Enum.FOO :</p></td>
@@ -25,4 +31,5 @@
</table>
+
</page>
diff --git a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-property-example.page b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-property-example.page
index 3b791bd0..3665e432 100644
--- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-property-example.page
+++ b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-property-example.page
@@ -17,8 +17,14 @@
"property-example" {unicode: gint8} : Read / Write
</code></synopsis>
+
<p>This is an example of how to document a property.</p>
-
+
+ <p>Since 0.99</p>
+
+
+
+
</page>
diff --git a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-signal-example.page b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-signal-example.page
index 8cac161f..1c43387d 100644
--- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-signal-example.page
+++ b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-signal-example.page
@@ -16,8 +16,14 @@
<synopsis><code mime="text/x-python">
def callback(obj, int_param, float_param, pointer_param, user_param1, ...)
</code></synopsis>
-<p>This is an example of how to document a signal.</p>
+
+ <p>This is an example of how to document a signal.</p>
+
+
+ <p>Since 0.99</p>
+
+
<table>
<tr>
<td><p>obj :</p></td>
@@ -45,8 +51,6 @@ def callback(obj, int_param, float_param, pointer_param, user_param1, ...)
</tr>
</table>
- <p>Since 0.99</p>
-
</page>
diff --git a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-vfunc.page b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-vfunc.page
index 11d693f3..502ba220 100644
--- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-vfunc.page
+++ b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-vfunc.page
@@ -18,9 +18,13 @@
def do_vfunc(self, first_arg):
</code></synopsis>
+
<p>This is an example of how to document a vfunc.</p>
-
+
+ <p>Since 0.99</p>
+
+
<table>
<tr>
<td><p>first_arg :</p></td>
@@ -28,8 +32,6 @@ def do_vfunc(self, first_arg):
</tr>
</table>
- <p>Since 0.99</p>
-
</page>
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 89f73d08..7f12c10f 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
@@ -49,10 +49,14 @@ def method(self, first_arg, second_arg, boolean_arg, pointer_arg, string):
# Python wrapper for doc_examples_obj_method()
</code></synopsis>
+
<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">Obj.new</link>.</p><p>This should be a %FALSEALARM.</p>
-
+
+ <p>Since 0.99</p>
+
+
<table>
<tr>
<td><p>first_arg :</p></td>
@@ -80,8 +84,6 @@ created with <link xref="DocExamples.Obj.new">Obj.new</link>.</p><p>This should
</tr>
</table>
- <p>Since 0.99</p>
-
</page>
diff --git a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.page b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.page
index 6278c649..8a0e3c2b 100644
--- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.page
+++ b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.page
@@ -12,17 +12,18 @@
</info>
<title>DocExamples.Obj</title>
-
- <p>This is an example of how to document a class</p><p>This class has a signal: <link xref="DocExamples.Obj-signal-example">DocExamples.Obj::signal-example</link>.</p><p>And also has a property: <link xref="DocExamples.Obj-property-example">DocExamples.Obj:property-example</link>.</p>
-
<synopsis><code>
from gi.repository import DocExamples
obj = DocExamples.Obj(<link xref='DocExamples.Obj-property-example'>property_example</link>=value) </code></synopsis>
+ <p>This is an example of how to document a class</p><p>This class has a signal: <link xref="DocExamples.Obj-signal-example">DocExamples.Obj::signal-example</link>.</p><p>And also has a property: <link xref="DocExamples.Obj-property-example">DocExamples.Obj:property-example</link>.</p>
+
+
<p>Since 0.99</p>
+
<synopsis>
<title>Hierarchy</title>
<tree>
@@ -34,6 +35,8 @@ obj = DocExamples.Obj(<link xref='DocExamples.Obj-property-example'>property_exa
</item>
</tree>
</synopsis>
+
+
<links type="topic" ui:expanded="yes"
api:type="function" api:mime="text/x-python"
groups="method" style="linklist">
@@ -57,5 +60,4 @@ obj = DocExamples.Obj(<link xref='DocExamples.Obj-property-example'>property_exa
<title>Other</title>
</links>
-
</page>
diff --git a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.static_method.page b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.static_method.page
index 3bc402b2..32c53163 100644
--- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.static_method.page
+++ b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.static_method.page
@@ -29,10 +29,13 @@ def static_method(out_arg):
# Python wrapper for doc_examples_obj_static_method()
</code></synopsis>
+
<p>This is an example of a function with an out argument
and a return value.</p>
-
+
+
+
<table>
<tr>
<td><p>out_arg :</p></td>
@@ -45,6 +48,5 @@ and a return value.</p>
</table>
-
</page>
diff --git a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.array_function.page b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.array_function.page
index 6dd79093..a4bb49d2 100644
--- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.array_function.page
+++ b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.array_function.page
@@ -29,10 +29,13 @@ def array_function(out_len):
# Python wrapper for doc_examples_array_function()
</code></synopsis>
+
<p>This function returns an array with an explicit length,
and the length should be invisible in most introspected bindings.</p>
-
+
+
+
<table>
<tr>
<td><p>out_len :</p></td>
@@ -45,6 +48,5 @@ and the length should be invisible in most introspected bindings.</p>
</table>
-
</page>
diff --git a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.callback_function.page b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.callback_function.page
index 7c15a0c9..a8416e78 100644
--- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.callback_function.page
+++ b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.callback_function.page
@@ -37,11 +37,14 @@ def callback_function(callback, user_data, destroy_notify):
# Python wrapper for doc_examples_callback_function()
</code></synopsis>
+
<p>This is a function that takes a callback. Different languages
will expose this in different ways (e.g. Python keeps the
<code>user_data</code> parameter, while JS doesn't)</p>
-
+
+
+
<table>
<tr>
<td><p>callback :</p></td>
@@ -62,6 +65,5 @@ will expose this in different ways (e.g. Python keeps the
</table>
-
</page>
diff --git a/tests/doctool/DocExamples-1.0-Python-expected/index.page b/tests/doctool/DocExamples-1.0-Python-expected/index.page
index 5143b432..de98563c 100644
--- a/tests/doctool/DocExamples-1.0-Python-expected/index.page
+++ b/tests/doctool/DocExamples-1.0-Python-expected/index.page
@@ -12,6 +12,14 @@
</info>
<title>Index</title>
+
+
+
+
+
+
+
+
<links type="topic" ui:expanded="yes" groups="class" style="linklist">
<title>Classes</title>
</links>
@@ -22,5 +30,4 @@
<title>Other</title>
</links>
-
</page>