doxygen syntax in python

后端 未结 2 1648
醉酒成梦
醉酒成梦 2021-02-02 17:44

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:<

2条回答
  •  孤城傲影
    2021-02-02 17:47

    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

提交回复
热议问题