|
|
# Documentation for the Adaptable Input / Output System (ADIOS) v2.0
|
|
|
|
|
|
# Generate Doxygen API
|
|
|
|
|
|
1. Requirements (on Linux install them from your package manager):
|
|
|
* doxygen http://www.stack.nl/~dimitri/doxygen/
|
|
|
* graphviz http://www.graphviz.org/
|
|
|
|
|
|
2. To generate the Doxygen API documentation under doc/html format (default) from the existing Doxyfile (edit Doxyfile to change options):
|
|
|
|
|
|
```
|
|
|
$ cd ADIOS2/doc
|
|
|
$ doxygen
|
|
|
```
|
|
|
|
|
|
A ADIOS2/doc/html directory is generated, open any .html file inside this directory (_e.g._ index.html) in your favorite browser. |
|
|
\ No newline at end of file |