Doxygen ne traitera pas main.cpp

Question

Je suis nouveau à l'aide Doxygen et j'ai pu le faire fonctionner en douceur. J'ai pu documenter mes classes et structs et il génère les fichiers HTML parfaitement. La question que je suis en cours d'exécution en est il ne sera pas analyser mon fichier main.cpp. Toutes les classes et structs ont leurs propres fichiers .h et .cpp et ils traitent bien. Comment puis-je obtenir Doxygen pour rendre la documentation main.cpp? Il ne dispose pas d'un fichier .h comme cela est le début et la fin du programme. Je ne sais même pas quoi mettre dans le fichier .h pour principal. J'utilise Doxywizard dans Windows.

Edit:

Je mets cela en principal et génère une page principale:

/**
@mainpage

This is a test application.

@author Alex
@date 10/21/2010
@version 1.0
*/

Mais plus bas dans le fichier où les prototypes de fonction sont je cela et qu'il ne soit pas analysables:

/**
@brief Error handler for the PDF writer.

It does nothing. It just has to exist.
*/
void error_handler (HPDF_STATUS   error_no,
                    HPDF_STATUS   detail_no,
                    void         *user_data)
{
}

Answer 1

Je mets ce en haut de main.cpp et cela a fonctionné. Go figure.

/**
@file main.cpp
*/

Answer 2

Si INPUT et FILE_PATTERNS sont vides, il faut rechercher des fichiers * .cpp (et bien d'autres motifs) dans le répertoire courant. (Ce à partir du doxygen manuel.)

Comme le vôtre sont vides, je me attends une des deux choses qui se passe si vous n'êtes pas obtenir la documentation main.cpp:

1. main.cpp est pas dans le répertoire en cours. Pour exclure cette, assurez-vous que vous utilisez doxygen du même répertoire que deux votre fichier de configuration et main.cpp.
2. Il y a une erreur de syntaxe dans la documentation de votre main.cpp. Ceux-ci peuvent être difficiles à repérer, comme doxygen ne généralement pas abort lorsqu'il rencontre une erreur - au lieu, il saute juste avant. Si tel est le problème, peigne à travers la sortie de doxygen lorsque vous générez votre ligne docs par ligne.

Si aucune de ces idées résoudre votre problème, nous pourrions avoir besoin de plus amples informations. Sortie de ls -R, sortie de la course doxygen, etc. Bonne chance!

Answer 3

Je l'ai fait des recherches sur ce ... De la doxygen manuel :

  

Important: La documentation des fonctions globales, variables, typedefs,   et énumérations ne seront inclus dans le   sortie si le fichier est qu'ils sont   documenté ainsi.

Il est parti!