PDA

Visualizza la versione completa : Pillola: [JAVA/C/C++] Uso di Doxygen per creazione documentazione


Luc@s
18-05-2004, 17:27
Doxygen Tutorial
Doxygen Ŕ un software open source utilissimo(1) che permette di documentare un software scritto in Java/C/C++.
Si compone di 2 files doxygen.exe e doxytag.exe che possono essere messi ove si vuole ma per chiamarli
senza dover inserire sempre il percorso bisogna inserirli nel PATH.
Per spiegare il funzionamento di questo tool prendiamo un codice di esempio:



#include <iostream>

/// il namespace std
using namespace std;

/// Classe Generica
class Prova
{
public:
///Costruttore
Prova(){ };
///Distruttore
~Prova(){ };
/// Funz che saluta
inline char * saluta(char * nm){ return nm; };
private:
};

int main()
{
return 0;
}


Doxygen accetta come parametro(obligatorio) il file di configurazione, che pu˛ essere chiamato a proprio
piacimento.


doxygen <config-file>

Noi per comoditÓ lo chiameremo doxy.conf.
Il files sarÓ cosi composto:



; Il nome del progetto
PROJECT_NAME = "Prova"
;La lingua
OUTPUT_LANGUAGE = "Italian"
; La directory ove porre la documentazione
OUTPUT_DIRECTORY = "doc"
; # I Seguenti valori accettano YES o NO #
; Genera la documentazione HTML
GENERATE_HTML = YES
; Permette la navigazione tra i files
SOURCE_BROWSER = YES
; DisabilitÓ la creazione della documentazione in formato LATEX
GENERATE_LATEX = NO
; Legge le sotto-directory ricorsivamente
RECURSIVE = YES
; Permette l' espansione delle macro
MACRO_EXPANSION = YES


Salviamo il files di configurazione nella directory principale del programma
Il risultato dell' operazione e visibile nel mio sito(2).
Dopo questa introduzione possiamo passare ad opzioni pi¨ avanzate.
Aggiungeremo ora al nostro doxy.conf le seguenti opzioni e proveremo a vedere il risultato:



; # I Seguenti valori accettano YES o NO #
; Opzione disponibile per soli programmi in C
OPTIMIZE_OUTPUT_FOR_C = NO
; Opzione disponibile per soli programmi in Java
OPTIMIZE_OUTPUT_JAVA = NO
; Mostra il tag [inline] difianco ai membri di classe che lo sono
INLINE_INFO = YES
; Valuta le espressioni macro presenti nel progetto
ENABLE_PREPROCESSING = YES
; Se attivo Doxygen mostra le relazioni tra i template e le sue istanze
TEMPLATE_RELATIONS = YES
; Permette la ricerca ma sul server deve essere presente PHP versione 4.1.0 o successive
SEARCHENGINE = NO


Detto questo ora possiamo dire che d'ora in poi i nostri programmi e librerie potranno essere
documentati senza problemi



Luc@s

(1) http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc
(2) allegato

alka
15-04-2006, 18:08
"BUMP!"

Loading