Documentation

 

Documentation

The Delft3d documentation is bundled together with the code. Therefor you need to compile not only the code, but also the documentation. 

 

Source Code (API) Documentation yourself

The source code documentation can also be generated by yourself using Doxygen:

  1. Download Doxygen from www.doxygen.org and install it.

  2. Download Graphviz from www.graphviz.org and install it.

  3. Execute in directory "...\src" the command:
    doxygen doxyfile_delft3d

  4. The Doxygen output is available, starting at "...\src\delft3d-apidoc\html\index.html"

Remarks:

  • Not all comments in the source code are visible via Doxygen. This is on the ToDo-list.