Udoc is a literate programming tool for generating API documentation. It's not meant for user manuals, only for programmer documentation. It parses source code and special comments to produce maintainer documentation in HTML, man page and postscript formats. Its input:
/*! As Output::addClass(). \a text is output as-is, and the name of \a c is remembered for later mention in the See Also section.
void ManPage::addClass( const String & text, Class * c )
The resulting output:
As Output::addClass(). text is output as-is, and the name of c is remembered for later mention in the See Also section.
If you want to write documentation for the other developers in your team, or for code reviews, or for the next maintainer of your code, and you use C++, and you want a simple documentation tool that runs quickly and gives good output, then udoc may be an excellent choice.
Last modified: 2010-11-19