diff options
| author | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2018-12-11 20:20:07 +0200 |
|---|---|---|
| committer | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2018-12-12 20:45:24 +0200 |
| commit | 53c4d4c34fc49b95ca07265fc65940df9c365074 (patch) | |
| tree | 46780761cc9034bb60dcda0a396fbd97e595eac3 /Documentation/contributing.rst | |
| parent | 652b1c8679c3b18e4dec11a923b53bf333451ed1 (diff) | |
Documentation: Generate source code documentation using Doxygen
Extend the documentation build system to automatically generate
documentation from source code using Doxygen. This is currently separate
from the sphinx documentation, and should be integrated using the
breathe (and possibly exhale) extensions.
As the Documentation/meson.build file needs to reference the variables
holding the source files, move the Documentation directory to the end of
the subdirs() in the top-level meson.build.
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Diffstat (limited to 'Documentation/contributing.rst')
| -rw-r--r-- | Documentation/contributing.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst index dd6f5efa..b0b67ebc 100644 --- a/Documentation/contributing.rst +++ b/Documentation/contributing.rst @@ -35,12 +35,12 @@ Documentation ------------- Project documentation is created using `Sphinx`_. Source level documentation -is currently planned to utilise Doxygen integration. Please use this in your -development. +uses `Doxygen`_. Please make sure to document all code during development. -Sphinx integration with Doxygen will be with either `Breathe`_ or `Exhale`_ -depending upon which system works best +Sphinx integration with Doxygen is planned, likely using `Breathe`_ and +`Exhale`_. .. _Sphinx: http://www.sphinx-doc.org +.. _Doxygen: http://www.doxygen.nl .. _Breathe: https://breathe.readthedocs.io/en/latest/ .. _Exhale: https://exhale.readthedocs.io/en/latest/ |