Skip to content

Generating Doxygen API documentation

williamfgc edited this page Feb 14, 2018 · 5 revisions
  1. Requirements (on Linux install them from your package manager):

  2. To generate the Doxygen API documentation under doc/html format (default) from the existing Doxyfile (edit Doxyfile to change options):

    $ cd ADIOS2/docs/api 
    $ doxygen
    

A "ADIOS2/docs/api/html" directory is generated, open any .html file inside this directory (e.g. index.html) on your favorite browser.