Code documentation for Carpet

Create issue
Issue #444 closed
Ian Hinder created an issue

Doxygen is a program which generates HTML documentation describing all the files, functions and classes of a program based on the C++ source. It uses comments in a particular format in the code. There is a search box and a tree view for the classes, as well as links to HTML versions of the source files. An example of the output is at

http://damiana2.aei.mpg.de/~ianhin/carpet-doc/

To generate the documentation, go into the root Carpet directory and type "doxygen", assuming that doxygen is installed on the local system. The documentation will be generated in a new carpet-doc directory. Open the file carpet-doc/html/index.html to browse the documentation.

It would be convenient to have the documentation generated in this way made available on the Carpet web site and updated after each commit to the repository.

The attached patch provides a doxygen configuration file and a header file for the main documentation page.

Keyword:

Comments (4)

  1. Erik Schnetter
    • removed comment

    There used to be a doxygen configuration file in Carpet... I wonder where it went.

    Please apply, with many thanks!

  2. Erik Schnetter
    • changed status to resolved
    • removed comment

    Applied.

    However, the automated mechanism suggested in the comment above updating the online documentation is not yet implemented.

  3. Log in to comment