doxygen syntax in python

Question

Can somebody please help me to figure out how to comment python code correctly to get parsed by doxygen?

Somehow it ignores the tags. The output (HTML) shows the tags:

@brief Creates a new Hello object.
This Hello Object is beeing used to ...

@param name The name of the user.

Both variants I tried do not work:

class Hello:
    """@brief short description...

    longer description
    """
    def __init__(self, name):
    """@brief Creates a new Hello object.

    This Hello Object is beeing used to ...

    @param name The name of the user.
    """
        self.name = name

class Hello:
    """\brief short description...

    longer description
    """
    def __init__(self, name):
    """\brief Creates a new Hello object.

    This Hello Object is beeing used to ...

    \param name The name of the user.
    """
        self.name = name

I am not allowed to choose the tool. I have to use doxygen. But I am not really familiar with it. — Mark
– Mark, Commented Nov 29, 2010 at 10:42
I read something about input-filters. I am using doxygen version 1.7.2 this should be able to parse python??? — Mark
– Mark, Commented Nov 29, 2010 at 10:57

wenzeslaus · Accepted Answer · 2013-03-20 21:52:36Z

19

Doxygen has also undocumented feature (or bug): It parses Doxygen syntax in docstring if you start docstring with an exclamation mark:

class Hello: 
    def __init__(self, name):
    """!@brief Creates a new Hello object.

    This Hello Object is being used to...

    @param name The name of the user.
    """
    self.name = name
        dosomething(12)

    def dosomething(x):         
        dosomethingelse

Note that in Python docsting, you need to use @ instead of \ to start Doxygen commands (backslash works as an escape character in docstring).

answered Mar 20, 2013 at 21:52

wenzeslaus

7171 gold badge6 silver badges15 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

albert · Accepted Answer · 2018-12-22 18:13:53Z

5

For doxygen to recognize the special commands in Python comments you have to use the following comment form:

class Hello: 
    ## \brief Short description.
    # Longer description. 
    # \param self
    # \param name
    def __init__(self, name):         
        dosomething(12)

    def dosomething(x):         
        dosomethingelse

See http://www.doxygen.nl/manual/docblocks.html#pythonblocks

edited Dec 22, 2018 at 18:13

albert

9,2003 gold badges24 silver badges42 bronze badges

answered Dec 1, 2010 at 17:34

cdiggins

18.4k7 gold badges111 silver badges107 bronze badges

Collectives™ on Stack Overflow

doxygen syntax in python

2 Answers 2

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related