Using qdoc

Udoc is a command-line program with two options:

Other arguments are assumed to be source files.

To generate man pages in the ./man directory and web pages in ./web from the source code in ./src/*.cpp, run

qdoc -w web -m man src/*.cpp

Normally this command is added to the build system (e.g. Make). At Oryx, we run udoc as the last step, after all compiles have succeeded.

Udoc will usually respond with a large number of error messages, e.g. complaining that there's no documentation in any of the source files. This is a feature, not a bug: Add the documentation blocks to the source files and all will be well.

Relevant links

About this page

Last modified: 2010-11-19