examples/dbusxml.xml

   1 <?xml version="1.0" ?>
   2 <!-- Comment -->
   3 <!--*< File comment -->
   4 <node name="/SomeNode" xmlns:dx="http://psiamp.org/dtd/doxygen_dbusxml.dtd">
   5   <!--* test struct outside a namespace and interface -->
   6   <dx:struct name="StructOutsideNamespace">
   7     <!--* member 1 -->
   8     <dx:member name="member1" type="s"/>
   9     <!--* complex member 1 -->
  10     <dx:member name="complexMember1" type="(ssu)"/>
  11   </dx:struct>
  12
  13   <!--* Test flag set -->
  14   <dx:flagset name="flagset">
  15     <!--* Flag 1 of flagset. -->
  16     <dx:value name="FLAG1"/>
  17   </dx:flagset>
  18
  19   <!--* namespace comment -->
  20   <dx:namespace name="SomeNamespace">
  21     <!--* struct inside a namespace -->
  22     <dx:struct name="StructInNamespace">
  23        <!--* member 2 -->
  24        <dx:member name="member2" type="s"/>
  25     </dx:struct>
  26   </dx:namespace>
  27   <!--* Documentation on the interface -->
  28   <interface name="nl.stack.doxygen.test.interface">
  29     <!--* Test Enum documentation -->
  30     <dx:enum name="TestEnum">
  31       <!--* key 1 with value 13 -->
  32       <dx:value name="KEY1" value="13"/>
  33       <!--* key 2 without a value -->
  34       <dx:value name="KEY2"/>
  35     </dx:enum>
  36
  37     <!--* struct inside a interface -->
  38     <dx:struct name="StructInInterface">
  39       <!--* member 3 -->
  40       <dx:member name="member3" type="s"/>
  41       <!--* Struct in a struct -->
  42       <dx:struct name="StructInAStruct">
  43         <!--* member4 -->
  44         <dx:member name="member4" type="s"/>
  45       </dx:struct>
  46       <!--* struct member -->
  47       <dx:member name="structMembor" type="(s)" named-type="StructInAStruct"/>
  48     </dx:struct>
  49     <!--* Document method
  50
  51           Some extended documentation for the method.
  52
  53           @param[in] input blah.
  54           @param[out] output blub
  55      -->
  56     <method name="method">
  57       <arg direction="in" name="input" type="(s(s))" named-type="::nl::stack::doxygen::test::interface::StructInInterface"/>
  58       <arg direction="out" type="v" name="output"/>
  59     </method>
  60
  61     <signal name="signal">
  62       <!--*< Documentation for signal.
  63
  64              @param parameter some parameter.
  65         -->
  66       <arg name="parameter" type="s"/>
  67     </signal>
  68
  69     <!--* property documentation -->
  70     <property name="property" type="s" access="readwrite"/>
  71
  72     <!--* property documentation read-only -->
  73     <property name="propertyRead" type="s" access="read"/>
  74     <!--* property documentation write-only -->
  75     <property name="propertyWrite" type="s" access="write"/>
  76   </interface>
  77 </node>
  78 <!-- vim:set sw=2 sts=2 et ft=xml: -->