[prev in list] [next in list] [prev in thread] [next in thread] 

List:       doxygen-users
Subject:    [Doxygen-users] Python docstrings and exclamation mark
From:       Vaclav Petras <wenzeslaus () gmail ! com>
Date:       2012-08-30 13:59:38
Message-ID: CABo5uVuRH_OyxRyhSKAiaNtsxU0P-WraTWAHGb7ZVLt3FpMx_w () mail ! gmail ! com
[Download RAW message or body]

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

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
[prev in list] [next in list] [prev in thread] [next in thread]