On Sunday 24 May 2009, 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.
The doxygen stuff is developer documentation, and maybe someday library documentation. The audience is developers. Updating that kind of low-level of documentation shakes loose issues with the internals. The audience for texi documentation is OpenOCD users. It covers server configuration, commands, and so on. Updating that level of documentation shakes loose publicly visible functional holes. (Like, until recently, having no NAND support ...) So both types of update can go in parallel. I'm pointing out, however, that if the texi docs don't list a feature, it effectively doesn't exist except to a *very* small community of developers. But the whole point of an 0.2.0 release is to make work be available to a *larger* community (of users). Hope that helps.... - dave _______________________________________________ Openocd-development mailing list Openocd-development@lists.berlios.de https://lists.berlios.de/mailman/listinfo/openocd-development
