summaryrefslogtreecommitdiffstats
path: root/doc/faq.doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/faq.doc')
-rw-r--r--doc/faq.doc20
1 files changed, 16 insertions, 4 deletions
diff --git a/doc/faq.doc b/doc/faq.doc
index c730289..3d936fe 100644
--- a/doc/faq.doc
+++ b/doc/faq.doc
@@ -18,12 +18,19 @@
<ol>
<li><b>How do get information on the index page in HTML?</b>
<p>
-There is no real support for title pages at the moment. But you can
-override the default index page, by using the following comment block:
+You should use the \\mainpage command inside a comment block like this:
\verbatim
-/*! \page index My Personal Index Page
+/*! \mainpage My Personal Index Page
*
- * This is my index personal index page.
+ * \section intro Introduction
+ *
+ * This is the introduction.
+ *
+ * \section install Installation
+ *
+ * \subsection step1 Step 1: Opening the box
+ *
+ * etc...
*/
\endverbatim
@@ -44,6 +51,11 @@ around the blocks that should be hidden and put:
\endverbatim
in the config file then all blocks should be skipped by Doxygen as long
as <code>PREPROCESSING = YES</code>.
+
+<li><b>How can I make doxygen ignore nasty macro's? </b>
+
+Look at section \ref preprocessing for the answer.
+
</ol>
*/