tests/scanner/annotationparser/gtkdoc/gobject/giface.c.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2
   3 <tests>
   4
   5 <test>
   6   <commentblock><![CDATA[/**
   7  * SECTION:iface
   8  * @title: GtkdocIface
   9  * @short_description: interface for gtk-doc unit test
  10  * @see_also: #GtkdocObject
  11  *
  12  * This file contains non-sense code for the sole purpose of testing the docs.
  13  * We can link to the #GtkdocIface:itest property and the #GtkdocIface::itest
  14  * signal.
  15  * An instance can be configured using the gtkdoc_iface_configure() function.
  16  *
  17  * I can haz pictures too!
  18  * <mediaobject>
  19  *   <imageobject><imagedata fileref="home.png" format="PNG"/></imageobject>
  20  *   <caption><para>Home sweet home.</para></caption>
  21  * </mediaobject>
  22  *
  23  * Just incase you wonder, special caracters can be escaped with a \ like in \%
  24  * or \# or even \@.
  25  */]]></commentblock>
  26   <docblock>
  27     <identifier>
  28       <name>SECTION:iface</name>
  29     </identifier>
  30     <parameters>
  31       <parameter>
  32         <name>title</name>
  33         <description>GtkdocIface</description>
  34       </parameter>
  35       <parameter>
  36         <name>short_description</name>
  37         <description>interface for gtk-doc unit test</description>
  38       </parameter>
  39       <parameter>
  40         <name>see_also</name>
  41         <description>#GtkdocObject</description>
  42       </parameter>
  43     </parameters>
  44     <description><![CDATA[This file contains non-sense code for the sole purpose of testing the docs.
  45 We can link to the #GtkdocIface:itest property and the #GtkdocIface::itest
  46 signal.
  47 An instance can be configured using the gtkdoc_iface_configure() function.
  48
  49 I can haz pictures too!
  50 <mediaobject>
  51   <imageobject><imagedata fileref="home.png" format="PNG"/></imageobject>
  52   <caption><para>Home sweet home.</para></caption>
  53 </mediaobject>
  54
  55 Just incase you wonder, special caracters can be escaped with a \ like in \%
  56 or \# or even \@.]]></description>
  57   </docblock>
  58 </test>
  59
  60 <test>
  61   <commentblock>/**
  62  * SECTION:iface2
  63  * @title: GtkdocIface2
  64  * @short_description: interface with a prerequisite for gtk-doc unit test
  65  * @see_also: #GtkdocObject, #GtkdocIface
  66  *
  67  * This file contains non-sense code for the sole purpose of testing the docs.
  68  */</commentblock>
  69   <docblock>
  70     <identifier>
  71       <name>SECTION:iface2</name>
  72     </identifier>
  73     <parameters>
  74       <parameter>
  75         <name>title</name>
  76         <description>GtkdocIface2</description>
  77       </parameter>
  78       <parameter>
  79         <name>short_description</name>
  80         <description>interface with a prerequisite for gtk-doc unit test</description>
  81       </parameter>
  82       <parameter>
  83         <name>see_also</name>
  84         <description>#GtkdocObject, #GtkdocIface</description>
  85       </parameter>
  86     </parameters>
  87     <description>This file contains non-sense code for the sole purpose of testing the docs.</description>
  88   </docblock>
  89 </test>
  90
  91 <test>
  92   <commentblock>/**
  93  * gtkdoc_iface_configure:
  94  * @config: settings
  95  *
  96  * Configure a new instance
  97  *
  98  * Returns: %TRUE for sucess or %FALSE in case of an error
  99  *
 100  * Since: 0.1
 101  */</commentblock>
 102   <docblock>
 103     <identifier>
 104       <name>gtkdoc_iface_configure</name>
 105     </identifier>
 106     <parameters>
 107       <parameter>
 108         <name>config</name>
 109         <description>settings</description>
 110       </parameter>
 111     </parameters>
 112     <description>Configure a new instance</description>
 113     <tags>
 114       <tag>
 115         <name>returns</name>
 116         <description>%TRUE for sucess or %FALSE in case of an error</description>
 117       </tag>
 118       <tag>
 119         <name>since</name>
 120         <description>0.1</description>
 121       </tag>
 122     </tags>
 123   </docblock>
 124 </test>
 125
 126 <test>
 127   <commentblock>/**
 128      * GtkdocIface::itest:
 129      * @self: myself
 130      *
 131      * The event has been triggered.
 132      */</commentblock>
 133   <docblock>
 134     <identifier>
 135       <name>GtkdocIface::itest</name>
 136     </identifier>
 137     <parameters>
 138       <parameter>
 139         <name>self</name>
 140         <description>myself</description>
 141       </parameter>
 142     </parameters>
 143     <description>The event has been triggered.</description>
 144   </docblock>
 145 </test>
 146
 147 </tests>