Wednesday, 07 January 2009 arrowHome Add to Technorati Favorites
Main menu
Home
Articoli
RSS news
Saputello
Segnalazioni
Info
The Four Keys
Info sullo speciale
Approfondimenti sul codice
C++, STL, Design Pattern
OpenGL, SDL e Computer Graphics
Artwork




Guida Doxygen E-mail

Formattazione del testo

Doxygen mette a disposizione una vasta gamma di comandi che ci consentono di formattare e strutturare al meglio la nostra documentazione. Tra i più usati troviamo:


  • \b - Alla parola che segue è applicato uno stile "bold".

  • \e - Alla parola che segue è applicato uno stile "italic".

  • \p - Alla parola che segue è applicato uno stile "macchina da scrivere".

  • \a - La parola che segue è visualizzata con uno stile particolare utilizzato per enfatizzare gli argomenti di una  funzione all'interno di un testo.

  • \n - Forza un ritorno a capo nella documentazione.

  • \image - Questo comando permette di inserire un'immagine all'interno della documentazione. Esso deve essere seguito da "html" o "latex" per specificare in quale documentazione includere l'immagine. Se l'immagine deve essere inclusa sia nella documentazione HTML che LaTeX il comando va ripetuto. Come ultimo parametro va specificato il nome del file contenente l'immagine. In questo caso l'immagine deve risiedere nella directory specificata nel Doxyfile alla voce "IMAGE_PATH" e verrà copiata insieme alla documentazione nella directory di output. Se il percorso fornito è assoluto l'immagine non viene copiata nella directory di output e la documentazione utilizzerà tale percorso per riferire all'immagine.



 
< Prev   Next >



I più letti
Suggerimenti Google
Novità
© 2006-2007 Michele Bosi
E' vietata la riproduzione, anche parziale, di contenuti e grafica
Ottimizzato per Firefox 2.0 ed Internet Explorer 6.0