Doxygen ne documente pas la fonction principale dans main.cpp

J'ai un main.cpp qui contient une struct, certaines constantes globales et d'une fonction principale.

J'ai couru doxygen et la seule documentation que je suis arriver dans la sortie index.html pour ma struct.

Je veux doxygen du document dans index.html fichier mon main (). Ce que je fais mal?

    ///Definition of Pi
    const auto Pi = 3.141592653589793238462643383279502884197169399;

    ///\struct myStruc
    ///\brief myStruc description
    ///
    struct myStruc
    {
         ///Comments inside myStruc
    };

    ///\file

    ///\brief  Main function
    ///\param  argc An integer argument count of the command line arguments
    ///\param  argv An argument vector of the command line arguments
    ///\return an integer 0 upon exit success
    int main(int argc, char** argv)
    {
        ///Comments I would like to be documented in as well
        return 0;
    }

source d'informationauteur user1496542

c++doxygen main

15

C'est parce que vous êtes à la documentation d'un objet global qui doxygen, par défaut, ne pas le document. À partir de la doxygen manuel (l'emphase est mienne):
Du document à un membre d'une classe C++, vous devez également le document de la classe elle-même. La même chose vaut pour les espaces de noms. Document global fonction C typedef enum ou de la définition de préprocesseur vous devez d'abord document le fichier qui le contient (habituellement, c'est un fichier d'en-tête, parce que ce fichier contient les informations qui sont exportés vers d'autres fichiers source).

Répétons que, parce qu'elle est souvent négligée: pour documenter des objets globaux (fonctions, les typedefs, enum, macros, etc), vous devez documenter le fichier dans lequel elles sont définies. En d'autres termes, il faut au moins un
```
/*! \file */ 
```
ou un
```
/** @file */ 
```
ligne dans ce fichier.
Alors essayez d'ajouter l'une des deux lignes ci-dessus à votre main.cpp fichier.

Assurez-vous que HIDE_IN_BODY_DOCS est fixé à NO et d'utiliser quelque chose comme ceci:

///\file

///\brief  Main function
///\param  argc An integer argument count of the command line arguments
///\param  argv An argument vector of the command line arguments
///\return an integer 0 upon exit success
int main(int argc, char** argv)
{
  ///Comments I would like to be documented in as well
  return 0;
}

1

Pour moi, je devais m'assurer que j'ai eu ce jeu:

SHOW_FILES = OUI

Toutes vos fonctions s'affiche dans l'onglet Fichiers à l'intérieur de chaque fichier. Aussi, il aide si vous avez @fichier ou \fichier défini dans le haut de votre code.
0

Du manuel en ligne dans la "Documentation à d'autres endroits de la section":
http://www.stack.nl/~dimitri/doxygen/manuel/éléments.html#specialblock

"Doxygen vous permet de placer vos blocs de documentation de pratiquement n'importe où (l'exception est à l'intérieur du corps d'une fonction ou à l'intérieur d'un C normale style de bloc de commentaire)."

Cela fait un certain sens, parce que le nitty gritty de la FAÇON dont fonctionne une fonction (sa mise en œuvre) est généralement pas requis. Je crois que le but de Doxygen est de contribuer à la documentation qui est facilement consultable pour permettre aux codeurs de trouver où sont les choses et de regarder ce qu'ils font (et quels paramètres sont passés dans celui-ci, de quoi il en retourne, etc) pour savoir comment les utiliser, mais pas de la façon dont il est mis en œuvre. Qui exigerait en fait en regardant la fonction source (qui est également disponible dans les Doxygen fichiers générés). Aussi, si vous l'aurez remarquez, tous les exemples (je pense) montrent la documentation dans les fichiers d'en-tête, qui manque tout de la mise en œuvre qui m'amène à croire que la documentation est prévu pour les fichiers d'en-tête, mais l'outil vous donne la flexibilité de la mettre dans les fichiers source.

C'est mon avis de toute façon. Quiconque pense différemment?

Vous devez vous connecter pour publier un commentaire.