Marnie McCormack wrote:
Hi All,
Just wanted to issue a plea for the developers on the list to
contribute to
the documentation on the Apache wiki (or other component appropriate
location).
Just wanted to issue another plea for developers to keep as much
documentation as possible close to the code - i.e. in Javadoc, doxygen,
pydoc or rubydoc comments. It's much more likely to stay up to date as
code changes, it's great for people who read header files to learn how
things work and it's a boon to qpid developers who have the doc at their
fingertips - tools like eclipse can really cash in on this.
I have it on my TODO list to put the C++ doxygen on the wiki - there are
two versions: user and developer (with user being simply a filtered
version of developer, only public methods etc.) I'll JIRA it and try to
get on it soon (unless someone else grabs it.)
Cheers,
Alan.
