Doxygen for Mac OS X in Action
-
Documentazione HTML generata con Doxygen -
Documentazione HTML generata con Doxygen -
Generazione documentazione step 5 -
Generazione documentazione step 4 -
Generazione documentazione step 5 -
Generazione documentazione step 2 -
Generazione documentazione step 1
Continuando la serie di articoli dedicata alla documentazione del software iniziata con l’articolo PHP Documentation APIs on the fly, vedremo come generare la documentazione del nostro software utilizzando Doxygen[1] per Mac OS X. Questo articolo è d’introduzione per il successivo che tratterà come sia possibile generare al volo la documentazione utilizzando la combinata Eclipse + Ant + Doxygen.
Lo strumento più semplice per iniziare a generare la documentazione con Doxygen è rappresentato dalla Doxygen GUI. Vedremo step-by-step tutto il processo di creazione della documentazione. La prima azione da compiere è scaricare e installare Doxygen per Mac OS X. E’ possibile scaricare il software direttamente dall’indirzzo http://ftp.stack.nl/pub/users/dimitri/Doxygen-1.7.3.dmg. La versione di Doxygen presa in considerazione è la 1.7.3 per Mac OS X 10.6 (Snow Leopard).
Ho preso come “cavia” un progetto PHP chiamato PAFS (PHP Authenticator Framework Service) progettato da me parecchi anni addietro (2005/2006).
A seguire sono illustrati gli step necessari per creare la documentazione del progetto “cavia” tramite la GUI di Doxygen. Credo che le illustrazioni siano abbastanza parlanti da non richiedere ulteriori approfondimenti.
Una sola nota che desidero fare è sulla quinta illustrazione. L’azione sul pulsante “Show Configuration” mostra all’interno della text area della GUI la configurazione utilizzata per generare la documentazione, quest’ultima può essere salvata su file per essere eventualmente ripresa per i successivi aggiornamenti della documentazione del software. Questo file di configurazione sarà poi oggetto del prossimo articolo sull’argomento, come anticipato in precedenza.
Doxygen GUI Step 1 - Dati sul progetto
Doxygen GUI Step 2 - Modalità di analisi del codice
Doxygen GUI Step 3 - Selezione formato di Output
Doxygen GUI Step 4 - Scelta sulla generazione dei diagrammi
Doxygen GUI Step 5 - Run Doxgen
Documentazione HTML generata con Doxygen con un Class Diagramm in evidenza
Documentazione HTML generata con Doxygen con vista su metodi pubblici
[1] Doxygen è una applicazione per la generazione automatica della documentazione a partire dal codice sorgente di un generico software. È un progetto open source rilasciato sotto licenza GPL, scritto per la maggior parte da Dimitri van Heesch a partire dal 1997. Il sito ufficiale è http://www.stack.nl/~dimitri/doxygen/index.html
