doc/faq.doc

   1 /******************************************************************************
   2  *
   3  *
   4  *
   5  * Copyright (C) 1997-2014 by Dimitri van Heesch.
   6  *
   7  * Permission to use, copy, modify, and distribute this software and its
   8  * documentation under the terms of the GNU General Public License is hereby
   9  * granted. No representations are made about the suitability of this software
  10  * for any purpose. It is provided "as is" without express or implied warranty.
  11  * See the GNU General Public License for more details.
  12  *
  13  * Documents produced by Doxygen are derivative works derived from the
  14  * input used in their production; they are not affected by this license.
  15  *
  16  */
  17 /*! \page faq Frequently Asked Questions
  18
  19 \tableofcontents
  20
  21
  22 \section faq_index How to get information on the index page in HTML?
  23 <p>
  24 You should use the \ref cmdmainpage "\\mainpage" command inside a comment block like this:
  25 \verbatim
  26 /*! \mainpage My Personal Index Page
  27  *
  28  * \section intro_sec Introduction
  29  *
  30  * This is the introduction.
  31  *
  32  * \section install_sec Installation
  33  *
  34  * \subsection step1 Step 1: Opening the box
  35  *
  36  * etc...
  37  */
  38 \endverbatim
  39
  40 \section fac_al Help, some/all of the members of my class / file / namespace are not documented?
  41
  42   Check the following:
  43   <ol>
  44   <li>Is your class / file / namespace documented? If not, it will not
  45       be extracted from the sources unless \ref cfg_extract_all "EXTRACT_ALL" is set to \c YES
  46       in the config file.
  47   <li>Are the members private? If so, you must set \ref cfg_extract_private "EXTRACT_PRIVATE" to \c YES
  48       to make them appear in the documentation.
  49   <li>Is there a function macro in your class that does not end with a
  50       semicolon (e.g. MY_MACRO())? If so then you have to instruct
  51       doxygen's preprocessor to remove it.
  52
  53       This typically boils down to the following settings in the config file:
  54
  55       \verbatim
  56 ENABLE_PREPROCESSING   = YES
  57 MACRO_EXPANSION        = YES
  58 EXPAND_ONLY_PREDEF     = YES
  59 PREDEFINED             = MY_MACRO()=
  60       \endverbatim
  61
  62       Please read the \ref preprocessing "preprocessing" section of the
  63       manual for more information.
  64   </ol>
  65
  66 \section faq_extract_allWhen I set EXTRACT_ALL to NO none of my functions are shown in the documentation.
  67
  68 In order for global functions, variables, enums, typedefs, and defines
  69 to be documented you should document the file in which these commands are
  70 located using a comment block containing a \ref cmdfile "\\file" (or \ref cmdfile "\@file")
  71 command.
  72
  73 Alternatively, you can put all members in a group (or module)
  74 using the \ref cmdingroup "\\ingroup" command and then document the group using a comment
  75 block containing the \ref cmddefgroup "\\defgroup" command.
  76
  77 For member functions or functions that are part of a namespace you should
  78 document either the class or namespace.
  79
  80 \section faq_code How can I make doxygen ignore some code fragment?
  81
  82 The new and easiest way is to add one comment block
  83 with a \ref cmdcond "\\cond" command at the start and one comment block
  84 with a \ref cmdendcond "\\endcond" command at the end of the piece of
  85 code that should be ignored. This should be within the same file of course.
  86
  87 But you can also use Doxygen's preprocessor for this:
  88 If you put
  89 \verbatim
  90 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  91
  92  /* code that must be skipped by Doxygen */
  93
  94 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  95 \endverbatim
  96 around the blocks that should be hidden and put:
  97 \verbatim
  98   PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS
  99 \endverbatim
 100 in the config file then all blocks should be skipped by Doxygen as long
 101 as \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" is set to `YES`.
 102
 103 \section faq_code_inc How can I change what is after the <code>\#include</code> in the class documentation?
 104
 105 In most cases you can use \ref cfg_strip_from_inc_path "STRIP_FROM_INC_PATH"
 106 to strip a user defined part of a path.
 107
 108 You can also document your class as follows
 109
 110 \verbatim
 111 /*! \class MyClassName include.h path/include.h
 112  *
 113  *  Docs for MyClassName
 114  */
 115 \endverbatim
 116
 117 To make doxygen put <br><br>
 118 <code>
 119 \#include \<path/include.h\>
 120 </code>
 121
 122 in the documentation of the class MyClassName regardless of the name of the actual
 123 header file in which the definition of MyClassName is contained.
 124
 125 If you want doxygen to show that the include file should be included using
 126 quotes instead of angle brackets you should type:
 127 \verbatim
 128 /*! \class MyClassName myhdr.h "path/myhdr.h"
 129  *
 130  *  Docs for MyClassName
 131  */
 132 \endverbatim
 133
 134 \section faq_chm How can I use tag files in combination with compressed HTML?
 135
 136 If you want to refer from one compressed HTML file
 137 \c a.chm to another compressed HTML file
 138 called \c b.chm, the
 139 link in \c a.chm must have the following format:
 140 \verbatim
 141 <a href="b.chm::/file.html">
 142 \endverbatim
 143 Unfortunately this only works if both compressed HTML files are in the same
 144 directory.
 145
 146 As a result you must rename the generated \c index.chm files for all projects
 147 into something unique and put all <code>.chm</code> files in one directory.
 148
 149 Suppose you have a project \e a referring to a project \e b using tag file
 150 \c b.tag, then you could rename the \c index.chm for project \e a into
 151 \c a.chm and the \c index.chm for project \e b into \c b.chm. In the
 152 configuration file for project \e a you write:
 153 \verbatim
 154 TAGFILES = b.tag=b.chm::
 155 \endverbatim
 156
 157 \section faq_html I don't like the quick index that is put above each HTML page, what do I do?
 158
 159 You can disable the index by setting \ref cfg_disable_index "DISABLE_INDEX" to `YES`. Then you can
 160 put in your own header file by writing your own header and feed that to
 161 \ref cfg_html_header "HTML_HEADER".
 162
 163 \section faq_html_header The overall HTML output looks different, while I only wanted to use my own html header file
 164
 165 You probably forgot to include the stylesheet <code>doxygen.css</code> that
 166 doxygen generates. You can include this by putting
 167 \verbatim
 168 <LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
 169 \endverbatim
 170 in the HEAD section of the HTML page.
 171
 172 \section faq_use_qt Why does doxygen use Qt?
 173
 174 The most important reason is to have a platform abstraction for most
 175 Unices and Windows by means of the QFile, QFileInfo, QDir, QDate,
 176 QTime and QIODevice classes.
 177 Another reason is for the nice and bug free utility classes, like QList,
 178 QDict, QString, QArray, QTextStream, QRegExp, QXML etc.
 179
 180 The GUI front-end doxywizard uses Qt for... well... the GUI!
 181
 182 \section faq_excl_dir How can I exclude all test directories from my directory tree?
 183
 184 Simply put an exclude pattern like this in the configuration file:
 185
 186 \verbatim
 187 EXCLUDE_PATTERNS = */test/*
 188 \endverbatim
 189
 190 \section faq_class Doxygen automatically generates a link to the class MyClass somewhere in the running text.  How do I prevent that at a certain place?
 191
 192 Put a \% in front of the class name. Like this: \%MyClass. Doxygen will then
 193 remove the % and keep the word unlinked.
 194
 195 \section faq_pgm_X My favorite programming language is X. Can I still use doxygen?
 196
 197 No, not as such; doxygen needs to understand the structure of what it reads.
 198 If you don't mind spending some time on it, there are several options:
 199 - If the grammar of X is close to C or C++, then it is probably not too hard to
 200   tweak src/scanner.l a bit so the language is supported. This is done
 201   for all other languages directly supported by doxygen
 202   (i.e. Java, IDL, C#, PHP).
 203 - If the grammar of X is somewhat different than you can write an input
 204   filter that translates X into something similar enough to C/C++ for
 205   doxygen to understand (this approach is taken for VB, Object Pascal, and
 206   Javascript, see http://www.stack.nl/~dimitri/doxygen/download.html#helpers).
 207 - If the grammar is completely different one could write a parser for X and
 208   write a backend that produces a similar syntax tree as is done by
 209   src/scanner.l (and also by src/tagreader.cpp while reading tag files).
 210
 211 \section faq_lex Help! I get the cryptic message "input buffer overflow, can't enlarge buffer because scanner uses REJECT"
 212
 213 This error happens when doxygen's lexical scanner has a rule that matches
 214 more than 256K of input characters in one go. I've seen this happening
 215 on a very large generated file (\>256K lines), where the built-in preprocessor
 216 converted it into an empty file (with \>256K of newlines). Another case
 217 where this might happen is if you have lines in your code with more than
 218 256K characters.
 219
 220 If you have run into such a case and want me to fix it, you
 221 should send me a code fragment that triggers the message. To work around
 222 the problem, put some line-breaks into your file, split it up into smaller
 223 parts, or exclude it from the input using EXCLUDE.
 224
 225 \section faq_latex When running make in the latex dir I get "TeX capacity exceeded". Now what?
 226
 227 You can edit the texmf.cfg file to increase the default values of the
 228 various buffers and then run "texconfig init".
 229
 230 \section faq_stl Why are dependencies via STL classes not shown in the dot graphs?
 231
 232 Doxygen is unaware of the STL classes, unless the
 233 option \ref cfg_builtin_stl_support "BUILTIN_STL_SUPPORT" is turned on.
 234
 235 \section faq_search I have problems getting the search engine to work with PHP5 and/or windows
 236
 237 Please read <a href="searchengine.html">this</a> for hints on where to look.
 238
 239 \section faq_cmdline Can I configure doxygen from the command line?
 240
 241 Not via command line options, but doxygen can read from <code>stdin</code>,
 242 so you can pipe things through it. Here's an example how to override an option
 243 in a configuration file from the command line (assuming a UNIX like environment):
 244
 245 \verbatim
 246 ( cat Doxyfile ; echo "PROJECT_NUMBER=1.0" ) | doxygen -
 247 \endverbatim
 248
 249 For Windows the following would do the same:
 250
 251 \verbatim
 252 ( type Doxyfile & echo PROJECT_NUMBER=1.0 ) | doxygen.exe -
 253 \endverbatim
 254
 255 If multiple options with the same name are specified then doxygen will use
 256 the last one. To append to an existing option you can use the += operator.
 257
 258 \section faq_name How did doxygen get its name?
 259
 260 Doxygen got its name from playing with the words
 261 documentation and generator.
 262
 263 \verbatim
 264 documentation -> docs -> dox
 265 generator -> gen
 266 \endverbatim
 267
 268 At the time I was looking into \c lex and \c yacc, where a lot of things start with
 269 "yy", so the "y" slipped in and made things pronounceable
 270 (the proper pronouncement is Docs-ee-gen, so with a long "e").
 271
 272 \section faq_why What was the reason to develop doxygen?
 273
 274 I once wrote a GUI widget based on the Qt library (it is still available at
 275 http://sourceforge.net/projects/qdbttabular/ but hasn't been updated since 2002).
 276 Qt had nicely generated documentation (using an internal tool which
 277 <a href="http://rant.gulbrandsen.priv.no/udoc/history">they didn't want to release</a>)
 278 and I wrote similar docs by hand.
 279 This was a nightmare to maintain, so I wanted a similar tool. I looked at
 280 Doc++ but that just wasn't good enough (it didn't support signals and
 281 slots and did not have the Qt look and feel I had grown to like),
 282 so I started to write my own tool...
 283
 284 \htmlonly
 285 Go to the <a href="trouble.html">next</a> section or return to the
 286  <a href="index.html">index</a>.
 287 \endhtmlonly
 288
 289 */
 290