Search code examples
cdoxygenliterate-programming

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

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?

Solution

  • 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...
 */