/****************************************************************************** * * * * Copyright (C) 1997-2001 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby * granted. No representations are made about the suitability of this software * for any purpose. It is provided "as is" without express or implied warranty. * See the GNU General Public License for more details. * * Documents produced by Doxygen are derivative works derived from the * input used in their production; they are not affected by this license. * */ /*! \page faq Frequently Asked Questions
  1. How to get information on the index page in HTML?

    You should use the \\mainpage command inside a comment block like this: \verbatim /*! \mainpage My Personal Index Page * * \section intro Introduction * * This is the introduction. * * \section install Installation * * \subsection step1 Step 1: Opening the box * * etc... */ \endverbatim

  2. Help, some/all of the members of my class / file / namespace are not documented? Check the following:
    1. Is your class / file / namespace documented? If not, it will not be extracted from the sources unless \c EXTRACT_ALL is set to \c YES in the config file.
    2. Are the members private? If so, you must set \c EXTRACT_PRIVATE to \c YES to make them appear in the documentation.
    3. Is there a function macro in your class that does not end with a semicolon (e.g. MY_MACRO())? If so then you have to instruct doxygen's preprocessor to remove it. This typically boils down to the following settings in the config file: \verbatim ENABLE_PREPROCESSING = YES MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = YES PREDEFINED = MY_MACRO()= \endverbatim Please read the \ref preprocessing "preprocessing" section of the manual for more information.
  3. When I set EXTRACT_ALL to NO non of my functions are shown in the documentation.
    4. In order for global functions, variables, enums, typedefs, and defines to be documented you should document the file in which these commands are located using a comment block containing a \\file (or \@file) command. Alternatively, you can put all members in a group (or module) using the \\ingroup command and then document the group using a comment block containing the \\defgroup command.
  4. How can I make doxygen ignore some code fragment?

    You can use Doxygen's preprocessor for this: If you put \verbatim #ifndef DOXYGEN_SHOULD_SKIP_THIS /* code that must be skipped by Doxygen */ #endif /* DOXYGEN_SHOULD_SKIP_THIS */ \endverbatim around the blocks that should be hidden and put: \verbatim PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \endverbatim in the config file then all blocks should be skipped by Doxygen as long as PREPROCESSING = YES.

  5. How can I change what is after the \#include in the class documentation? You can document your class like \verbatim /*! \class MyClassName include.h path/include.h * * Docs for MyClassName */ \endverbatim To make doxygen put

    #include 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 doxygen to show that the include file should be included using brackets you should type: \verbatim /*! \class MyClassName include.h "path/include.h" * * Docs for MyClassName */ \endverbatim
  6. How can I use tag files in combination with compressed HTML? If you want to refer from one compressed HTML file \c a.chm to another compressed HTML file called \c b.chm, the link in \c a.chm must have the following format: \verbatim \endverbatim Unfortunately this only works if both compressed HTML files are in the same directory. As a result you must rename the generated \c index.chm files for all projects into something unique and put all \c .chm files in one directory. Suppose you have a project \e a referring to a project \e b using tag file \c b.tag, then you could rename the \c index.chm for project \e a into \c a.chm and the \c index.chm for project \e b into \c b.chm. In the configuration file for project \e a you write: \verbatim TAGFILES = b.tag=b.chm:: \endverbatim or you can use \c installdox to set the links as follows: \verbatim installdox -lb.tag@b.chm:: \endverbatim
  7. I don't like the quick index that is put above each HTML page, what do I do? You can disable the index by setting DISABLE_INDEX to YES. Then you can put in your own header file by writing your own header and feed that to HTML_HEADER.
  8. The overall HTML output looks different, while I only wanted to use my own html header file You probably forgot to include the stylesheet doxygen.css that doxygen generates. You can include this by putting \verbatim \endverbatim in the HEAD section of the HTML page.
  9. Why does doxygen use Qt? The most important reason is to have a platform abstraction for most Unices and Windows by means of the QFile, QFileInfo, QDir, QDate, QTime and QIODevice classes. Another reason is for the nice and bug free utility classes, like QList, QDict, QString, QArray, QTextStream, QRegExp, QXML etc. The GUI front-end doxywizard uses Qt for... well... the GUI!
  10. How can I exclude all test directories from my directory tree? Simply put an exclude pattern like this in the configuration file: \verbatim EXCLUDE_PATTERNS = */test/* \endverbatim
  11. Doxygen automatically generates a link to the class MyClass somewhere in the running text. How do I prevent that at a certain place? Put a \% in front of the class name. Like this: \%MyClass. Doxygen will then remove the % and keep the word unlinked.
  12. Help! I get the cryptic message "input buffer overflow, can't enlarge buffer because scanner uses REJECT" This error happens when doxygen lexical scanner has a rules that matches more than 16K input character in one go. I've seen this happening on a very large generated file (>16K lines), where the built-in preprocessor converted it into an empty file (with >16K of newlines). Another case where this might happen is if you have lines in your code with more than 16K characters.
  13. How did doxygen get it's name? Doxygen got its name from playing with the words documentation and generator. \verbatim documentation -> docs -> dox generator -> gen \endverbatim At the time I was looking into lex and yacc, where a lot of things start with "yy", so the "y" slipped in and made things pronouncable.
  14. What was the reason to develop doxygen? I once wrote a GUI widget based on the Qt library (it is still available at http://qdbttabular.sourceforge.net/ and maintained by Sven Meyer). Qt had nicely generated documentation (using an internal tool which they didn't want to release) and I wrote similar docs by hand. This was a nightmare to maintain, so I wanted a similar tool. I looked at Doc++ but that just wasn't good enough (it didn't support signals and slots and did have the Qt look and feel I have grown to like), so I started to write my own tool...
\htmlonly Go to the next section or return to the index. \endhtmlonly */