Comment dois-je classer un typedef avec Doxygen?

J'ai typedef struct dans mon code C++. De plein droit maintenant, ils sont répertoriés comme \var typedef. Est-il une meilleure façon de le faire? Ci-dessous est un exemple de ce que j'ai:

/*! \var typedef etc
 * \brief A type defined structure for etc 
 *
 * \param x type- Variable declaration for x
 * \param y type- Variable declaration for y
 */

Je sais que je ne devrais même pas dire param. Quoi d'autre est là?

Pourquoi le typedef? C'est le C++, pas de C.
typedefs sont encore utilisés en C++ afin d'améliorer la lisibilité du code. Un usage populaire de typedef est de créer des pointeurs de fonctions. Un autre est à l'aide de modèles.
Je peux le comprendre, à l'aide de définition de type de cette manière, mais pourquoi typedef struct au lieu de struct?
Principalement, il est autorisé à faire le portage de code C, C++ plus facile. Le langage C++ sur un lot de la syntaxe du C, et c'est l'un d'entre eux. Il n'interfère pas avec le code ni n'affecte pas le fichier exécutable.

OriginalL'auteur Questioneer | 2011-10-28

  1. 11

    Selon la La documentation Doxygen il y a un \typedef de commande. La commande a le même comportement que le \var commande.

    OriginalL'auteur Thomas Matthews

  2. 24

    Si vous mettez le bloc de commentaire en face de la définition de type, vous n'avez pas besoin d'utiliser une commande spéciale.

    /** This is the documentation for the following typedef */
typedef MyClass MyTypedef;

    Si vous préférez le mettre après la définition de type d'utilisation suivantes:

    typedef MyClass MyTypedef;
/**< This is the documentation for the preceding typedef */

    Uniquement lorsque le bloc de commentaire doit être à un autre endroit que la réelle définition de type, vous devez utiliser \typedef.

    OriginalL'auteur doxygen