Sono interessato a scrivere una "introduzione" nella pagina index.html, piuttosto che avere uno spazio vuoto. È una funzionalità supportata dallo strumento Doxygen o devo creare un hack?C'è un modo per personalizzare l'output di Doxygen index.html (e l'equivalente in lattice)?
8
A
risposta
18
questo è risolta dalla prima domanda nel Doxygen FAQ:
1. Come ottenere informazioni sulla pagina di indice in HTML?
Si consiglia di utilizzare il comando \ mainpage all'interno di un blocco di commento come questo:
/*! \mainpage My Personal Index Page * * \section intro_sec Introduction * * This is the introduction. * * \section install_sec Installation * * \subsection step1 Step 1: Opening the box * * etc... */
1
Se siete alla ricerca per le copertine più personalizzati in entrambe le uscite LaTeX e HTML, si potrebbe anche voler giocare con i tag LATEX_HEADER
e HTML_HEADER
(e HTML_FOOTER
).
Oh andiamo Oli, perché qualcuno dovrebbe guardare la prima domanda delle FAQ! :-) (+1 tra l'altro) – Praetorian
Vale la pena notare che questo commento (e qualsiasi altra documentazione suplementare) può esistere in un file di testo semplice contenente solo markup Doxygen e nessun codice, indipendente da qualsiasi file di codice sorgente e aggiunto a il progetto Doxygen. – Clifford