summaryrefslogtreecommitdiff
path: root/tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj.method.page
diff options
context:
space:
mode:
Diffstat (limited to 'tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj.method.page')
-rw-r--r--tests/doctool/DocExamples-1.0-Gjs-expected/DocExamples.Obj.method.page73
1 files changed, 0 insertions, 73 deletions
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>