kde-core-devel@kde.org
[Top] [All Lists]

Re: D-Bus API description to include dox?

Subject: Re: D-Bus API description to include dox?
From: "Friedrich W. H. Kossebau"
Date: Mon, 22 Mar 2010 16:19:22 +0100
Hi Will,

Lundi, le 22 mars 2010, à 15:44, Will Stephenson a écrit:
> On Monday 22 March 2010 13:36:58 Friedrich W. H. Kossebau wrote:
> > doing the KRemoteControl review I wonder why there is no API dox
> > considered for the D-Bus introspection, one has to guess the semantics of
> > all the methods and parameters.
> >
> > Should we extend the dtd to include that? Anyone with insider knowledge
> > how to get this best done? Can we at KDE at least start to do so, by
> > using comment sections (<!-- -->) in the api.xml file?
> 
> One way to do it is used by telepathy and (after yours truly ported the
>  docu generation from telepathy) NetworkManager.  It uses namespaced xml
>  elements in the dbus introspection and some XSLT magic to transform that
>  into HTML documentation.  Examples:
> 
> http://cgit.freedesktop.org/NetworkManager/NetworkManager/tree/docs/Makefil
> e.am
>  http://cgit.freedesktop.org/NetworkManager/NetworkManager/tree/introspecti
> on/nm- manager.xml

Nice. Something like this should be official for the D-Bus API spec. Has there 
been some discussion of that already?

Cheers
Friedrich
-- 
KDE Okteta - a simple hex editor - http://utils.kde.org/projects/okteta

<Prev in Thread] Current Thread [Next in Thread>