Doxygen Task Ant
E’ possibile rendere più comodo il processo di generazione della documentazione del codice sorgente sfruttando Ant e il task di Doxygen. Il Task Ant for Doxygen è disponibile all’indirizzo http://ant-doxygen.blogspot.com/2008/03/overview.html. Sul Blog sono indicate tutte le informazioni necessarie per effettuare il download, esempi compresi (http://ant-doxygen.blogspot.com/2008/03/usage.html).
Personalmente utilizzo Eclipse come ambiente di sviluppo integrato, su questo ambiente è possibile in modo semplice integrare ai propri Task Ant un task dedicato a Doxygen, in questo modo sarà possibile generare la documentazione del codice sorgente direttamente da Eclipse.
Per utilizzare il Task Ant Doxygen con Eclipse, è necessario aggiungere al runtime di Ant il jar ant_doxygen.jar.
Configurazione Eclipse Ant for Doxygen
Nella figura successiva un esempio di documentazione (in formato HTML) generata attraverso un Task Ant Doxygen. La documentazione illustrata in figura fa riferimento alle API di Pentaho Data Integration (Kettle API).
Documentazione delle API Pentaho Data Integrationn
A seguire il target docs responsabile della generazione della documentazione del codice sorgente.
<target name="docs">
<doxygen:doxygen doxygenPath="/usr/local/bin/doxygen">
<property name="INPUT" value="/Users/amusarra/Documents/workspace-helios-j2ee/KettleAPI/src" />
<property name="RECURSIVE" value="yes" />
<property name="GENERATE_LATEX" value="false" />
<property name="PROJECT_NAME" value="Pentaho Data Integration Kettle API 4.1.0" />
</doxygen:doxygen>
</target>
