Doxygen non elaborerà main.cpp

Question

Sono nuovo di utilizzare Doxygen e sono stato in grado di farlo funzionare senza intoppi. Sono stato in grado di documentare le classi e le strutture e genera i file HTML perfettamente. Il problema che sto funzionando in è che non sarà analizzare il mio file main.cpp. Tutte le classi e le strutture hanno i propri file .he cpp ed elaborano bene. Come faccio ad avere Doxygen per rendere la documentazione per main.cpp? Non ha un file .h come questo è dove il programma inizia e finisce. Io non so nemmeno cosa mettere nel file h per il principale. Sto utilizzando doxywizard in Windows.

Modifica:

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 che non venga analizzato:

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

Ho messo questo in cima 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 manuale .)

Dal momento che la vostra sono vuoti, mi aspetto una delle due cose sta succedendo, se non stai ricevendo la documentazione main.cpp:

1. main.cpp non si trova nella directory corrente. Per escludere questo caso, fare doxygen che si sta eseguendo dalla stessa directory come sia il tuo file di configurazione e main.cpp.
2. C'è un errore di sintassi nella documentazione main.cpp. Questi possono essere difficili da individuare, come doxygen generalmente non abortire quando incontra un errore - invece semplicemente salta avanti. Se questo è il problema, pettine tra l'uscita di doxygen quando si genera la vostra linea docs per riga.

Se nessuna di queste idee risolvere il problema, potremmo avere bisogno di ulteriori informazioni. Uscita di ls -R, uscita della corsa doxygen, ecc Buona fortuna!

Answer 3

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

  

Importante: La documentazione delle funzioni globali, variabili, typedef,   e enumerazioni saranno inclusi solo nel   uscita se il file sono in è   documentata pure.

ci si va!