Menu
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?
384
How can I make doxygen ignore some code fragment? The new and easiest way is to add one comment block with a \cond command at the start and one comment block with a \endcond command at the end of the piece of code that should be ignored. This should be within the same file of course.
A configuration file is a free-form ASCII text file with a structure that is similar to that of a Makefile , with the default name Doxyfile . It is parsed by doxygen . The file may contain tabs and newlines for formatting purposes.
Notes: As pointed out in the Doxygen documentation for the ALIAS tag, you can put \n's in the value part of an alias to insert newlines. Ok, although the build people are going to complain that I'm wasting my time and their with minutiae rather than doing actual work...
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... */
115
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
