diff options
author | Dimitri van Heesch <doxygen@gmail.com> | 2020-08-10 18:37:18 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-08-10 18:37:18 (GMT) |
commit | e86cbe4f87d2fd8f8291322f9e271e961e1b7b47 (patch) | |
tree | 2bb34365246c73ae25509b923248674b69f43a53 /doc/docblocks.doc | |
parent | 8e87f6bb404065d2c8802a9c61756e3c7a729fb1 (diff) | |
parent | 66cf0cf586dd6adc8aea1a1139233c865315f40b (diff) | |
download | Doxygen-e86cbe4f87d2fd8f8291322f9e271e961e1b7b47.zip Doxygen-e86cbe4f87d2fd8f8291322f9e271e961e1b7b47.tar.gz Doxygen-e86cbe4f87d2fd8f8291322f9e271e961e1b7b47.tar.bz2 |
Merge pull request #7575 from albert-github/feature/bug_py_docstr
Using Python docstrings
Diffstat (limited to 'doc/docblocks.doc')
-rw-r--r-- | doc/docblocks.doc | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 6c1edae..96a2621 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -450,7 +450,7 @@ the script can be found in the path set via \ref cfg_example_path "EXAMPLE_PATH" \subsection pythonblocks Comment blocks in Python For Python there is a standard way of documenting the code using -so called documentation strings. Such strings are stored in \c __doc__ +so called documentation strings (<tt>"""</tt>). Such strings are stored in \c __doc__ and can be retrieved at runtime. Doxygen will extract such comments and assume they have to be represented in a preformatted way. @@ -464,8 +464,12 @@ and assume they have to be represented in a preformatted way. for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. \endlatexonly -Note that in this case none of doxygen's \ref cmd_intro "special commands" -are supported. +\note When using <tt>\"\"\"</tt> none of doxygen's \ref cmd_intro "special commands" +are supported and the text is shown as verbatim text see \ref cmdverbatim "\\verbatim". +To have the doxygen's \ref cmd_intro "special commands" and have the text as regular +documentation instead of <tt>\"\"\"</tt> use <tt>\"\"\"!</tt> or set +\ref cfg_python_docstring "PYTHON_DOCSTRING" to \c NO in the configuration file. +\note Instead of <tt>\"\"\"</tt> one can also use <tt>'''</tt>. There is also another way to document Python code using comments that start with "##". These type of comment blocks are more in line with the |