Doxygen: differenze tra le versioni
Contenuto cancellato Contenuto aggiunto
Funzionalità collegamenti suggeriti: 2 collegamenti inseriti. Etichette: Modifica visuale Modifica da mobile Modifica da web per mobile Modifica da mobile avanzata Attività per i nuovi utenti Suggerito: aggiungi collegamenti |
|||
| (2 versioni intermedie di 2 utenti non mostrate) | |||
Riga 27:
Il risultato finale è disponibile sotto forma di pagine [[HTML]] oppure nei formati [[Microsoft Compressed HTML Help|CHM]], [[Rich text format|RTF]], [[PDF]], [[LaTeX]], [[PostScript]] o [[man (Unix)|man pages]] di [[Unix]].
Il formato HTML prodotto si giova di un sistema di [[collegamento ipertestuale|hyperlink]] molto curato che permette al lettore un'agevole navigazione della struttura dei [[File sorgente|file sorgenti]].
La documentazione prodotta riporta anche il [[diagramma delle classi]], nei casi in cui sono presenti relazioni di [[ereditarietà (informatica)|ereditarietà]] tra strutture dati. Grazie all'impiego sinergico di Doxygen con [[Graphviz]], è possibile includere nella documentazione diagrammi delle classi per tutti gli altri tipi di relazioni tra strutture dati.
I documenti possono essere generati in diverse lingue, tra cui è compreso l'italiano.
Riga 38:
Riportiamo di seguito un esempio.
<
/**
* The time class represents a moment of time.
Riga 62:
}
};
</syntaxhighlight>
==Il
Doxygen associa ad ogni progetto da documentare un [[file di configurazione]] che contiene le impostazioni da utilizzare per la generazione.
Questo file è un elenco di assegnazioni di opportuni valori a determinati parametri ('''TAG'''). Ogni tag è formato dalla coppia di informazioni
Riga 73:
analogamente a quanto avviene nei file di configurazione di numerosi altri prodotti open source.
Un frammento di un esempio del file di configurazione è il seguente:
<
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
Riga 135:
LATEX_OUTPUT = latex
</syntaxhighlight>
Come si vede, attraverso il file di configurazione, l'utente stabilisce:
* Il nome del progetto
| |||