On Sun, 2009-05-24 at 17:51 -0400, Duane Ellis wrote: > DAVID> > > Ways other folk can help with the doc+code audits > > are to pick a section of the texi and convert it to > > use the @deffn presentation style ... then crosscheck > > against the code. > > > > Can you expand on this, explain a little bit more what you mean. > > I think, @deffn -is a "texi" type documentation technique, however we > are using doxygen here.
We are using both (and will be, for the indefinite future): The OpenOCD User Guide: (aka The Guide) - should start to focus on _using_ OpenOCD - written using GNU texinfo standards - file: doc/openocd.texi The OpenOCD Developer Manual: (aka The Manual) - focuses on _developing_ OpenOCD - written using Doxygen standards - files: see definition of INPUT in Doxyfile.in. Mostly doc/manual/* I hope that this clears up any confusion. A recent patch of mine updated the "Developers" section of The Guide to clarify this for users. Cheers, Zach _______________________________________________ Openocd-development mailing list Openocd-development@lists.berlios.de https://lists.berlios.de/mailman/listinfo/openocd-development
