I've taken the time today to run the Plucker CVS source code
through Doxygen, and put it online for anyone interested in working
with it in this format.
For those unfamiliar with Doxygen, it is a way to graphically
document and map source code. It allows you to visually "walk the
tree" of functions, headers, class structures, and many other things.
I've been using Doxygen for pilot-link for over a year now,
and its made it MUCH easier to spot and eliminate unnecessary circular
references, double-header inclusions, and many other common mistakes
that happen when you're working on a large project, and which aren't
easy to spot when looking at one file at a time.
Doxygen also allows us to create a "manual" of the source code
in pdf, postscript, LaTeX, manpages or other formats, if we ever
needed to. Its really a powerful development tool for documenting
code. It will make it very obvious where gotchas and other issues are
happening in your project. I highly recommend it for anyone who writes
code in C, C++, Java, and PHP.
As you walk through the pages, the images that you see, are
clickable image maps, and can be clicked to bring you to the members,
headers, source code and other pieces that they refernce. Its all
"live".
This is now set up for a nightly rebuild (takes about an hour
to run), including crushing the png files and reformatting the html
output slightly.
If anyone spots any buglets, mistakes, or anything that
generally doesn't work right with it, please let me know right away,
so I can fix it.
http://doxygen.plkr.org/
Enjoy.
David A. Desrosiers
[EMAIL PROTECTED]
http://gnu-designs.com
_______________________________________________
plucker-dev mailing list
[email protected]
http://lists.rubberchicken.org/mailman/listinfo/plucker-dev
