diff options
Diffstat (limited to 'tests/doctool')
39 files changed, 0 insertions, 1915 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 deleted file mode 100644 index 621485cf..00000000 --- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Callback.page +++ /dev/null @@ -1,25 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Callback" - type="topic" - style="default" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index"/> - - </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 deleted file mode 100644 index 6957f4b7..00000000 --- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Enum.page +++ /dev/null @@ -1,25 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Enum" - type="guide" - style="enum" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index"/> - - </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 deleted file mode 100644 index 90982bf2..00000000 --- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-property-example.page +++ /dev/null @@ -1,27 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Obj-property-example" - type="topic" - style="property" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="DocExamples.Obj" group="property"/> - <title type="link" role="topic">property-example</title> - - </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 deleted file mode 100644 index 8502865c..00000000 --- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-signal-example.page +++ /dev/null @@ -1,42 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Obj-signal-example" - type="topic" - style="signal" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="DocExamples.Obj" group="property"/> - <title type="link" role="topic">signal-example</title> - - </info> - <title>DocExamples.Obj::signal-example</title> - -<synopsis><code mime="text/x-csrc"> -void signal-example (guint int_param, - guint float_param, - gpointer pointer_param); -</code></synopsis> - - - <p>This is an example of how to document a signal.</p> - - - <p>Since 0.99</p> - - -<dl> -<dt><p>int_param :</p></dt> -<dd><p>a parameter of type int</p></dd> -<dt><p>float_param :</p></dt> -<dd><p>a parameter of type float</p></dd> -<dt><p>pointer_param :</p></dt> -<dd><p>A pointer to @obj's thingy -- pass <code>int_param</code> if you really want to.</p></dd> -<dt><p>Returns :</p></dt> -<dd></dd> -</dl> - - - -</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 deleted file mode 100644 index 7ff7e568..00000000 --- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-vfunc.page +++ /dev/null @@ -1,38 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Obj-vfunc" - type="topic" - style="vfunc" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="DocExamples.Obj" group="vfunc"/> - - </info> - <title>DocExamples.Obj::vfunc</title> - -<synopsis><code mime="text/x-csrc"> -void vfunc (DocExamplesObj* self, - gint first_arg); -</code></synopsis> - - - <p>This is an example of how to document a vfunc.</p> - - - <p>Since 0.99</p> - - -<dl> -<dt><p>self :</p></dt> -<dd></dd> -<dt><p>first_arg :</p></dt> -<dd><p>first argument</p></dd> -<dt><p>Returns :</p></dt> -<dd></dd> -</dl> - - - -</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 deleted file mode 100644 index b154b8de..00000000 --- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.method.page +++ /dev/null @@ -1,82 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Obj.method" - type="topic" - style="method" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="DocExamples.Obj" group="method"/> - <api:function> - <api:returns> - <api:type>gboolean</api:type> - </api:returns> - <api:name>doc_examples_obj_method</api:name> - <api:arg> - <api:type>DocExamplesObj*</api:type> - <api:name>obj</api:name> - </api:arg> - <api:arg> - <api:type>gint</api:type> - <api:name>first_arg</api:name> - </api:arg> - <api:arg> - <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"> -gboolean doc_examples_obj_method (DocExamplesObj* obj, - gint first_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>You should call this on a <link xref="DocExamples.Obj"/> that was -created with <link xref="DocExamples.Obj.new"/>, by passing it -in as <code>obj</code>.</p><p>This should be a %FALSEALARM.</p> - - - <p>Since 0.99</p> - - -<dl> -<dt><p>obj :</p></dt> -<dd><p>A <link xref="DocExamples.Obj"/>.</p></dd> -<dt><p>first_arg :</p></dt> -<dd><p>first argument</p></dd> -<dt><p>second_arg :</p></dt> -<dd><p>second argument</p></dd> -<dt><p>boolean_arg :</p></dt> -<dd><p>You should always pass <code>TRUE</code>.</p></dd> -<dt><p>pointer_arg :</p></dt> -<dd><p>If not <code>NULL</code>, do a thing. Pass <code>first_arg</code> if you want to sometimes. You can also pass <code>second_arg</code>, or even <code>boolean_arg</code>.</p></dd> -<dt><p>string :</p></dt> -<dd><p>A NUL-terminated string.</p></dd> -<dt><p>Returns :</p></dt> -<dd><p>Either <code>FALSE</code> or something <code>FALSE</code>-y.</p></dd> -</dl> - - - -</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 deleted file mode 100644 index ceef763d..00000000 --- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.new.page +++ /dev/null @@ -1,38 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Obj.new" - type="topic" - style="constructor" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="DocExamples.Obj" group="constructor"/> - <api:function> - <api:returns> - <api:type>DocExamplesObj*</api:type> - </api:returns> - <api:name>doc_examples_obj_new</api:name> - </api:function> - - </info> - <title>doc_examples_obj_new</title> - -<synopsis><code mime="text/x-csrc"> -DocExamplesObj* doc_examples_obj_new (void); -</code></synopsis> - - - - - - - -<dl> -<dt><p>Returns :</p></dt> -<dd></dd> -</dl> - - - -</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 deleted file mode 100644 index 9448bbb6..00000000 --- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.page +++ /dev/null @@ -1,59 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Obj" - type="guide" - style="class" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index"/> - - </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"/>.</p><p>And also has a property: <link xref="DocExamples.Obj-property-example"/>.</p> - - - <p>Since 0.99</p> - - - <synopsis> - <title>Hierarchy</title> - <tree> - <item> - <code>GObject.Object</code> - <item> - <code>DocExamples.Obj</code> - </item> - </item> - </tree> - </synopsis> - - - <links type="topic" ui:expanded="true" - api:type="function" api:mime="text/x-csrc" - groups="method" style="linklist"> - <title>Methods</title> - </links> - <links type="topic" ui:expanded="true" - api:type="function" api:mime="text/x-csrc" - groups="function" style="linklist"> - <title>Functions</title> - </links> - <links type="topic" ui:expanded="true" groups="property" style="linklist"> - <title>Properties</title> - </links> - <links type="topic" ui:expanded="true" groups="signal" style="linklist"> - <title>Signals</title> - </links> - <links type="topic" ui:expanded="true" groups="vfunc" style="linklist"> - <title>Virtual functions</title> - </links> - <links type="topic" ui:expanded="true" groups="#first #default #last" style="linklist"> - <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 deleted file mode 100644 index 99345e0e..00000000 --- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.static_method.page +++ /dev/null @@ -1,45 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Obj.static_method" - type="topic" - style="function" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="DocExamples.Obj" group="function"/> - <api:function> - <api:returns> - <api:type>gboolean</api:type> - </api:returns> - <api:name>doc_examples_obj_static_method</api:name> - <api:arg> - <api:type>gint*</api:type> - <api:name>out_arg</api:name> - </api:arg> - </api:function> - - </info> - <title>doc_examples_obj_static_method</title> - -<synopsis><code mime="text/x-csrc"> -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> - - - - -<dl> -<dt><p>out_arg :</p></dt> -<dd><p>a pointer to int, or <code>NULL</code> to ignore</p></dd> -<dt><p>Returns :</p></dt> -<dd><p><code>TRUE</code> if <code>out_arg</code> is valid, <code>FALSE</code> otherwise</p></dd> -</dl> - - - -</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 deleted file mode 100644 index fe95df74..00000000 --- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.ObjClass.page +++ /dev/null @@ -1,25 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.ObjClass" - type="topic" - style="record" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index"/> - - </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 deleted file mode 100644 index c3dfc238..00000000 --- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.array_function.page +++ /dev/null @@ -1,45 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.array_function" - type="topic" - style="function" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index" group="function"/> - <api:function> - <api:returns> - <api:type>gint*</api:type> - </api:returns> - <api:name>doc_examples_array_function</api:name> - <api:arg> - <api:type>gint*</api:type> - <api:name>out_len</api:name> - </api:arg> - </api:function> - - </info> - <title>doc_examples_array_function</title> - -<synopsis><code mime="text/x-csrc"> -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> - - - - -<dl> -<dt><p>out_len :</p></dt> -<dd><p>the length of the returned array</p></dd> -<dt><p>Returns :</p></dt> -<dd><p>an array of numbers.</p></dd> -</dl> - - - -</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 deleted file mode 100644 index 0688cbb9..00000000 --- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.callback_function.page +++ /dev/null @@ -1,60 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.callback_function" - type="topic" - style="function" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index" group="function"/> - <api:function> - <api:returns> - <api:type>DocExamplesEnum</api:type> - </api:returns> - <api:name>doc_examples_callback_function</api:name> - <api:arg> - <api:type>DocExamplesCallback</api:type> - <api:name>callback</api:name> - </api:arg> - <api:arg> - <api:type>gpointer</api:type> - <api:name>user_data</api:name> - </api:arg> - <api:arg> - <api:type>GDestroyNotify</api:type> - <api:name>destroy_notify</api:name> - </api:arg> - </api:function> - - </info> - <title>doc_examples_callback_function</title> - -<synopsis><code mime="text/x-csrc"> -DocExamplesEnum doc_examples_callback_function (DocExamplesCallback callback, - gpointer user_data, - 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> - - - - -<dl> -<dt><p>callback :</p></dt> -<dd><p>Just Call Me Maybe</p></dd> -<dt><p>user_data :</p></dt> -<dd><p>your stuff</p></dd> -<dt><p>destroy_notify :</p></dt> -<dd><p>how to get rid of <code>user_data</code></p></dd> -<dt><p>Returns :</p></dt> -<dd><p><link xref="DocExamples.Enum"/>.foo sometimes, <link xref="DocExamples.Enum"/>.bar other times.</p></dd> -</dl> - - - -</page> diff --git a/tests/doctool/DocExamples-1.0-C-expected/index.page b/tests/doctool/DocExamples-1.0-C-expected/index.page deleted file mode 100644 index 1d89dedd..00000000 --- a/tests/doctool/DocExamples-1.0-C-expected/index.page +++ /dev/null @@ -1,33 +0,0 @@ -<?xml version="1.0"?> -<page id="index" - type="guide" - style="namespace" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index"/> - - </info> - <title>Index</title> - - - - - - - - - - <links type="topic" ui:expanded="true" groups="class" style="linklist"> - <title>Classes</title> - </links> - <links type="topic" ui:expanded="true" groups="function" style="linklist"> - <title>Functions</title> - </links> - <links type="topic" ui:expanded="true" groups="#first #default #last" style="linklist"> - <title>Other</title> - </links> - -</page> diff --git a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Callback.page b/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Callback.page deleted file mode 100644 index 621485cf..00000000 --- a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Callback.page +++ /dev/null @@ -1,25 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Callback" - type="topic" - style="default" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index"/> - - </info> - <title>DocExamples.Callback</title> - - - - - - - - - - - -</page> diff --git a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Enum.page b/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Enum.page deleted file mode 100644 index a3e64bc5..00000000 --- a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Enum.page +++ /dev/null @@ -1,31 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Enum" - type="topic" - style="enum" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index"/> - - </info> - <title>DocExamples.Enum</title> - - - - <p>This is an example to document an enumeration.</p> - - - - -<dl> -<dt><p>Enum.FOO :</p></dt> -<dd><p>a foo</p></dd> -<dt><p>Enum.BAR :</p></dt> -<dd><p>a bar</p></dd> -</dl> - - - -</page> diff --git a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj-property-example.page b/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj-property-example.page deleted file mode 100644 index 59d90f4d..00000000 --- a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj-property-example.page +++ /dev/null @@ -1,30 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Obj-property-example" - type="topic" - style="property" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="DocExamples.Obj" group="property"/> - <title type="link" role="topic">property-example</title> - - </info> - <title>DocExamples.Obj:property-example</title> - -<synopsis><code mime="text/x-python"> -"property-example" {String: 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-Gjs-expected/DocExamples.Obj-signal-example.page b/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj-signal-example.page deleted file mode 100644 index 074ccd2b..00000000 --- a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj-signal-example.page +++ /dev/null @@ -1,44 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Obj-signal-example" - type="topic" - style="signal" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="DocExamples.Obj" group="signal"/> - <title type="link" role="topic">signal-example</title> - - </info> - <title>DocExamples.Obj::signal-example</title> - -<synopsis><code mime="text/x-python"> -function callback(obj, int_param:Number, float_param:Number, pointer_param:gpointer, user_param1, ...):void; -</code></synopsis> - - - <p>This is an example of how to document a signal.</p> - - - <p>Since 0.99</p> - - -<dl> -<dt><p>obj :</p></dt> -<dd><p>instance of DocExamples.Obj that is emitting the signal</p></dd> -<dt><p>int_param :</p></dt> -<dd><p>a parameter of type int</p></dd> -<dt><p>float_param :</p></dt> -<dd><p>a parameter of type float</p></dd> -<dt><p>pointer_param :</p></dt> -<dd><p>A pointer to @obj's thingy -- pass <code>int_param</code> if you really want to.</p></dd> -<dt><p>user_param1 :</p></dt> -<dd><p>first user parameter (if any) specified with the connect() method</p></dd> -<dt><p>... :</p></dt> -<dd><p>additional user parameters (if any)</p></dd> -</dl> - - - -</page> diff --git a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj-vfunc.page b/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj-vfunc.page deleted file mode 100644 index 87c38e63..00000000 --- a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj-vfunc.page +++ /dev/null @@ -1,34 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Obj-vfunc" - type="topic" - style="vfunc" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index"/> - - </info> - <title>DocExamples.Obj::vfunc</title> - -<synopsis><code mime="text/x-gjs"> -function vfunc_vfunc(first_arg:Number):void { -} -</code></synopsis> - - - <p>This is an example of how to document a vfunc.</p> - - - <p>Since 0.99</p> - - -<dl> -<dt><p>first_arg :</p></dt> -<dd><p>first argument</p></dd> -</dl> - - - -</page> 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 deleted file mode 100644 index abe38df2..00000000 --- a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj.method.page +++ /dev/null @@ -1,73 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Obj.method" - type="topic" - style="method" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="DocExamples.Obj" group="method"/> - <api:function> - <api:returns> - <api:type>Boolean</api:type> - </api:returns> - <api:name>doc_examples_obj_method</api:name> - <api:arg> - <api:type>Number</api:type> - <api:name>first_arg</api:name> - </api:arg> - <api:arg> - <api:type>Number</api:type> - <api:name>second_arg</api:name> - </api:arg> - <api:arg> - <api:type>Boolean</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>String</api:type> - <api:name>string</api:name> - </api:arg> - </api:function> - - </info> - <title>Obj.prototype.method</title> - -<synopsis><code mime="text/x-gjs"> -function method(first_arg:Number, second_arg:Number, boolean_arg:Boolean, pointer_arg:gpointer, string:String):Boolean { - // Gjs 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"/> that was -created with <link xref="DocExamples.Obj.new"/>, by passing it -in as <code>obj</code>.</p><p>This should be a %FALSEALARM.</p> - - - <p>Since 0.99</p> - - -<dl> -<dt><p>first_arg :</p></dt> -<dd><p>first argument</p></dd> -<dt><p>second_arg :</p></dt> -<dd><p>second argument</p></dd> -<dt><p>boolean_arg :</p></dt> -<dd><p>You should always pass <code>true</code>.</p></dd> -<dt><p>pointer_arg :</p></dt> -<dd><p>If not <code>null</code>, do a thing. Pass <code>first_arg</code> if you want to sometimes. You can also pass <code>second_arg</code>, or even <code>boolean_arg</code>.</p></dd> -<dt><p>string :</p></dt> -<dd><p>A NUL-terminated string.</p></dd> -<dt><p>Returns :</p></dt> -<dd><p>Either <code>false</code> or something <code>false</code>-y.</p></dd> -</dl> - - - -</page> diff --git a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj.new.page b/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj.new.page deleted file mode 100644 index 2dab7439..00000000 --- a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj.new.page +++ /dev/null @@ -1,40 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Obj.new" - type="topic" - style="constructor" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="DocExamples.Obj" group="constructor"/> - <api:function> - <api:returns> - <api:type>DocExamples.Obj</api:type> - </api:returns> - <api:name>doc_examples_obj_new</api:name> - </api:function> - - </info> - <title>Obj.new</title> - -<synopsis><code mime="text/x-gjs"> -function new():DocExamples.Obj { - // Gjs wrapper for doc_examples_obj_new() -} -</code></synopsis> - - - - - - - -<dl> -<dt><p>Returns :</p></dt> -<dd></dd> -</dl> - - - -</page> diff --git a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj.page b/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj.page deleted file mode 100644 index 378f27d1..00000000 --- a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj.page +++ /dev/null @@ -1,63 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Obj" - type="guide" - style="class" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index"/> - - </info> - <title>DocExamples.Obj</title> - - <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"/>.</p><p>And also has a property: <link xref="DocExamples.Obj-property-example"/>.</p> - - - <p>Since 0.99</p> - - - <synopsis> - <title>Hierarchy</title> - <tree> - <item> - <code>GObject.Object</code> - <item> - <code>DocExamples.Obj</code> - </item> - </item> - </tree> - </synopsis> - - - <links type="topic" ui:expanded="true" - api:type="function" api:mime="text/x-gjs" - groups="method" style="linklist"> - <title>Methods</title> - </links> - <links type="topic" ui:expanded="true" - api:type="function" api:mime="text/x-gjs" - groups="function" style="linklist"> - <title>Functions</title> - </links> - <links type="topic" ui:expanded="true" groups="property" style="linklist"> - <title>Properties</title> - </links> - <links type="topic" ui:expanded="true" groups="signal" style="linklist"> - <title>Signals</title> - </links> - <links type="topic" ui:expanded="true" groups="vfunc" style="linklist"> - <title>Virtual functions</title> - </links> - <links type="topic" ui:expanded="true" groups="#first #default #last" style="linklist"> - <title>Other</title> - </links> - -</page> diff --git a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj.static_method.page b/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj.static_method.page deleted file mode 100644 index fd9e1007..00000000 --- a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj.static_method.page +++ /dev/null @@ -1,47 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Obj.static_method" - type="topic" - style="function" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="DocExamples.Obj" group="function"/> - <api:function> - <api:returns> - <api:type>Boolean</api:type> - </api:returns> - <api:name>doc_examples_obj_static_method</api:name> - <api:arg> - <api:type>Number</api:type> - <api:name>out_arg</api:name> - </api:arg> - </api:function> - - </info> - <title>static_method</title> - -<synopsis><code mime="text/x-gjs"> -function static_method(out_arg:Number):Boolean { - // Gjs 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> - - - - -<dl> -<dt><p>out_arg :</p></dt> -<dd><p>a pointer to int, or <code>null</code> to ignore</p></dd> -<dt><p>Returns :</p></dt> -<dd><p><code>true</code> if <code>out_arg</code> is valid, <code>false</code> otherwise</p></dd> -</dl> - - - -</page> diff --git a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.array_function.page b/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.array_function.page deleted file mode 100644 index 05583a26..00000000 --- a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.array_function.page +++ /dev/null @@ -1,47 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.array_function" - type="topic" - style="function" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index" group="function"/> - <api:function> - <api:returns> - <api:type>[Number]</api:type> - </api:returns> - <api:name>doc_examples_array_function</api:name> - <api:arg> - <api:type>Number</api:type> - <api:name>out_len</api:name> - </api:arg> - </api:function> - - </info> - <title>array_function</title> - -<synopsis><code mime="text/x-gjs"> -function array_function(out_len:Number):[Number] { - // Gjs 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> - - - - -<dl> -<dt><p>out_len :</p></dt> -<dd><p>the length of the returned array</p></dd> -<dt><p>Returns :</p></dt> -<dd><p>an array of numbers.</p></dd> -</dl> - - - -</page> diff --git a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.callback_function.page b/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.callback_function.page deleted file mode 100644 index cb449c74..00000000 --- a/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.callback_function.page +++ /dev/null @@ -1,48 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.callback_function" - type="topic" - style="function" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index" group="function"/> - <api:function> - <api:returns> - <api:type>DocExamples.Enum</api:type> - </api:returns> - <api:name>doc_examples_callback_function</api:name> - <api:arg> - <api:type>DocExamples.Callback</api:type> - <api:name>callback</api:name> - </api:arg> - </api:function> - - </info> - <title>callback_function</title> - -<synopsis><code mime="text/x-gjs"> -function callback_function(callback:DocExamples.Callback):DocExamples.Enum { - // Gjs 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> - - - - -<dl> -<dt><p>callback :</p></dt> -<dd><p>Just Call Me Maybe</p></dd> -<dt><p>Returns :</p></dt> -<dd><p><link xref="DocExamples.Enum"/>.foo sometimes, <link xref="DocExamples.Enum"/>.bar other times.</p></dd> -</dl> - - - -</page> diff --git a/tests/doctool/DocExamples-1.0-Gjs-expected/index.page b/tests/doctool/DocExamples-1.0-Gjs-expected/index.page deleted file mode 100644 index 1d89dedd..00000000 --- a/tests/doctool/DocExamples-1.0-Gjs-expected/index.page +++ /dev/null @@ -1,33 +0,0 @@ -<?xml version="1.0"?> -<page id="index" - type="guide" - style="namespace" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index"/> - - </info> - <title>Index</title> - - - - - - - - - - <links type="topic" ui:expanded="true" groups="class" style="linklist"> - <title>Classes</title> - </links> - <links type="topic" ui:expanded="true" groups="function" style="linklist"> - <title>Functions</title> - </links> - <links type="topic" ui:expanded="true" groups="#first #default #last" style="linklist"> - <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 deleted file mode 100644 index 621485cf..00000000 --- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Callback.page +++ /dev/null @@ -1,25 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Callback" - type="topic" - style="default" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index"/> - - </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 deleted file mode 100644 index a3e64bc5..00000000 --- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Enum.page +++ /dev/null @@ -1,31 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Enum" - type="topic" - style="enum" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index"/> - - </info> - <title>DocExamples.Enum</title> - - - - <p>This is an example to document an enumeration.</p> - - - - -<dl> -<dt><p>Enum.FOO :</p></dt> -<dd><p>a foo</p></dd> -<dt><p>Enum.BAR :</p></dt> -<dd><p>a bar</p></dd> -</dl> - - - -</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 deleted file mode 100644 index 98cafdf5..00000000 --- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-property-example.page +++ /dev/null @@ -1,30 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Obj-property-example" - type="topic" - style="property" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="DocExamples.Obj" group="property"/> - <title type="link" role="topic">property-example</title> - - </info> - <title>DocExamples.Obj:property-example</title> - -<synopsis><code mime="text/x-python"> -"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 deleted file mode 100644 index 1dc5d60d..00000000 --- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-signal-example.page +++ /dev/null @@ -1,44 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Obj-signal-example" - type="topic" - style="signal" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="DocExamples.Obj" group="signal"/> - <title type="link" role="topic">signal-example</title> - - </info> - <title>DocExamples.Obj::signal-example</title> - -<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>Since 0.99</p> - - -<dl> -<dt><p>obj :</p></dt> -<dd><p>instance of DocExamples.Obj that is emitting the signal</p></dd> -<dt><p>int_param :</p></dt> -<dd><p>a parameter of type int</p></dd> -<dt><p>float_param :</p></dt> -<dd><p>a parameter of type float</p></dd> -<dt><p>pointer_param :</p></dt> -<dd><p>A pointer to @obj's thingy -- pass <code>int_param</code> if you really want to.</p></dd> -<dt><p>user_param1 :</p></dt> -<dd><p>first user parameter (if any) specified with the connect() method</p></dd> -<dt><p>... :</p></dt> -<dd><p>additional user parameters (if any)</p></dd> -</dl> - - - -</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 deleted file mode 100644 index 94fe8f67..00000000 --- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-vfunc.page +++ /dev/null @@ -1,37 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Obj-vfunc" - type="topic" - style="vfunc" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index"/> - - </info> - <title>DocExamples.Obj::vfunc</title> - -<synopsis><code mime="text/x-python"> -@accepts(DocExamples.Obj, int) -@returns(none) -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> - - -<dl> -<dt><p>self :</p></dt> -<dd></dd> -<dt><p>first_arg :</p></dt> -<dd><p>first argument</p></dd> -</dl> - - - -</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 deleted file mode 100644 index 7b7c8fa0..00000000 --- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.method.page +++ /dev/null @@ -1,80 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Obj.method" - type="topic" - style="method" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="DocExamples.Obj" group="method"/> - <api:function> - <api:returns> - <api:type>bool</api:type> - </api:returns> - <api:name>doc_examples_obj_method</api:name> - <api:arg> - <api:type>DocExamples.Obj</api:type> - <api:name>self</api:name> - </api:arg> - <api:arg> - <api:type>int</api:type> - <api:name>first_arg</api:name> - </api:arg> - <api:arg> - <api:type>float</api:type> - <api:name>second_arg</api:name> - </api:arg> - <api:arg> - <api:type>bool</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>unicode</api:type> - <api:name>string</api:name> - </api:arg> - </api:function> - - </info> - <title>Obj.method</title> - -<synopsis><code mime="text/x-python"> -@accepts(DocExamples.Obj, int, float, bool, gpointer, unicode) -@returns(bool) -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"/> that was -created with <link xref="DocExamples.Obj.new"/>, by passing it -in as <code>self</code>.</p><p>This should be a %FALSEALARM.</p> - - - <p>Since 0.99</p> - - -<dl> -<dt><p>self :</p></dt> -<dd><p>A <link xref="DocExamples.Obj"/>.</p></dd> -<dt><p>first_arg :</p></dt> -<dd><p>first argument</p></dd> -<dt><p>second_arg :</p></dt> -<dd><p>second argument</p></dd> -<dt><p>boolean_arg :</p></dt> -<dd><p>You should always pass <code>True</code>.</p></dd> -<dt><p>pointer_arg :</p></dt> -<dd><p>If not <code>None</code>, do a thing. Pass <code>first_arg</code> if you want to sometimes. You can also pass <code>second_arg</code>, or even <code>boolean_arg</code>.</p></dd> -<dt><p>string :</p></dt> -<dd><p>A NUL-terminated string.</p></dd> -<dt><p>Returns :</p></dt> -<dd><p>Either <code>False</code> or something <code>False</code>-y.</p></dd> -</dl> - - - -</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 deleted file mode 100644 index 12cfad8c..00000000 --- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.page +++ /dev/null @@ -1,63 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Obj" - type="guide" - style="class" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index"/> - - </info> - <title>DocExamples.Obj</title> - - <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"/>.</p><p>And also has a property: <link xref="DocExamples.Obj-property-example"/>.</p> - - - <p>Since 0.99</p> - - - <synopsis> - <title>Hierarchy</title> - <tree> - <item> - <code>GObject.Object</code> - <item> - <code>DocExamples.Obj</code> - </item> - </item> - </tree> - </synopsis> - - - <links type="topic" ui:expanded="true" - api:type="function" api:mime="text/python" - groups="method" style="linklist"> - <title>Methods</title> - </links> - <links type="topic" ui:expanded="true" - api:type="function" api:mime="text/python" - groups="function" style="linklist"> - <title>Functions</title> - </links> - <links type="topic" ui:expanded="true" groups="property" style="linklist"> - <title>Properties</title> - </links> - <links type="topic" ui:expanded="true" groups="signal" style="linklist"> - <title>Signals</title> - </links> - <links type="topic" ui:expanded="true" groups="vfunc" style="linklist"> - <title>Virtual functions</title> - </links> - <links type="topic" ui:expanded="true" groups="#first #default #last" style="linklist"> - <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 deleted file mode 100644 index 6088a5e2..00000000 --- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.static_method.page +++ /dev/null @@ -1,48 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.Obj.static_method" - type="topic" - style="function" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="DocExamples.Obj" group="function"/> - <api:function> - <api:returns> - <api:type>bool</api:type> - </api:returns> - <api:name>doc_examples_obj_static_method</api:name> - <api:arg> - <api:type>int</api:type> - <api:name>out_arg</api:name> - </api:arg> - </api:function> - - </info> - <title>Obj.static_method</title> - -<synopsis><code mime="text/x-python"> -@accepts(int) -@returns(bool) -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> - - - - -<dl> -<dt><p>out_arg :</p></dt> -<dd><p>a pointer to int, or <code>None</code> to ignore</p></dd> -<dt><p>Returns :</p></dt> -<dd><p><code>True</code> if <code>out_arg</code> is valid, <code>False</code> otherwise</p></dd> -</dl> - - - -</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 deleted file mode 100644 index 506e40f3..00000000 --- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.array_function.page +++ /dev/null @@ -1,48 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.array_function" - type="topic" - style="function" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index" group="function"/> - <api:function> - <api:returns> - <api:type>[int]</api:type> - </api:returns> - <api:name>doc_examples_array_function</api:name> - <api:arg> - <api:type>int</api:type> - <api:name>out_len</api:name> - </api:arg> - </api:function> - - </info> - <title>array_function</title> - -<synopsis><code mime="text/x-python"> -@accepts(int) -@returns([int]) -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> - - - - -<dl> -<dt><p>out_len :</p></dt> -<dd><p>the length of the returned array</p></dd> -<dt><p>Returns :</p></dt> -<dd><p>an array of numbers.</p></dd> -</dl> - - - -</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 deleted file mode 100644 index 53f5861d..00000000 --- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.callback_function.page +++ /dev/null @@ -1,61 +0,0 @@ -<?xml version="1.0"?> -<page id="DocExamples.callback_function" - type="topic" - style="function" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index" group="function"/> - <api:function> - <api:returns> - <api:type>DocExamples.Enum</api:type> - </api:returns> - <api:name>doc_examples_callback_function</api:name> - <api:arg> - <api:type>DocExamples.Callback</api:type> - <api:name>callback</api:name> - </api:arg> - <api:arg> - <api:type>gpointer</api:type> - <api:name>user_data</api:name> - </api:arg> - <api:arg> - <api:type>GLib.DestroyNotify</api:type> - <api:name>destroy_notify</api:name> - </api:arg> - </api:function> - - </info> - <title>callback_function</title> - -<synopsis><code mime="text/x-python"> -@accepts(DocExamples.Callback, gpointer, GLib.DestroyNotify) -@returns(DocExamples.Enum) -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> - - - - -<dl> -<dt><p>callback :</p></dt> -<dd><p>Just Call Me Maybe</p></dd> -<dt><p>user_data :</p></dt> -<dd><p>your stuff</p></dd> -<dt><p>destroy_notify :</p></dt> -<dd><p>how to get rid of <code>user_data</code></p></dd> -<dt><p>Returns :</p></dt> -<dd><p><link xref="DocExamples.Enum"/>.foo sometimes, <link xref="DocExamples.Enum"/>.bar other times.</p></dd> -</dl> - - - -</page> diff --git a/tests/doctool/DocExamples-1.0-Python-expected/index.page b/tests/doctool/DocExamples-1.0-Python-expected/index.page deleted file mode 100644 index 1d89dedd..00000000 --- a/tests/doctool/DocExamples-1.0-Python-expected/index.page +++ /dev/null @@ -1,33 +0,0 @@ -<?xml version="1.0"?> -<page id="index" - type="guide" - style="namespace" - xmlns="http://projectmallard.org/1.0/" - xmlns:api="http://projectmallard.org/experimental/api/" - xmlns:ui="http://projectmallard.org/1.0/ui/"> - <info> - - <link type="guide" xref="index"/> - - </info> - <title>Index</title> - - - - - - - - - - <links type="topic" ui:expanded="true" groups="class" style="linklist"> - <title>Classes</title> - </links> - <links type="topic" ui:expanded="true" groups="function" style="linklist"> - <title>Functions</title> - </links> - <links type="topic" ui:expanded="true" groups="#first #default #last" style="linklist"> - <title>Other</title> - </links> - -</page> diff --git a/tests/doctool/Makefile.am b/tests/doctool/Makefile.am deleted file mode 100644 index 4d2b9d7f..00000000 --- a/tests/doctool/Makefile.am +++ /dev/null @@ -1,60 +0,0 @@ -include $(top_srcdir)/common.mk -include $(top_srcdir)/Makefile.introspection - -INTROSPECTION_SCANNER_ARGS += --warn-all --warn-error -I. - -check_LTLIBRARIES = \ - libdocexamples.la - -AM_CFLAGS = $(GOBJECT_CFLAGS) -LIBS = $(GOBJECT_LIBS) - -libdocexamples_la_SOURCES = $(srcdir)/doc-examples-obj.c $(srcdir)/doc-examples-obj.h - -GIRS = -TYPELIBS = $(GIRS:.gir=.typelib) -INTROSPECTION_GIRS = $(GIRS) -CHECK_TARGETS = $(GIRS:.gir=-C.page.check) $(GIRS:.gir=-Python.page.check) $(GIRS:.gir=-Gjs.page.check) -MALLARD_DIRS = $(GIRS:.gir=-C) $(GIRS:.gir=-Python) $(GIRS:.gir=-Gjs) -EXPECTED_MALLARD_DIRS = $(MALLARD_DIRS:=-expected) -CLEANFILES = $(TYPELIBS) $(GIRS) -BUILT_SOURCES = $(MALLARD_DIRS) -EXTRA_DIST = $(EXPECTED_MALLARD_DIRS) - -DocExamples-1.0.gir: $(top_builddir)/Gio-2.0.gir libdocexamples.la -DocExamples_1_0_gir_LIBS = libdocexamples.la -DocExamples_1_0_gir_INCLUDES = cairo-1.0 Gio-2.0 -DocExamples_1_0_gir_FILES = $(libdocexamples_la_SOURCES) -#DocExamples_1_0_gir_SCANNERFLAGS = --c-include="regress.h" -GIRS += DocExamples-1.0.gir - -%-C: %.gir - $(AM_V_GEN) - $(AM_V_at)$(MKDIR_P) $*-C - $(AM_V_at)rm -f $*-C/*.page - $(AM_V_at)$(INTROSPECTION_DOCTOOL) --language C $*.gir -o $*-C/ - -%-Python: %.gir - $(AM_V_GEN) - $(AM_V_at)$(MKDIR_P) $*-Python - $(AM_V_at)rm -f $*-Python/*.page - $(AM_V_at)$(INTROSPECTION_DOCTOOL) --language Python $*.gir -o $*-Python/ - -%-Gjs: %.gir - $(AM_V_GEN) - $(AM_V_at)$(MKDIR_P) $*-Gjs - $(AM_V_at)rm -f $*-Gjs/*.page - $(AM_V_at)$(INTROSPECTION_DOCTOOL) --language Gjs $*.gir -o $*-Gjs/ - -%-C.page.check: %-C - @diff -u -w -B -U 10 $(srcdir)/$*-C-expected $*-C && echo " TEST $*-C" - -%-Python.page.check: %-Python - @diff -u -w -B -U 10 $(srcdir)/$*-Python-expected $*-Python && echo " TEST $*-Python" - -%-Gjs.page.check: %-Gjs - @diff -u -w -B -U 10 $(srcdir)/$*-Gjs-expected $*-Gjs && echo " TEST $*-Gjs" - -check-local: $(CHECK_TARGETS) $(TYPELIBS) -clean-local: - @rm -rf $(MALLARD_DIRS) diff --git a/tests/doctool/doc-examples-obj.c b/tests/doctool/doc-examples-obj.c deleted file mode 100644 index fff1aaa5..00000000 --- a/tests/doctool/doc-examples-obj.c +++ /dev/null @@ -1,203 +0,0 @@ -/* doc-examples-obj.c */ - -#include "doc-examples-obj.h" - -/** - * DocExamplesObj: - * - * This is an example of how to document a class - * - * This class has a signal: #DocExamplesObj::signal-example. - * - * And also has a property: #DocExamplesObj:property-example. - * - * Since: 0.99 - */ - -G_DEFINE_TYPE (DocExamplesObj, doc_examples_obj, G_TYPE_OBJECT) - -static void -doc_examples_obj_get_property (GObject *object, - guint property_id, - GValue *value, - GParamSpec *pspec) -{ - switch (property_id) - { - default: - G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec); - } -} - -static void -doc_examples_obj_set_property (GObject *object, - guint property_id, - const GValue *value, - GParamSpec *pspec) -{ - switch (property_id) - { - default: - G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec); - } -} - -static void -doc_examples_obj_class_init (DocExamplesObjClass *klass) -{ - GObjectClass *gobject_class = G_OBJECT_CLASS (klass); - GParamSpec *pspec; - - gobject_class->get_property = doc_examples_obj_get_property; - gobject_class->set_property = doc_examples_obj_set_property; - - /** - * DocExamplesObj::signal-example: - * @obj: - * @int_param: a parameter of type int - * @float_param: a parameter of type float - * @pointer_param: A pointer to @obj's thingy -- - * pass @int_param if you really want to. - * - * This is an example of how to document a signal. - * - * Since: 0.99 - */ - g_signal_new ("signal-example", - G_TYPE_FROM_CLASS (gobject_class), - G_SIGNAL_RUN_LAST, - 0, NULL, NULL, - NULL, - G_TYPE_NONE, 3, G_TYPE_UINT, G_TYPE_UINT, G_TYPE_POINTER); - - /** - * DocExamplesObj:property-example: - * - * This is an example of how to document a property. - * - * Type: GLib.HashTable(utf8,gint8) - * Transfer: container - * - * Since: 0.99 - */ - pspec = g_param_spec_boxed ("property-example", - "Example property", - "A contained GHashTable", - G_TYPE_HASH_TABLE, - G_PARAM_READWRITE); - g_object_class_install_property (gobject_class, - 1, - pspec); -} - -static void -doc_examples_obj_init (DocExamplesObj *self) -{ - -} - -DocExamplesObj * -doc_examples_obj_new (void) -{ - return g_object_new (DOC_EXAMPLES_TYPE_OBJ, NULL); -} - -/** - * doc_examples_obj_method: - * @obj: 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. - * Pass @first_arg if you want to sometimes. You can - * also pass @second_arg, or even @boolean_arg. - * @string: A NUL-terminated string. - * - * This is an example of how to document a method. - * - * You should call this on a #DocExamplesObj that was - * created with doc_examples_obj_new(), by passing it - * in as @obj. - * - * This should be a %FALSEALARM. - * - * Since: 0.99 - * - * Returns: Either %FALSE or something %FALSE-y. - */ -gboolean -doc_examples_obj_method (DocExamplesObj *obj, gint first_arg, gfloat second_arg, - gboolean boolean_arg, gpointer pointer_arg, gchar *string) -{ - return FALSE; -} - -/** - * doc_examples_obj_static_method: - * @out_arg: (out) (allow-none): a pointer to int, or %NULL to ignore - * - * This is an example of a function with an out argument - * and a return value. - * - * Returns: %TRUE if @out_arg is valid, %FALSE otherwise - */ -gboolean -doc_examples_obj_static_method (gint *out_arg) -{ - if (out_arg) - *out_arg = 42; - - return TRUE; -} - -/** - * doc_examples_array_function: - * @out_len: (out): the length of the returned array - * - * This function returns an array with an explicit length, - * and the length should be invisible in most introspected bindings. - * - * Returns: (array length=out_len) (transfer full): an array of numbers. - */ -gint * -doc_examples_array_function (gint *out_len) -{ - gint *array; - int i, n = 3; - - array = g_new(int, n); - for (i = 0; i < n; i++) - array[i] = i; - - *out_len = n; - return array; -} - -/** - * doc_examples_callback_function: - * @callback: Just Call Me Maybe - * @user_data: your stuff - * @destroy_notify: how to get rid of @user_data - * - * This is a function that takes a callback. Different languages - * will expose this in different ways (e.g. Python keeps the - * @user_data parameter, while JS doesn't) - * - * Returns: %DOC_EXAMPLES_FOO sometimes, %DOC_EXAMPLES_BAR - * other times. - */ -DocExamplesEnum -doc_examples_callback_function (DocExamplesCallback callback, - gpointer user_data, - GDestroyNotify destroy_notify) -{ - gchar *result; - - result = callback (42, 17); - g_free (result); - - if (user_data && destroy_notify) - destroy_notify (user_data); - - return DOC_EXAMPLES_FOO; -} diff --git a/tests/doctool/doc-examples-obj.h b/tests/doctool/doc-examples-obj.h deleted file mode 100644 index 543a8c29..00000000 --- a/tests/doctool/doc-examples-obj.h +++ /dev/null @@ -1,93 +0,0 @@ -/* doc-examples-obj.h */ - -#ifndef _DOC_EXAMPLES_OBJ_H -#define _DOC_EXAMPLES_OBJ_H - -#include <glib-object.h> - -G_BEGIN_DECLS - -#define DOC_EXAMPLES_TYPE_OBJ doc_examples_obj_get_type() - -#define DOC_EXAMPLES_OBJ(obj) \ - (G_TYPE_CHECK_INSTANCE_CAST ((obj), \ - DOC_EXAMPLES_TYPE_OBJ, DocExamplesObj)) - -#define DOC_EXAMPLES_OBJ_CLASS(klass) \ - (G_TYPE_CHECK_CLASS_CAST ((klass), \ - DOC_EXAMPLES_TYPE_OBJ, DocExamplesObjClass)) - -#define DOC_EXAMPLES_IS_OBJ(obj) \ - (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \ - DOC_EXAMPLES_TYPE_OBJ)) - -#define DOC_EXAMPLES_IS_OBJ_CLASS(klass) \ - (G_TYPE_CHECK_CLASS_TYPE ((klass), \ - DOC_EXAMPLES_TYPE_OBJ)) - -#define DOC_EXAMPLES_OBJ_GET_CLASS(obj) \ - (G_TYPE_INSTANCE_GET_CLASS ((obj), \ - DOC_EXAMPLES_TYPE_OBJ, DocExamplesObjClass)) - -typedef struct _DocExamplesObj DocExamplesObj; -typedef struct _DocExamplesObjClass DocExamplesObjClass; - -struct _DocExamplesObj -{ - GObject parent; -}; - -struct _DocExamplesObjClass -{ - GObjectClass parent_class; - - /** - * DocExamplesObjClass::vfunc: - * @self: - * @first_arg: first argument - * - * This is an example of how to document a vfunc. - * - * Since: 0.99 - */ - void (*vfunc) (DocExamplesObj *self, gint first_arg); -}; - -GType doc_examples_obj_get_type (void) G_GNUC_CONST; - -DocExamplesObj *doc_examples_obj_new (void); -gboolean doc_examples_obj_method (DocExamplesObj *obj, gint first_arg, gfloat second_arg, - gboolean boolean_arg, gpointer pointer_arg, gchar *string); - -gboolean doc_examples_obj_static_method (gint *out_arg); - -gint *doc_examples_array_function (gint *out_len); - -/** - * DocExamplesEnum: - * @DOC_EXAMPLES_FOO: a foo - * @DOC_EXAMPLES_BAR: a bar - * - * This is an example to document an enumeration. - */ -typedef enum { - DOC_EXAMPLES_FOO, - DOC_EXAMPLES_BAR -} DocExamplesEnum; - -/** - * DocExamplesCallback: - * @one: first parameter - * @two: second parameter - * - * Returns: something - */ -typedef gchar * (*DocExamplesCallback) (int one, int two); - -DocExamplesEnum doc_examples_callback_function (DocExamplesCallback callback, - gpointer user_data, - GDestroyNotify destroy_notify); - -G_END_DECLS - -#endif /* _DOC_EXAMPLES_OBJ_H */ |