Introspect documentation for methods, signals, properties

[Kevin Krammer]

On Friday 17 February 2006 04:30, Rohan McGovern wrote:
> Hi,
>
> I think it would be beneficial if DBUS had a standard way of providing
> short documentation strings on methods, signals and properties in
> introspect data.  This would avoid the kind of problem DCOP suffers from,
> where a KDE application can have literally 100+ methods available, but to
> find out what they actually _do_, a user has to either make a guess based
> on the method's signature, or look at the source code of the program.
>
> It seems that this could easily be done by defining a new well-known
> annotation, say 'org.freedesktop.DBus.Description' or similar.  Then a
> DBUS service browser program could easily convey this information to the
> user.  What do you guys think?

It might not be necessary to transport the description itself in the 
introspection data, but rather a kind of reference, i.e. a section in the 
application's handbook.

Cheers,
Kevin

-- 
Kevin Krammer <kevin.krammer at gmx.at>
Qt/KDE Developer, Debian User
Moderator: www.mrunix.de (German), www.qtcentre.org
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
Url : http://lists.freedesktop.org/archives/dbus/attachments/20060217/0d6bbf6f/attachment.pgp