[Doxygen-users] Python docstrings and exclamation mark

[Vaclav P. <wen...@gm...>]

Hi,

I'm confused about python docstrings and how Doxygen handles them.

By docstring I really mean this """ """. I don't want to use ##
comments for documenting API in Python.

When I use only simple docstring, I get docstring content in verbatim
as stated in manual [1] (example [2]).
"""My comment.

More here.
"""

But when I put exclamation mark at the beginning of docstring, Doxygen
commands are interpreted as for other languages or ## comments
(example [3]).
"""!My comment.

More here.
"""

This is ok, I'm using this a lot and I like it. But I haven't found
anything in the manual about that. So this is the source of confusion.

As I understood doxypy [4] enables this, or maybe even something
better, but I'm not using it. I'm using only Doxygen 1.8.1.2.

Best,
Vaclav

[1] http://doxygen.org/docblocks.html#pythonblocks
[2] http://www.stack.nl/~dimitri/doxygen/examples/docstring/html/classdocstring_1_1PyClass.html
[3] http://www.stack.nl/~dimitri/doxygen/examples/pyexample/html/classpyexample_1_1PyClass.html
[4] http://code.foosel.org/doxypy