doxygen la syntaxe de python

Quelqu'un peut-il m'aider à comprendre comment le commentaire du code python correctement analysé par doxygen?

En quelque sorte, il ignore les balises. La sortie (HTML) montre la tags:

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

@param name The name of the user.

Les deux variantes que j'ai essayé ne fonctionnent pas:

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
Je présume que votre indentation est en fait valide?
Oui, il est. Je viens de le corriger.
Pourquoi ne pas les sphinx?
Je ne suis pas autorisé à choisir l'outil. J'ai utiliser doxygen. Mais je ne suis pas vraiment familier avec elle.
J'ai lu quelque chose au sujet de l'entrée des filtres. Je suis doxygen version 1.7.2 ce devrait être en mesure d'analyser python???

OriginalL'auteur Mark | 2010-11-29

  1. 13

    Doxygen a aussi des fonctions non documentées (ou bug): Il traite de Doxygen syntaxe dans la docstring si vous commencez à docstring avec un point d'exclamation:

    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

    Noter qu'en Python docsting, vous devez utiliser @ à la place de \ commencer à Doxygen commandes (barre oblique inverse fonctionne comme un caractère d'échappement dans la docstring).

    Qui fonctionne parfaitement, merci!

    OriginalL'auteur wenzeslaus

  2. 5

    Pour doxygen pour reconnaître les commandes spéciales en Python commentaires que vous avez à utiliser le commentaire suivant formulaire: 

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

    def dosomething(x):         
        dosomethingelse

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

    OriginalL'auteur cdiggins