Doxygen

Using Doxygen

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

Generation of HTML documentation using doxygen

doxygen requires cmake, flex and bison to be available on your platform. The MOM6 documentation also requries graphviz/dot.

Obtain the latest version of doxygen:

cd MOM6-examples/src/MOM6
git clone https://github.com/doxygen/doxygen
(cd doxygen; cmake -G "Unix Makefiles" .)
(cd doxygen; make)

To use doxygen to generate HTML do the following:

./doxygen/bin/doxygen .doxygen

This will create HTML files in the directory html/. Point your browser to html/index.html

Doxygen style guide

Module documentation

Header

!> Implements the Mesoscale Eddy Kinetic Energy framework
module MOM_MEKE