recommended way to document DBUS interfaces
will.thompson at collabora.co.uk
Wed Nov 26 04:32:22 PST 2008
Alexander Neundorf wrote:
> I've written a DBUS interface xml file for the service we are working on.
> Now, is there a recommended way how to document it ?
> Should I just add comments in the xml file ? Special tags ? Any tools
> (doxygen-like) which process them ?
The Telepathy specification is written in an augmented version of
introspection XML, and we have scripts to generate HTML (as seen at
http://telepathy.freedesktop.org/spec.html ) and a DevHelp index, and to
generate C bindings in the shape of GObject interfaces. I believe
telepathy-qt4 uses the same code generation tool to generate Qt-ish C++
The HTMLification tools are in the 'tools' directory of
http://git.collabora.co.uk/?p=telepathy-spec.git ; the code generator is
in the 'tools' directory of
http://git.collabora.co.uk/?p=telepathy-glib.git . Sadly, the only
documentation of the XML format is the format itself, and it's a bit ad-hoc.
-------------- next part --------------
A non-text attachment was scrubbed...
Size: 260 bytes
Desc: OpenPGP digital signature
Url : http://lists.freedesktop.org/archives/dbus/attachments/20081126/316eb049/attachment.pgp
More information about the dbus