Other docs/doxygen

Table Of Contents

Previous topic

Autodoc : pulling reStructuredText from docstrings

Next topic

Publishing Documentation on Separate Webserver

This Page

Daya Bay Links

Content Skeleton

Doxygen : automated documentation of C++ API

Doxygen Integration with Breathe

A possible future enhancement is to integrate doxygen documentation of C++ code into the Offline User Manual.

The breathe project provides an extension to reStructuredText and Sphinx that enables reading and rendering of Doxygen xml output.

It is usable at whatever granularity is desired (similar to Sphinx autodoc) enabling the problem of boring and unreadable auto-generated API docs to be avoided, albeit with some effort from the documenters.