diff options
author | Jasper St. Pierre <jstpierre@mecheye.net> | 2013-01-31 12:52:23 -0500 |
---|---|---|
committer | Jasper St. Pierre <jstpierre@mecheye.net> | 2013-02-01 19:47:41 -0500 |
commit | 7e0ab2b629691c5904e00f4890a2da052a0a9c37 (patch) | |
tree | 61682b838570c4ae2043871c446815e169d2191c | |
parent | 9c68ba7c6f8b6b7367ccad1877d28cd526045961 (diff) | |
download | gobject-introspection-7e0ab2b629691c5904e00f4890a2da052a0a9c37.tar.gz |
doctool: Define a standard order of items for all pages
36 files changed, 190 insertions, 72 deletions
diff --git a/giscanner/doctemplates/C/mallard-C-class.tmpl b/giscanner/doctemplates/C/mallard-C-class.tmpl index b1be35e4..a627ace4 100644 --- a/giscanner/doctemplates/C/mallard-C-class.tmpl +++ b/giscanner/doctemplates/C/mallard-C-class.tmpl @@ -1,8 +1,6 @@ <%! page_type="guide" %>\ <%inherit file="mallard-base.tmpl"/> -<%block name="content"> -${parent.content()} -${self.since_version()} +<%block name="synopsis"> <synopsis ui:expanded="no"> <title>Hierarchy</title> <tree> @@ -11,6 +9,8 @@ ${self.since_version()} </item> </tree> </synopsis> +</%block> +<%block name="links"> <links type="topic" ui:expanded="yes" api:type="function" api:mime="text/x-csrc" groups="constructor" style="linklist"> diff --git a/giscanner/doctemplates/C/mallard-C-function.tmpl b/giscanner/doctemplates/C/mallard-C-function.tmpl index f93fc31d..e0af6413 100644 --- a/giscanner/doctemplates/C/mallard-C-function.tmpl +++ b/giscanner/doctemplates/C/mallard-C-function.tmpl @@ -28,7 +28,7 @@ % endfor </api:function> </%block> -<%block name="content"> +<%block name="synopsis"> <synopsis><code mime="text/x-csrc"> ${node.retval.type.ctype} ${node.symbol} (\ % if node.is_method: @@ -58,7 +58,8 @@ ${formatter.format_type(arg.type) | x} ${arg.argname}\ %endif % endfor </code></synopsis> -${parent.content()} +</%block> +<%block name="details"> % if node.parameters or node.retval: <table> % for arg, ix in zip(node.parameters, range(len(node.parameters))): @@ -75,5 +76,4 @@ ${parent.content()} % endif </table> % endif -${self.since_version()} </%block> diff --git a/giscanner/doctemplates/C/mallard-C-namespace.tmpl b/giscanner/doctemplates/C/mallard-C-namespace.tmpl index 372cd33f..28cd4708 100644 --- a/giscanner/doctemplates/C/mallard-C-namespace.tmpl +++ b/giscanner/doctemplates/C/mallard-C-namespace.tmpl @@ -1,6 +1,8 @@ <%! page_type="guide" %>\ <%inherit file="mallard-base.tmpl"/> -<%block name="content"> +<%block name="doc"> +</%block> +<%block name="links"> <links type="topic" ui:expanded="yes" groups="class" style="linklist"> <title>Classes</title> </links> @@ -11,3 +13,5 @@ <title>Other</title> </links> </%block> +<%block name="since_version"> +</%block> diff --git a/giscanner/doctemplates/C/mallard-C-vfunc.tmpl b/giscanner/doctemplates/C/mallard-C-vfunc.tmpl index b27b2cef..9cea1676 100644 --- a/giscanner/doctemplates/C/mallard-C-vfunc.tmpl +++ b/giscanner/doctemplates/C/mallard-C-vfunc.tmpl @@ -2,10 +2,11 @@ <%block name="info"> <link type="guide" xref="${namespace.name}.${node.parent.name}" group="vfunc"/> </%block> -<%block name="content"> +<%block name="synopsis"> <synopsis><code mime="text/x-csrc"> </code></synopsis> -${parent.content()} +</%block> +<%block name="details"> % if node.parameters or node.retval: <table> % for arg, ix in zip(node.parameters, range(len(node.parameters))): @@ -22,5 +23,4 @@ ${parent.content()} % endif </table> % endif -${self.since_version()} </%block> diff --git a/giscanner/doctemplates/Python/mallard-Python-class.tmpl b/giscanner/doctemplates/Python/mallard-Python-class.tmpl index 3f0d67a1..f4de812d 100644 --- a/giscanner/doctemplates/Python/mallard-Python-class.tmpl +++ b/giscanner/doctemplates/Python/mallard-Python-class.tmpl @@ -1,6 +1,5 @@ <%inherit file="mallard-base.tmpl"/> -<%block name="content"> - ${parent.content()} +<%block name="synopsis"> <synopsis><code> from gi.repository import ${namespace.name} @@ -15,8 +14,8 @@ ${formatter.to_underscores(node.name).lower()} = ${namespace.name}.${node.name}( % endfor )\ </code></synopsis> - - ${self.since_version()} +</%block> +<%block name="details"> <synopsis> <title>Hierarchy</title> <tree> @@ -29,6 +28,8 @@ ${formatter.to_underscores(node.name).lower()} = ${namespace.name}.${node.name}( % endfor </tree> </synopsis> +</%block> +<%block name="links"> <links type="topic" ui:expanded="yes" api:type="function" api:mime="text/x-python" groups="method" style="linklist"> diff --git a/giscanner/doctemplates/Python/mallard-Python-enum.tmpl b/giscanner/doctemplates/Python/mallard-Python-enum.tmpl index 09f4d9a8..3c38f884 100644 --- a/giscanner/doctemplates/Python/mallard-Python-enum.tmpl +++ b/giscanner/doctemplates/Python/mallard-Python-enum.tmpl @@ -1,6 +1,5 @@ <%inherit file="mallard-base.tmpl"/> -<%block name="content"> - ${formatter.format(node, node.doc)} +<%block name="details"> % if node.members: <table> % for member, ix in zip(node.members, range(len(node.members))): diff --git a/giscanner/doctemplates/Python/mallard-Python-function.tmpl b/giscanner/doctemplates/Python/mallard-Python-function.tmpl index 683ca835..1dbba1ee 100644 --- a/giscanner/doctemplates/Python/mallard-Python-function.tmpl +++ b/giscanner/doctemplates/Python/mallard-Python-function.tmpl @@ -28,7 +28,7 @@ % endfor </api:function> </%block> -<%block name="content"> +<%block name="synopsis"> <synopsis><code mime="text/x-python"> % if len(node.parameters) != 0: @accepts(\ @@ -45,8 +45,8 @@ ${', '.join((arg.argname for arg in node.parameters))}\ ): # Python wrapper for ${node.symbol}() </code></synopsis> -${parent.content()} - +</%block> +<%block name="details"> % if node.parameters or node.retval: <table> % for arg, ix in zip(node.parameters, range(len(node.parameters))): @@ -63,5 +63,4 @@ ${parent.content()} % endif </table> % endif -${self.since_version()} </%block> diff --git a/giscanner/doctemplates/Python/mallard-Python-namespace.tmpl b/giscanner/doctemplates/Python/mallard-Python-namespace.tmpl index 372cd33f..28cd4708 100644 --- a/giscanner/doctemplates/Python/mallard-Python-namespace.tmpl +++ b/giscanner/doctemplates/Python/mallard-Python-namespace.tmpl @@ -1,6 +1,8 @@ <%! page_type="guide" %>\ <%inherit file="mallard-base.tmpl"/> -<%block name="content"> +<%block name="doc"> +</%block> +<%block name="links"> <links type="topic" ui:expanded="yes" groups="class" style="linklist"> <title>Classes</title> </links> @@ -11,3 +13,5 @@ <title>Other</title> </links> </%block> +<%block name="since_version"> +</%block> diff --git a/giscanner/doctemplates/Python/mallard-Python-property.tmpl b/giscanner/doctemplates/Python/mallard-Python-property.tmpl index db78f2b9..32d673b2 100644 --- a/giscanner/doctemplates/Python/mallard-Python-property.tmpl +++ b/giscanner/doctemplates/Python/mallard-Python-property.tmpl @@ -3,9 +3,8 @@ <link type="guide" xref="${namespace.name}.${node.parent.name}" group="property"/> <title type="link" role="topic">${node.name}</title> </%block> -<%block name="content"> +<%block name="synopsis"> <synopsis><code mime="text/x-python"> "${node.name}" ${formatter.format_type(node.type)} : ${formatter.format_property_flags(node)} </code></synopsis> -${parent.content()} </%block> diff --git a/giscanner/doctemplates/Python/mallard-Python-signal.tmpl b/giscanner/doctemplates/Python/mallard-Python-signal.tmpl index a430d9b9..eccede7c 100644 --- a/giscanner/doctemplates/Python/mallard-Python-signal.tmpl +++ b/giscanner/doctemplates/Python/mallard-Python-signal.tmpl @@ -3,7 +3,7 @@ <link type="guide" xref="${namespace.name}.${node.parent.name}" group="signal"/> <title type="link" role="topic">${node.name}</title> </%block> -<%block name="content"> +<%block name="synopsis"> <synopsis><code mime="text/x-python"> def callback(${formatter.to_underscores(node.parent.name).lower()}, \ % for arg, ix in zip(node.parameters, range(len(node.parameters))): @@ -11,8 +11,8 @@ ${arg.argname}, \ % endfor user_param1, ...) </code></synopsis> -${formatter.format(node, node.doc)} - +</%block> +<%block name="details"> <table> <tr> <td><p>${formatter.to_underscores(node.parent.name).lower()} :</p></td> @@ -41,6 +41,5 @@ ${formatter.format(node, node.doc)} </tr> % endif </table> -${self.since_version()} </%block> diff --git a/giscanner/doctemplates/Python/mallard-Python-vfunc.tmpl b/giscanner/doctemplates/Python/mallard-Python-vfunc.tmpl index 65af0058..32230704 100644 --- a/giscanner/doctemplates/Python/mallard-Python-vfunc.tmpl +++ b/giscanner/doctemplates/Python/mallard-Python-vfunc.tmpl @@ -1,5 +1,5 @@ <%inherit file="mallard-base.tmpl"/> -<%block name="content"> +<%block name="synopsis"> <synopsis><code mime="text/x-python"> % if len(node.parameters) != 0: @accepts(\ @@ -12,8 +12,8 @@ do_${node.name}(self, \ ${', '.join((arg.argname for arg in node.parameters))}\ ): </code></synopsis> -${parent.content()} - +</%block> +<%block name="details"> % if node.parameters or node.retval: <table> % for arg, ix in zip(node.parameters, range(len(node.parameters))): @@ -30,5 +30,4 @@ ${parent.content()} % endif </table> % endif -${self.since_version()} </%block> diff --git a/giscanner/doctemplates/mallard-base.tmpl b/giscanner/doctemplates/mallard-base.tmpl index 07eb4468..e40739c3 100644 --- a/giscanner/doctemplates/mallard-base.tmpl +++ b/giscanner/doctemplates/mallard-base.tmpl @@ -12,12 +12,18 @@ </%block> </info> <title><%block name="title">${formatter.format_page_name(node)}</%block></title> - <%block name="content"> + <%block name="synopsis"> + </%block> + <%block name="doc"> ${formatter.format(node, node.doc)} </%block> - <%def name="since_version()"> + <%block name="since_version"> % if node.version: <p>Since ${node.version}</p> % endif - </%def> + </%block> + <%block name="details"> + </%block> + <%block name="links"> + </%block> </page> 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> |