diff -r 000000000000 -r 42188c7ea2d9 Orb/Doxygen/doc/dbusxml.doc --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Orb/Doxygen/doc/dbusxml.doc Thu Jan 21 17:29:01 2010 +0000 @@ -0,0 +1,149 @@ +/*! \page dbusxml DBus XML output format + +\addindex dbusxml + +

Doxygen can generate documentation for DBus XML files. This way +DBus interfaces can be annotated with doxygen style comments, and +without writing custom XML parsers. Doxygen extracts its text from +all XML comments starting with '*' or '!'. An additional '<' can be +used to assign the documentation string to the previous entity instead +of the one following the comment. + +Note that before the parsing of DBus XML file works one has to +assign the .xml extension to the DBus XML parser using the +following configuration option: + +\verbatim +EXTENSION_MAPPING = xml=dbusxml +\endverbatim + +\section dbusxml_supported Supported XML elements and attributes + +

The following DBus XML elemets can be annotated: + +

interface + +
method or signal + +
arg + +
property + +

+ +Additional elements are supported. These are available once +the xmlns "http://psiamp.org/dtd/doxygen_dbusxml.dtd" is +available. + +

namespace: This can be used to group other more of the +additional elemets. This element requires a name attribute. + +
enum is used to define enums. value element is + then used to define the individual values in the enum. This element + requires the name and type attributes. A + optional named-type attribute is allowed, referrencing typed + previously defined by one of the additional elements. A enum name + can be used anywhere a type is required using the named-type + attribute. + +
flagset is used to define sets of flags. Required and + optional attributes are identical to the ones used by enum. + While enums assume the values to be consecutive, while + a flagset is values suitable for flags. A flagset name + can be used anywhere a type is required using the named-type + attribute. + +
struct is used to define structures. A name + attribute is required. + +

member is used to define members of structs. It + is valid inside struct elements. This + element requires name and type attributes. In + addition to (or even instead of) the type attribute a + named-type attribute may be used to reference types defined + by enum, flagset or struct. + +\section dbusxml_example Example + +

+*/