Doxygen

You can generate a HTML documentation based on the source code and the comments using Doxygen. All you need is:
  1. Install Doxygen from http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc
  2. Open cmd shell, and cd to the workspace
  3. Run doxygen (it will automatically use Doxyfile configuration file)
  4. docs folder will be created, just open HTML\index.html in the browser
Please see attached file docs.zip for example of HTML output (may be outdated, it's recommended to build a new documentation after each change, it only takes 1 minute).

You can also refer to Doxygen manuals to see additional options for help generation, and for guides for writing doxygen-friendly comments in the code (basically, it's javadoc style).

Last edited Jun 1, 2008 at 9:05 AM by migo, version 4

Comments

No comments yet.