Is there a way to customize output of Doxygen index.html (and latex equivalent)?

Question

I am interested in writing an "introduction" on the index.html page, rather than have blank space. Is this a feature supported by the Doxygen tool, or must I put together a hack?

score 20 · Accepted Answer · edited Mar 24 '19 at 13:50

20

This is answered by the first question in the Doxygen FAQ:

1. How to get information on the index page in HTML?

You should use the \mainpage command inside a comment block like this:
/*! \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...
 */

edited Mar 24 '19 at 13:50

albert

8,285
3
19
32

answered Aug 28 '11 at 17:21

Oliver Charlesworth

267,707
33
569
680

1

Oh come on Oli, why would anyone look at the first question of the FAQ! :-) (+1 by the way) – Praetorian Aug 28 '11 at 17:27
7

Worth noting perhaps that this comment (and any other suplementary documentation) can exist in a plain text file containing only Doxygen mark-up and no code, independent of any source code file and added to the Doxygen project. – Clifford Aug 28 '11 at 21:00

score 2 · Answer 2 · edited Oct 20 '12 at 02:55

2

If you are looking for more customised cover pages in both LaTeX and html outputs, you might also want to play with the tags LATEX_HEADER and HTML_HEADER (and HTML_FOOTER).

edited Oct 20 '12 at 02:55

TheCodeArtist

21,479
4
69
130

answered May 16 '12 at 11:30

Mauro

21
2

Is there a way to customize output of Doxygen index.html (and latex equivalent)?

2 Answers2