sintaxis doxygen en python

Question

¿Alguien puede ayudarme a encontrar la manera de comentar el código python correctamente para ser analizado por doxygen?

De alguna manera ignora las etiquetas. La salida (HTML) muestra los tags:

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

@param name The name of the user. 

---

Ambas variantes que probé no funcionan:

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 

Answer 1

Doxygen tiene también característica no documentada (o error): Se analiza la sintaxis Doxygen en cadena de documentación si se inicia la cadena de documentación con un signo de exclamación:

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 

Tenga en cuenta que en Python docsting, necesita utilizar @ en lugar de \ para iniciar los comandos de Doxygen (la barra invertida funciona como un carácter de escape en docstring).

Answer 2

Para Doxygen para reconocer los comandos especiales en los comentarios de Python tiene que usar el siguiente formulario de comentarios:

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

    def dosomething(x):   
     dosomethingelse 

Ver http://www.stack.nl/~dimitri/doxygen/docblocks.html#pythonblocks