Doxygen-1.4.1

Introduzione a Doxygen

Il pacchetto Doxygen contiene un sistema di documentazione per C++, C, Java, Objective-C, Corba IDL e per alcune parti di PHP, C# e D. Esso serve per generare documentazione HTML e/o un manuale di riferimento off-line da un set di file sorgenti documentati. C'è anche supporto per generare output in man page RTF, PostScript, PDF con hyperlink, HTML compresso, e Unix. La documentazione è estratta direttamente dai sorgenti, che rendono molto più facile mantenere la documentazione consistente con il codice sorgente.

Si può anche configurare Doxygen per estrarre la struttura del codice da file sorgenti non documentati. Questo è molto utile per trovare rapidamente la propria strada in una grossa distribuzione sorgente. Usato con GraphViz permette di visualizzare le relazioni tra i vari elementi per mezzo dell'inclusione di grafici di dipendenza, diagrammi di eredità e diagrammi di collaborazione, che sono tutti generati automaticamente.

Informazioni sul pacchetto

Installazione di Doxygen

Installare Doxygen eseguendo i seguenti comandi:

rm src/unistd.h &&
./configure --prefix /usr --docdir /usr/share/doc &&
make

Ora, come utente root:

make install

Se si desidera generare e installare la documentazione del pachetto assicurarsi che i pacchetti Python, TeX e Graphviz siano installati, quindi sostituire i seguenti comandi per il comando make install precedente:

make docs &&
make pdf &&
install -d -m755 /usr/share/doc/doxygen/src &&
install -m644 src/translator{,_adapter,_en}.h \
    /usr/share/doc/doxygen/src &&
install -m644 VERSION /usr/share/doc/doxygen &&
make install_docs

Spiegazioni dei comandi

rm src/unistd.h: c'è un bug in Flex-2.5.31 che fa sì che make usi questo file invece della versione di sistema installata. La rimozione di questo file permette al front-end GUI di installarsi con successo.

--with-doxywizard: usare questo parametro se Qt è installato e si desidera costruire il front-end GUI.

make docs: questo comando costruisce la documentazione HTML.

make pdf: questo comando costruisce una versione PDF del manuale di Doxygen.

install ...: questi comandi installano alcuni file richiesti dalla documentazione di installazione.

Nota: per la documentazione in un linguaggio diverso dall'inglese sostituire “_en” con il codice di paese della propria localizzazione.

make install_docs: questo comando installa i binari e la documentazione.

Contenuti

Programmi installati: doxygen, doxytag e doxywizard
Directory installata: /usr/share/doc/doxygen

Brevi descrizioni

doxygen

è un'utilità su linea di comando usata per generare modelli di file di configurazione e quindi generare la documentazione da questi modelli. Usare doxygen --help per una spiegazione dei parametri della linea di comando.

doxytag

è usato per generare un file tag e/o un indice di ricerca per un set di file HTML.

doxywizard

è un front-end GUI per configurare ed eseguire doxygen.

Last updated on