|
Page 6 of 23 Generare la documentazione
Per generare la prima documentazione dobbiamo creare un "Doxyfile" di default. Per fare questo digitiamo "doxygen -g" da shell. Doxygen creerà un file di nome "Doxyfile" nella directory corrente. Esso è fittamente documentato e presenta numerose opzioni. Per il momento quello che ci serve è solamente specificare il file di input (contenente i commenti Doxygen) e la directory di output nella quale salvare la documentazione. I file da cui estrarre la documentazione possono essere specificati attraverso la voce "INPUT". Useremo l'opzione "OUTPUT_DIRECTORY" per specificare dove vogliamo salvare la documentazione generata. Volendo possiamo anche modificare "PROJECT_NAME" e "PROJECT_NUMBER" per definire rispettivamente il nome del progetto e la versione.
Estratto da un possibile Doxyfile: # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
PROJECT_NAME = Mio Progetto
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
# if some version control system is used.
PROJECT_NUMBER = 1.0
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = c:\documentazione
|
Una volta configurato appropriatamente il Doxyfile basta invocare il comando "doxygen" il quale lo leggerà dalla directory corrente e produrrà la documentazione.
|
Home 
Articoli 
