Doxygen non elaborerà main.cpp

Question

Quindi sono nuovo nell'usare Doxygen e sono riuscito a farlo funzionare correttamente. Sono stato in grado di documentare le mie classi e le mie strutture e genera perfettamente i file HTML. Il problema che sto incontrando è che non analizzerò il mio file main.cpp. Tutte le classi e le strutture hanno i propri file .h e .cpp e funzionano bene. Come posso ottenere Doxygen per creare la documentazione per main.cpp? Non ha un file .h dato che questo è dove inizia e finisce il programma. Non saprei nemmeno cosa mettere nel file .h per main. Sto usando Doxywizard in Windows.

Edit:

ho messo questo in principale e genera una pagina principale:

/** 
@mainpage 

This is a test application. 

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

Ma poi più in basso il file in cui i prototipi di funzione sono ho questo e non ottiene analizzati :

/** 
@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

L'ho messo in cima a main.cpp e ha funzionato. Vai a capire.

/** 
@file main.cpp 
*/ 

Answer 2

Se INPUT e FILE_PATTERNS sono vuoti, si dovrebbe cercare i file * cpp (e molti altri modelli) nella directory corrente. (Questo dal Doxygen manual.)

Dal vostro sono vuote, mi aspetto una delle due cose sta succedendo, se non stai ricevendo la documentazione main.cpp:

1. main.cpp non è nella corrente directory. Per escluderlo, assicurati di eseguire Doxygen dalla stessa directory come sia il tuo file di configurazione e main.cpp.
2. C'è un errore di sintassi nella documentazione di main.cpp. Questi possono essere difficili da individuare, dato che Doxygen in genere non abortisce quando incontra un errore, ma salta semplicemente avanti. Se questo è il problema, combina l'output di Doxygen quando generi i documenti riga per riga.

Se nessuna di queste idee risolve il problema, potrebbero essere necessarie ulteriori informazioni. Uscita di ls -R, uscita della corsa di Doxygen, ecc. Buona fortuna!

Answer 3

Ho fatto qualche ricerca su questo ... Dal doxygen manual:

Importante: La documentazione delle funzioni globali, variabili, typedef, e enumerazioni saranno inclusi solo nel output se il file in cui sono è documentato anche .

Ecco qui!