CppDoc

From WxWiki
Jump to: navigation, search

Overview

  • Free.
  • Executables for at least Linux and MSW.
  • Uses a formatted C or C++ comment before an object to document it.
  • Modelled after JavaDoc so it looks both pretty and standardized.
  • Find more details on http://www.cppdoc.com/

Source Code Availability

The CppDoc author has expressed interest in open sourcing the application but has not done it yet.

using CppDoc for the wxWidgets documentation

The current system to generate wxWidgets documentation is very nice, but has some shortcomings. The current CppDoc executable hangs on certain source files in "contrib" and "src"; "include" works fine. I've gotten the CppDoc author to fix things in the past by providing a very narrow, good test case so these bugs are probably fixable.