On Nov 4, 2008, at 8:14 AM, Øyvind Harboe wrote:
A thought in this direction is to use Doxygen to generate documentation from source code comments. It keeps the documentation close to the code so it is more likely to be up to date and the final output form can be similar towhat we have today. Some areas of the docs, like the getting startedsection, could still be in separate files, but it means that things like alist of targets could be generated from the source.I have a hard time seing how openocd.texi could be generated from doxygen in a reasonable manner. Doxygen is more directed towards documenting the source code than to documented the behaviour of the program. Right? -- Øyvind Harboe http://www.zylin.com/zy1000.html ARM7 ARM9 XScale Cortex JTAG debugger and flash programmer
Yes, the main intent of Doxygen is to build documentation from the source code. You _can_ abuse it, however, to build documentation that isn't about the API. It may not be worth the trouble, but is an option. Instead, we could use a TCL script that asks for the available target types and options and generates the texi format for that section of the manual.
-- Rick Altherr [EMAIL PROTECTED]"He said he hadn't had a byte in three days. I had a short, so I split it with him."
-- Slashdot signature
smime.p7s
Description: S/MIME cryptographic signature
_______________________________________________ Openocd-development mailing list Openocd-development@lists.berlios.de https://lists.berlios.de/mailman/listinfo/openocd-development
