Come funziona Doxygen

In linea generale per generare la documentazione Doxygen prende in input:

1. I sorgenti di cui deve creare la documentazione.

2. Altri file come immagini, header, footer e stylesheet.

3. Un Doxyfile che definisce tutte le opzioni di rendering della nostra documentazione. Questo file può essere editato con un semplice editor di testo o utilizzando il programma Doxywizard. Per generare il Doxyfile di default in modo da editarlo in seguito basta digitare "doxygen -g".

Come risultato Doxygen genera la documentazione nei seguenti formati:

1. XML - Utile se si vuole creare un tool che analizzi o utilizzi in qualche modo l'output di Doxygen utilizzando l'apposita libreria doxmlparser.

2. Latex - Utilizzato per generare documentazione PostScript e PDF.

3. Man - Questo è il formato delle pagine di manuale per ambienti Unix.

4. RTF - Il Ritch Text Format è un formato semplice e altamente portabile che può essere letto ad esempio da MS Word, Wordpad e OpenOffice.

5. HTML - Questo formato permette non solo di avere documentazione HTML online o offline ma anche di creare file CHM attraverso l'utilizzo di HTML Help Workshop.

La seguente immagine illustra schematicamente il funzionamento di Doxygen: