CppDoc is a documentation tool similar to JavaDoc, but written for the C++ programming language. CppDoc generates HTML documentation for C++ classes, based on your source code and special comments embedded within it. CppDoc also generates inner class workings and relationships. CppDoc is now open source and a version is written for both the Windows and Linux operating systems. CppDoc recognizes and documents classes, member functions, member data, global functions, typedefs, and enums.
CppDoc is useful for any programmer who writes in the C++ programming language. CppDoc basically documents your main program with the comments you insert in the source code. It also links the classes utilized and provides detailed documentation based on your comments.CppDoc allows for organized documentation sometimes better than the programmer can provide in the source code itself. The easy to navigate html pages can tell you what any class, method, or sub-method does and what else it relates to or uses.
For instructions on installing CppDoc on a Windows or Linux Platform click here
Documentation is generated through your comments which should like the following statement.
/** This is the default syntax that CppDoc is looking for */
Using this program is fairly simple because in either operating system it only asks for input source code and a destination for the web page files.It normally makes several pages with an index page so it can be easily ported into a web server like Apache or IIS. You will be able to view these pages on your local computer via web browser and you can edit them however one wishes to edit these pages. If this is being done on a PC these files will have to be hosted on a web server to make them viewable on the Internet.
In Windows the user is given a GUI with various fields. The user has to specify the location of the source code using the "Add Files" or "Add Directory" button in the Input field and the location of the documentation output using the "Browse" button in the Output field. All other fields can be filled in at the users choice. When all of these steps are complete click on the "Go" button and your documentation is created.
In a Linux Operating system to run cppdoc the user will execute a script that generates the documentation. This is done by the following steps.
% cd ../cppdoc2
% ./cppdoc /path/to/sourc_code /destination/of/documentation
Additional syntax can be added. A list of syntax can be shown by executing the cppdoc script with any parameters as follows