diff options
| author | albert-github <albert.tests@gmail.com> | 2020-02-07 14:56:51 (GMT) |
|---|---|---|
| committer | albert-github <albert.tests@gmail.com> | 2020-02-07 14:56:51 (GMT) |
| commit | 66cf0cf586dd6adc8aea1a1139233c865315f40b (patch) | |
| tree | 22fd4bea66d7dabba3a6a46f4fcd574d9f9a3c00 /src/config.xml | |
| parent | 93245ad926ce01720eb35b9cf000992a44ac85c0 (diff) | |
| download | Doxygen-66cf0cf586dd6adc8aea1a1139233c865315f40b.zip Doxygen-66cf0cf586dd6adc8aea1a1139233c865315f40b.tar.gz Doxygen-66cf0cf586dd6adc8aea1a1139233c865315f40b.tar.bz2 | |
Using Python docstrings
- making documentation a bit clearer
- add configuration setting to have docstrings not as preformatted text but as normal documentation (default remains preformatted).
Diffstat (limited to 'src/config.xml')
| -rw-r--r-- | src/config.xml | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/src/config.xml b/src/config.xml index f40744d..7f26ea9 100644 --- a/src/config.xml +++ b/src/config.xml @@ -513,6 +513,16 @@ Go to the <a href="commands.html">next</a> section or return to the ]]> </docs> </option> + <option type='bool' id='PYTHON_DOCSTRING' defval='1'> + <docs> +<![CDATA[ + By default Python docstrings are displayed as preformatted text + and doxygen's special commands cannot be used. By setting \c PYTHON_DOCSTRING to + \c NO the doxygen's special commands can be used and the contents of the docstring + documentation blocks is shown as doxygen documentation. +]]> + </docs> + </option> <option type='bool' id='INHERIT_DOCS' defval='1'> <docs> <![CDATA[ |