aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/developers/doxygen.rst
blob: 3580d8b2462728cccedab47f478f5fa833b3d62c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
.. _development-doxygen:

C++ Objects & Functions
=======================

We generate the documentation of C++ objects and functions *from our C++ source code* by adding :ref:`Doxygen strings <developers-docs>`.

* **WarpX and ABLASTR**: `C++ Doxygen <../_static/doxyhtml/index.html>`__

This documentation dynamically links to objects described in dependencies:

* **AMReX**: `C++ Doxygen <https://amrex-codes.github.io/amrex/doxygen>`__ and `Manual <https://amrex-codes.github.io/amrex/docs_html/>`__
* **openPMD-api**: `C++ Doxygen <https://openpmd-api.readthedocs.io/en/latest/_static/doxyhtml/index.html>`__ and `Manual <https://openpmd-api.readthedocs.io>`__
* **PICSAR-QED**: C++ Doxygen is *TODO*