Thread: Wiki
View Single Post
Posts: 180 | Thanked: 41 times | Joined on Mar 2007 @ Maine
#7
Originally Posted by dneary View Post
Like API docs, I don't think a wiki is appropriate for this - what would be great is a tool which would allow application developers to document DBus APIs the way they document their C APIs, in the source code.

You can also have the DBus calls documented through the "register" calls they make to listen on the bus, and be able to query the bus for the complete possible API, the way GIMP plug-ins work - this is what DFeet does. We could then parse all the register calls in the source code & generate HTML pages directly from the sources.

I looked into this some time ago, but there doesn't appear to be an easy way to do this (yet).

Perhaps David Greaves could share how he generated the Phone Control docs? I believe he did them by hand, with DFeet.

Dave.
The problem is that for users that just want to use DBUS calls from the command line or a simple script that can be run from Alarmed these types of documentation are too obtuse to be much value. Therefore, there would need to be a wiki entry to tell people how to generate the html pages, etc . Good idea though, it would be better than what exists now.