You should use the \mainpage command inside a comment block like this:
/*! \mainpage My Personal Index Page * * \section intro Introduction * * This is the introduction. * * \section install Installation * * \subsection step1 Step 1: Opening the box * * etc... */
You can use Doxygen's preprocessor for this: If you put
#ifndef DOXYGEN_SHOULD_SKIP_THIS /* code that must be skipped by Doxygen */ #endif /* DOXYGEN_SHOULD_SKIP_THIS */
PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS
PREPROCESSING = YES
.
Look at section Preprocessing for the answer.
include
in class documentation?
You can document your class like
/*! \class MyClassName include.h path/include.h * * Docs for MyClassName */
To make doxygen put
include <path/include.h>
in the documentation of the class MyClassName regardless of the name of the actual header file in which the definition of MyClassName is contained.
If you want to refer from one compressed HTML file a.chm
to another compressed HTML file called b.chm,
the link in a.chm
must have the following format:
<a href="b.chm::/file.html">
As a result you must rename the generated index.chm
files for all projects into something unique and put all .chm
files in one directory.
Suppose you have a project a referring to a project b using tag file b.tag,
then you could rename the index.chm
for project a into a.chm
and the index.chm
for project b into b.chm.
In the configuration file for project a you write:
TAGFILES = b.tag=b.chm::
installdox
to set the links as follows: installdox -lb.tag@b.chm::