Zach, I'm a little concerned here. I've seen many doxygen generated API 'reference' manuals. Most of them are useless because they don't describe why a certain function is there and what its relation is to other functions. Doxygen is a fine tool to get a list of functions and their parameters but the same information can be obtained by importing the source into an IDE like Eclipse or Visual Studio. I have been digging around in other peoples software a lot. The biggest question is always: how does the data flow through the software and why is it structured the way it is. Unfortunately, most doxygen generated documents don't contain this information.
A diagram which shows the logical blocks / layers of the software and some text on how they interact is very very useful. Nico Coesel > -----Oorspronkelijk bericht----- > Van: openocd-development-boun...@lists.berlios.de > [mailto:openocd-development-boun...@lists.berlios.de] Namens > Zach Welch > Verzonden: maandag 11 mei 2009 9:30 > Aan: openocd-development > Onderwerp: [Openocd-development] doxygen update > > Hi all, > > As a consequence of my recent clean-up work, I turned on some > of the basic GraphViz features in doxygen. This feature can > be turned off by change the HAVE_DOT Doxyfile setting from YES to NO. > > Its file dependency graphs are now much more insightful than > before I started my clean-up, so I think they should be > referenced by as many developers as possible. > > Further, I would like to improve the doxygen output until it > provides a fairly complete API reference manual. Patches > that move us toward that goal would be most welcome. > > Cheers, > > Zach > > _______________________________________________ > Openocd-development mailing list > Openocd-development@lists.berlios.de > https://lists.berlios.de/mailman/listinfo/openocd-development > _______________________________________________ Openocd-development mailing list Openocd-development@lists.berlios.de https://lists.berlios.de/mailman/listinfo/openocd-development
