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.

  4. How can I change what's after the 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.

  5. How can I use tag files in combination with compressed HTML

    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">
    
    Unfortunately this only works if both compressed HTML files are in the same directory.

    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::
    
    or you can use installdox to set the links as follows:
    installdox -lb.tag@b.chm::
    


Generated at Wed Feb 2 07:13:43 2000 by doxygen 1.0.0 written by Dimitri van Heesch, © 1997-1999