Google   Web www.cppdoc.com
home     download     screen shots     bugs     mailing list     example output     generated MFC docs     help     faq     tools and utilities

donate (new)

 

CppDoc logo

CppDoc


CppDoc generates HTML documentation for C++ classes, based on your source code and special comments embedded within it.  It can produce output that is very similar to the output of Javadoc, and it supports Javadoc tags such as @see, @return , etc.  The documentation comments are optional; if you leave them out, CppDoc will still generate a full set of documentation based on class relationships and hierarchy.

See a screen shot.
See documentation generated from the MFC class library. There are not many documentation comments, but it's interesting to view the tree and cross-references. (You can look at the command line used to generate this documentation.)
 
 
Latest News
CppDoc is going Open Source!  It's still  in the process, but check out these instructions to try building it.

CppDoc v2.4 was released on 2005-04-19. This update contains bug fixes and a few incremental features, some of which are:
  • Added the ability to read documentation comments after declarations, like this:
    • int foo;  /// some documentation
  • Added a separate option ("Use C++ namespace as project", or -namespace-as-project on the command line) for using the C++ namespace (instead of the directory) as the Project.  See bug 22.
  • Added a button for Generate Command Line from the main dialog (previously this command was only in the system menu).
  • Added the ability to exclude files or directories by prefixing them with '#' in the list.  See bug 6.
  • Added the ability to accept multiple documentation comment formats.  See bug 24.
See the release notes for the full list of changes.

Download v2.4 for Windows or Linux, or see the download page for other (smaller) options.


Feeling adventurous? You an always download the latest build. It's not officially supported, but has up-to-the-minute bug fixes and features. See the build's release notes for more details.


Please email me with questions or comments.  Click here to submit a bug report or feature request.
Click here to join the CppDoc mailing list.




 © 2001-2005 Richard Feit. All rights reserved.
Logo donated by Anibal Castellanos.