Frequently Asked Questions

  1. How do 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 Introduction
     *
     * This is the introduction.
     *
     * \section install Installation
     *
     * \subsection step1 Step 1: Opening the box
     *  
     * etc...
     */
    

  2. How can I avoid that some code fragment is parsed by Doxyen?

    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 */
    
    around the blocks that should be hidden and put:
      PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS
    
    in the config file then all blocks should be skipped by Doxygen as long as PREPROCESSING = YES.

  3. How can I make doxygen ignore nasty macro's?

    Look at section Preprocessing for the answer.


Generated at Sun Nov 7 15:43:34 1999 by doxygen 0.49-991106 written by Dimitri van Heesch, © 1997-1999