Technical documentation

Technical Documentation

Using Doxygen

We are (slowly) migrating to doxygen-style comments for API and in-code documentation.

To use doxygen to generate HTML do the following:

cd MOM6-examples/src/MOM6
git clone https://github.com/doxygen/doxygen
(cd doxygen; ./configure)
(cd doxygen; make)
./doxygen/bin/doxygen .doxygen

This will create HTML files in the directory html/. You can then view the doxygen pages by pasting the following path into the URL bar of your web browser:

file://<full_path_to_MOM6_examples/MOM6-examples/src/MOM6/html/index.html