.. _doxy:

Auto-generated documentation
============================

The code is documented with internal comment blocks such as this one::

!======================================================================
!> Comment test
!======================================================================

at the top of modules and module procedures.  Such comment blocks are processed by
`Doxygen <http://www.doxygen.nl/>`_ at `ReadTheDocs <https://readthedocs.org/>`_,
and turned into a set of HTML pages, showing the relations between modules,
data types, and module data and procedures:

   * `DISPATCH Doxygen output <https://dispatch.readthedocs.io/en/latest/doxygen/index.html>`_