| 5 |
26 Feb 03 |
jari |
# $Id$ |
| 5 |
26 Feb 03 |
jari |
2 |
|
| 2119 |
12 Dec 09 |
peter |
# Copyright (C) 2003, 2004 Jari Häkkinen |
| 1746 |
23 Jan 09 |
peter |
# Copyright (C) 2005 Peter Johansson |
| 2119 |
12 Dec 09 |
peter |
# Copyright (C) 2006, 2007 Jari Häkkinen, Peter Johansson |
| 2119 |
12 Dec 09 |
peter |
# Copyright (C) 2008 Jari Häkkinen, Peter Johansson, Markus Ringnér |
| 3987 |
26 Aug 20 |
peter |
# Copyright (C) 2009, 2010, 2012, 2014, 2017, 2018, 2020 Peter Johansson |
| 577 |
07 Apr 06 |
jari |
8 |
# |
| 1437 |
25 Aug 08 |
peter |
# This file is part of the yat library, http://dev.thep.lu.se/yat |
| 577 |
07 Apr 06 |
jari |
10 |
# |
| 675 |
10 Oct 06 |
jari |
# The yat library is free software; you can redistribute it |
| 577 |
07 Apr 06 |
jari |
# and/or modify it under the terms of the GNU General Public License as |
| 1486 |
09 Sep 08 |
jari |
# published by the Free Software Foundation; either version 3 of the |
| 577 |
07 Apr 06 |
jari |
# License, or (at your option) any later version. |
| 577 |
07 Apr 06 |
jari |
15 |
# |
| 675 |
10 Oct 06 |
jari |
# The yat library is distributed in the hope that it will be useful, |
| 577 |
07 Apr 06 |
jari |
# but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 577 |
07 Apr 06 |
jari |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 577 |
07 Apr 06 |
jari |
# General Public License for more details. |
| 577 |
07 Apr 06 |
jari |
20 |
# |
| 577 |
07 Apr 06 |
jari |
# You should have received a copy of the GNU General Public License |
| 1487 |
10 Sep 08 |
jari |
# along with yat. If not, see <http://www.gnu.org/licenses/>. |
| 577 |
07 Apr 06 |
jari |
23 |
# |
| 577 |
07 Apr 06 |
jari |
24 |
|
| 5 |
26 Feb 03 |
jari |
# Doxyfile 1.2.13.1 |
| 5 |
26 Feb 03 |
jari |
26 |
|
| 5 |
26 Feb 03 |
jari |
# This file describes the settings to be used by the documentation system |
| 5 |
26 Feb 03 |
jari |
# doxygen (www.doxygen.org) for a project |
| 5 |
26 Feb 03 |
jari |
29 |
# |
| 5 |
26 Feb 03 |
jari |
# All text after a hash (#) is considered a comment and will be ignored |
| 5 |
26 Feb 03 |
jari |
# The format is: |
| 5 |
26 Feb 03 |
jari |
# TAG = value [value, ...] |
| 5 |
26 Feb 03 |
jari |
# For lists items can also be appended using: |
| 5 |
26 Feb 03 |
jari |
# TAG += value [value, ...] |
| 5 |
26 Feb 03 |
jari |
# Values that contain spaces should be placed between quotes (" ") |
| 5 |
26 Feb 03 |
jari |
36 |
|
| 5 |
26 Feb 03 |
jari |
37 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
# General configuration options |
| 5 |
26 Feb 03 |
jari |
39 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
40 |
|
| 2739 |
07 Jun 12 |
peter |
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
| 5 |
26 Feb 03 |
jari |
# by quotes) that should identify the project. |
| 5 |
26 Feb 03 |
jari |
43 |
|
| 1225 |
12 Mar 08 |
peter |
PROJECT_NAME = "@PACKAGE@" |
| 5 |
26 Feb 03 |
jari |
45 |
|
| 2739 |
07 Jun 12 |
peter |
# The PROJECT_NUMBER tag can be used to enter a project or revision number. |
| 2739 |
07 Jun 12 |
peter |
# This could be handy for archiving the generated documentation or |
| 5 |
26 Feb 03 |
jari |
# if some version control system is used. |
| 5 |
26 Feb 03 |
jari |
49 |
|
| 1556 |
09 Oct 08 |
jari |
PROJECT_NUMBER = @PACKAGE_VERSION@ |
| 5 |
26 Feb 03 |
jari |
51 |
|
| 2739 |
07 Jun 12 |
peter |
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
| 2739 |
07 Jun 12 |
peter |
# base path where the generated documentation will be put. |
| 2739 |
07 Jun 12 |
peter |
# If a relative path is entered, it will be relative to the location |
| 5 |
26 Feb 03 |
jari |
# where doxygen was started. If left blank the current directory will be used. |
| 5 |
26 Feb 03 |
jari |
56 |
|
| 2739 |
07 Jun 12 |
peter |
OUTPUT_DIRECTORY = doc |
| 5 |
26 Feb 03 |
jari |
58 |
|
| 2739 |
07 Jun 12 |
peter |
# The OUTPUT_LANGUAGE tag is used to specify the language in which all |
| 2739 |
07 Jun 12 |
peter |
# documentation generated by doxygen is written. Doxygen will use this |
| 2739 |
07 Jun 12 |
peter |
# information to generate all constant output in the proper language. |
| 2739 |
07 Jun 12 |
peter |
# The default language is English, other supported languages are: |
| 2739 |
07 Jun 12 |
peter |
# Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French, |
| 2739 |
07 Jun 12 |
peter |
# German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish, |
| 5 |
26 Feb 03 |
jari |
# Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish. |
| 5 |
26 Feb 03 |
jari |
66 |
|
| 5 |
26 Feb 03 |
jari |
OUTPUT_LANGUAGE = English |
| 5 |
26 Feb 03 |
jari |
68 |
|
| 2739 |
07 Jun 12 |
peter |
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
| 2739 |
07 Jun 12 |
peter |
# documentation are documented, even if no documentation was available. |
| 2739 |
07 Jun 12 |
peter |
# Private class members and static file members will be hidden unless |
| 5 |
26 Feb 03 |
jari |
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
| 5 |
26 Feb 03 |
jari |
73 |
|
| 304 |
02 May 05 |
peter |
EXTRACT_ALL = NO |
| 5 |
26 Feb 03 |
jari |
75 |
|
| 2739 |
07 Jun 12 |
peter |
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
| 5 |
26 Feb 03 |
jari |
# will be included in the documentation. |
| 5 |
26 Feb 03 |
jari |
78 |
|
| 5 |
26 Feb 03 |
jari |
EXTRACT_PRIVATE = NO |
| 5 |
26 Feb 03 |
jari |
80 |
|
| 2739 |
07 Jun 12 |
peter |
# If the EXTRACT_STATIC tag is set to YES all static members of a file |
| 5 |
26 Feb 03 |
jari |
# will be included in the documentation. |
| 5 |
26 Feb 03 |
jari |
83 |
|
| 5 |
26 Feb 03 |
jari |
EXTRACT_STATIC = NO |
| 5 |
26 Feb 03 |
jari |
85 |
|
| 2739 |
07 Jun 12 |
peter |
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) |
| 2739 |
07 Jun 12 |
peter |
# defined locally in source files will be included in the documentation. |
| 5 |
26 Feb 03 |
jari |
# If set to NO only classes defined in header files are included. |
| 5 |
26 Feb 03 |
jari |
89 |
|
| 5 |
26 Feb 03 |
jari |
EXTRACT_LOCAL_CLASSES = YES |
| 5 |
26 Feb 03 |
jari |
91 |
|
| 2739 |
07 Jun 12 |
peter |
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
| 2739 |
07 Jun 12 |
peter |
# undocumented classes that are normally visible in the class hierarchy. |
| 2739 |
07 Jun 12 |
peter |
# If set to NO (the default) these class will be included in the various |
| 5 |
26 Feb 03 |
jari |
# overviews. This option has no effect if EXTRACT_ALL is enabled. |
| 5 |
26 Feb 03 |
jari |
96 |
|
| 5 |
26 Feb 03 |
jari |
HIDE_UNDOC_CLASSES = NO |
| 5 |
26 Feb 03 |
jari |
98 |
|
| 2739 |
07 Jun 12 |
peter |
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
| 2739 |
07 Jun 12 |
peter |
# include brief member descriptions after the members that are listed in |
| 2739 |
07 Jun 12 |
peter |
# the file and class documentation (similar to JavaDoc). |
| 5 |
26 Feb 03 |
jari |
# Set to NO to disable this. |
| 5 |
26 Feb 03 |
jari |
103 |
|
| 5 |
26 Feb 03 |
jari |
BRIEF_MEMBER_DESC = YES |
| 5 |
26 Feb 03 |
jari |
105 |
|
| 2739 |
07 Jun 12 |
peter |
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend |
| 2739 |
07 Jun 12 |
peter |
# the brief description of a member or function before the detailed description. |
| 2739 |
07 Jun 12 |
peter |
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
| 5 |
26 Feb 03 |
jari |
# brief descriptions will be completely suppressed. |
| 5 |
26 Feb 03 |
jari |
110 |
|
| 5 |
26 Feb 03 |
jari |
REPEAT_BRIEF = YES |
| 5 |
26 Feb 03 |
jari |
112 |
|
| 2739 |
07 Jun 12 |
peter |
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
| 2739 |
07 Jun 12 |
peter |
# Doxygen will generate a detailed section even if there is only a brief |
| 5 |
26 Feb 03 |
jari |
# description. |
| 5 |
26 Feb 03 |
jari |
116 |
|
| 5 |
26 Feb 03 |
jari |
ALWAYS_DETAILED_SEC = NO |
| 5 |
26 Feb 03 |
jari |
118 |
|
| 2739 |
07 Jun 12 |
peter |
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited |
| 2739 |
07 Jun 12 |
peter |
# members of a class in the documentation of that class as if those members were |
| 2739 |
07 Jun 12 |
peter |
# ordinary class members. Constructors, destructors and assignment operators of |
| 5 |
26 Feb 03 |
jari |
# the base classes will not be shown. |
| 5 |
26 Feb 03 |
jari |
123 |
|
| 1225 |
12 Mar 08 |
peter |
INLINE_INHERITED_MEMB = YES |
| 5 |
26 Feb 03 |
jari |
125 |
|
| 2739 |
07 Jun 12 |
peter |
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
| 2739 |
07 Jun 12 |
peter |
# path before files name in the file list and in the header files. If set |
| 5 |
26 Feb 03 |
jari |
# to NO the shortest path that makes the file name unique will be used. |
| 5 |
26 Feb 03 |
jari |
129 |
|
| 642 |
07 Sep 06 |
peter |
FULL_PATH_NAMES = YES |
| 1070 |
11 Feb 08 |
markus |
131 |
|
| 2739 |
07 Jun 12 |
peter |
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
| 2739 |
07 Jun 12 |
peter |
# can be used to strip a user defined part of the path. Stripping is |
| 2739 |
07 Jun 12 |
peter |
# only done if one of the specified strings matches the left-hand part of |
| 5 |
26 Feb 03 |
jari |
# the path. It is allowed to use relative paths in the argument list. |
| 5 |
26 Feb 03 |
jari |
136 |
|
| 3690 |
13 Sep 17 |
peter |
STRIP_FROM_PATH = @canonical_abs_top_srcdir@ |
| 5 |
26 Feb 03 |
jari |
138 |
|
| 2739 |
07 Jun 12 |
peter |
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of |
| 2739 |
07 Jun 12 |
peter |
# the path mentioned in the documentation of a class, which tells |
| 2739 |
07 Jun 12 |
peter |
# the reader which header file to include in order to use a class. |
| 2739 |
07 Jun 12 |
peter |
# If left blank only the name of the header file containing the class |
| 2739 |
07 Jun 12 |
peter |
# definition is used. Otherwise one should specify the include paths that |
| 647 |
13 Sep 06 |
peter |
# are normally passed to the compiler using the -I flag. |
| 647 |
13 Sep 06 |
peter |
145 |
|
| 3690 |
13 Sep 17 |
peter |
STRIP_FROM_INC_PATH = @canonical_abs_top_srcdir@ |
| 647 |
13 Sep 06 |
peter |
147 |
|
| 2739 |
07 Jun 12 |
peter |
# The INTERNAL_DOCS tag determines if documentation |
| 2739 |
07 Jun 12 |
peter |
# that is typed after a \internal command is included. If the tag is set |
| 2739 |
07 Jun 12 |
peter |
# to NO (the default) then the documentation will be excluded. |
| 5 |
26 Feb 03 |
jari |
# Set it to YES to include the internal documentation. |
| 5 |
26 Feb 03 |
jari |
152 |
|
| 1150 |
25 Feb 08 |
peter |
INTERNAL_DOCS = YES |
| 5 |
26 Feb 03 |
jari |
154 |
|
| 2739 |
07 Jun 12 |
peter |
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct |
| 2739 |
07 Jun 12 |
peter |
# doxygen to hide any special comment blocks from generated source code |
| 5 |
26 Feb 03 |
jari |
# fragments. Normal C and C++ comments will always remain visible. |
| 5 |
26 Feb 03 |
jari |
158 |
|
| 5 |
26 Feb 03 |
jari |
STRIP_CODE_COMMENTS = YES |
| 5 |
26 Feb 03 |
jari |
160 |
|
| 2739 |
07 Jun 12 |
peter |
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
| 2739 |
07 Jun 12 |
peter |
# file names in lower case letters. If set to YES upper case letters are also |
| 2739 |
07 Jun 12 |
peter |
# allowed. This is useful if you have classes or files whose names only differ |
| 2739 |
07 Jun 12 |
peter |
# in case and if your file system supports case sensitive file names. Windows |
| 5 |
26 Feb 03 |
jari |
# users are adviced to set this option to NO. |
| 5 |
26 Feb 03 |
jari |
166 |
|
| 5 |
26 Feb 03 |
jari |
CASE_SENSE_NAMES = YES |
| 5 |
26 Feb 03 |
jari |
168 |
|
| 2739 |
07 Jun 12 |
peter |
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
| 2739 |
07 Jun 12 |
peter |
# (but less readable) file names. This can be useful is your file systems |
| 5 |
26 Feb 03 |
jari |
# doesn't support long names like on DOS, Mac, or CD-ROM. |
| 5 |
26 Feb 03 |
jari |
172 |
|
| 5 |
26 Feb 03 |
jari |
SHORT_NAMES = NO |
| 5 |
26 Feb 03 |
jari |
174 |
|
| 2739 |
07 Jun 12 |
peter |
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
| 2739 |
07 Jun 12 |
peter |
# will show members with their full class and namespace scopes in the |
| 5 |
26 Feb 03 |
jari |
# documentation. If set to YES the scope will be hidden. |
| 5 |
26 Feb 03 |
jari |
178 |
|
| 5 |
26 Feb 03 |
jari |
HIDE_SCOPE_NAMES = NO |
| 5 |
26 Feb 03 |
jari |
180 |
|
| 2739 |
07 Jun 12 |
peter |
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
| 2739 |
07 Jun 12 |
peter |
# will generate a verbatim copy of the header file for each class for |
| 5 |
26 Feb 03 |
jari |
# which an include is specified. Set to NO to disable this. |
| 5 |
26 Feb 03 |
jari |
184 |
|
| 5 |
26 Feb 03 |
jari |
VERBATIM_HEADERS = YES |
| 5 |
26 Feb 03 |
jari |
186 |
|
| 2739 |
07 Jun 12 |
peter |
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen |
| 2739 |
07 Jun 12 |
peter |
# will put list of the files that are included by a file in the documentation |
| 5 |
26 Feb 03 |
jari |
# of that file. |
| 5 |
26 Feb 03 |
jari |
190 |
|
| 5 |
26 Feb 03 |
jari |
SHOW_INCLUDE_FILES = YES |
| 5 |
26 Feb 03 |
jari |
192 |
|
| 2739 |
07 Jun 12 |
peter |
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
| 2739 |
07 Jun 12 |
peter |
# will interpret the first line (until the first dot) of a JavaDoc-style |
| 2739 |
07 Jun 12 |
peter |
# comment as the brief description. If set to NO, the JavaDoc |
| 2739 |
07 Jun 12 |
peter |
# comments will behave just like the Qt-style comments (thus requiring an |
| 5 |
26 Feb 03 |
jari |
# explict @brief command for a brief description. |
| 5 |
26 Feb 03 |
jari |
198 |
|
| 5 |
26 Feb 03 |
jari |
JAVADOC_AUTOBRIEF = NO |
| 5 |
26 Feb 03 |
jari |
200 |
|
| 2739 |
07 Jun 12 |
peter |
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
| 2739 |
07 Jun 12 |
peter |
# member inherits the documentation from any documented member that it |
| 5 |
26 Feb 03 |
jari |
# reimplements. |
| 5 |
26 Feb 03 |
jari |
204 |
|
| 5 |
26 Feb 03 |
jari |
INHERIT_DOCS = YES |
| 5 |
26 Feb 03 |
jari |
206 |
|
| 2739 |
07 Jun 12 |
peter |
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] |
| 5 |
26 Feb 03 |
jari |
# is inserted in the documentation for inline members. |
| 5 |
26 Feb 03 |
jari |
209 |
|
| 5 |
26 Feb 03 |
jari |
INLINE_INFO = YES |
| 5 |
26 Feb 03 |
jari |
211 |
|
| 2739 |
07 Jun 12 |
peter |
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen |
| 2739 |
07 Jun 12 |
peter |
# will sort the (detailed) documentation of file and class members |
| 2739 |
07 Jun 12 |
peter |
# alphabetically by member name. If set to NO the members will appear in |
| 5 |
26 Feb 03 |
jari |
# declaration order. |
| 5 |
26 Feb 03 |
jari |
216 |
|
| 5 |
26 Feb 03 |
jari |
SORT_MEMBER_DOCS = YES |
| 5 |
26 Feb 03 |
jari |
218 |
|
| 2739 |
07 Jun 12 |
peter |
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be |
| 2739 |
07 Jun 12 |
peter |
# sorted by fully-qualified names, including namespaces. If set to |
| 2739 |
07 Jun 12 |
peter |
# NO (the default), the class list will be sorted only by class name, |
| 2739 |
07 Jun 12 |
peter |
# not including the namespace part. |
| 652 |
21 Sep 06 |
peter |
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
| 2739 |
07 Jun 12 |
peter |
# Note: This option applies only to the class list, not to the |
| 652 |
21 Sep 06 |
peter |
# alphabetical list. |
| 652 |
21 Sep 06 |
peter |
226 |
|
| 652 |
21 Sep 06 |
peter |
SORT_BY_SCOPE_NAME = YES |
| 652 |
21 Sep 06 |
peter |
228 |
|
| 2739 |
07 Jun 12 |
peter |
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
| 2739 |
07 Jun 12 |
peter |
# tag is set to YES, then doxygen will reuse the documentation of the first |
| 2739 |
07 Jun 12 |
peter |
# member in the group (if any) for the other members of the group. By default |
| 5 |
26 Feb 03 |
jari |
# all members of a group must be documented explicitly. |
| 5 |
26 Feb 03 |
jari |
233 |
|
| 316 |
17 May 05 |
peter |
DISTRIBUTE_GROUP_DOC = YES |
| 5 |
26 Feb 03 |
jari |
235 |
|
| 2739 |
07 Jun 12 |
peter |
# The TAB_SIZE tag can be used to set the number of spaces in a tab. |
| 5 |
26 Feb 03 |
jari |
# Doxygen uses this value to replace tabs by spaces in code fragments. |
| 5 |
26 Feb 03 |
jari |
238 |
|
| 1225 |
12 Mar 08 |
peter |
TAB_SIZE = 2 |
| 5 |
26 Feb 03 |
jari |
240 |
|
| 2739 |
07 Jun 12 |
peter |
# The GENERATE_TODOLIST tag can be used to enable (YES) or |
| 2739 |
07 Jun 12 |
peter |
# disable (NO) the todo list. This list is created by putting \todo |
| 5 |
26 Feb 03 |
jari |
# commands in the documentation. |
| 5 |
26 Feb 03 |
jari |
244 |
|
| 763 |
22 Feb 07 |
peter |
GENERATE_TODOLIST = NO |
| 5 |
26 Feb 03 |
jari |
246 |
|
| 2739 |
07 Jun 12 |
peter |
# The GENERATE_TESTLIST tag can be used to enable (YES) or |
| 2739 |
07 Jun 12 |
peter |
# disable (NO) the test list. This list is created by putting \test |
| 5 |
26 Feb 03 |
jari |
# commands in the documentation. |
| 5 |
26 Feb 03 |
jari |
250 |
|
| 763 |
22 Feb 07 |
peter |
GENERATE_TESTLIST = NO |
| 5 |
26 Feb 03 |
jari |
252 |
|
| 2739 |
07 Jun 12 |
peter |
# The GENERATE_BUGLIST tag can be used to enable (YES) or |
| 2739 |
07 Jun 12 |
peter |
# disable (NO) the bug list. This list is created by putting \bug |
| 5 |
26 Feb 03 |
jari |
# commands in the documentation. |
| 5 |
26 Feb 03 |
jari |
256 |
|
| 763 |
22 Feb 07 |
peter |
GENERATE_BUGLIST = NO |
| 5 |
26 Feb 03 |
jari |
258 |
|
| 2739 |
07 Jun 12 |
peter |
# This tag can be used to specify a number of aliases that acts |
| 2739 |
07 Jun 12 |
peter |
# as commands in the documentation. An alias has the form "name=value". |
| 2739 |
07 Jun 12 |
peter |
# For example adding "sideeffect=\par Side Effects:\n" will allow you to |
| 2739 |
07 Jun 12 |
peter |
# put the command \sideeffect (or @sideeffect) in the documentation, which |
| 2739 |
07 Jun 12 |
peter |
# will result in a user defined paragraph with heading "Side Effects:". |
| 5 |
26 Feb 03 |
jari |
# You can put \n's in the value part of an alias to insert newlines. |
| 5 |
26 Feb 03 |
jari |
265 |
|
| 3775 |
26 Oct 18 |
peter |
ALIASES += "input_iterator=<a href=\"https://www.boost.org/doc/libs/1_68_0/doc/html/InputIterator.html\">Input Iterator</a>" |
| 3775 |
26 Oct 18 |
peter |
ALIASES += "output_iterator=<a href=\"https://www.boost.org/doc/libs/1_68_0/doc/html/OutputIterator.html\">Output Iterator</a>" |
| 3775 |
26 Oct 18 |
peter |
ALIASES += "forward_iterator=<a href=\"https://www.boost.org/doc/libs/1_68_0/doc/html/ForwardIterator.html\">Forward Iterator</a>" |
| 3775 |
26 Oct 18 |
peter |
ALIASES += "bidirectional_iterator=<a href=\"https://www.boost.org/doc/libs/1_68_0/doc/html/BidirectionalIterator.html\">Bidirectional Iterator</a>" |
| 3775 |
26 Oct 18 |
peter |
ALIASES += "random_access_iterator=<a href=\"https://www.boost.org/doc/libs/1_68_0/doc/html/RandomAccessIterator.html\">Random Access Iterator</a>" |
| 2259 |
24 May 10 |
peter |
ALIASES += "boost_url=http://www.boost.org/doc/libs/1_35_0/libs" |
| 3277 |
05 Jul 14 |
peter |
272 |
|
| 3277 |
05 Jul 14 |
peter |
# Links to boost's iterator concepts |
| 3277 |
05 Jul 14 |
peter |
ALIASES += "readable_iterator=<a href=\"http://www.boost.org/doc/libs/1_55_0/libs/iterator/doc/new-iter-concepts.html#readable-iterators-lib-readable-iterators\">Readable Iterator</a>" |
| 3277 |
05 Jul 14 |
peter |
275 |
|
| 3277 |
05 Jul 14 |
peter |
ALIASES += "writable_iterator=<a href=\"http://www.boost.org/doc/libs/1_55_0/libs/iterator/doc/new-iter-concepts.html#writable-iterators-lib-writable-iterators\">Writable Iterator</a>" |
| 3277 |
05 Jul 14 |
peter |
277 |
|
| 3277 |
05 Jul 14 |
peter |
ALIASES += "swappable_iterator=<a href=\"http://www.boost.org/doc/libs/1_55_0/libs/iterator/doc/new-iter-concepts.html#swappable-iterators-lib-swappable-iterators\">Swappable Iterator</a>" |
| 3277 |
05 Jul 14 |
peter |
279 |
|
| 3277 |
05 Jul 14 |
peter |
ALIASES += "lvalue_iterator=<a href=\"http://www.boost.org/doc/libs/1_55_0/libs/iterator/doc/new-iter-concepts.html#lvalue-iterators-lib-lvalue-iterators\">Lvalue Iterator</a>" |
| 3277 |
05 Jul 14 |
peter |
281 |
|
| 3277 |
05 Jul 14 |
peter |
ALIASES += "incrementable_iterator=<a href=\"http://www.boost.org/doc/libs/1_55_0/libs/iterator/doc/new-iter-concepts.html#incrementable-iterators-lib-incrementable-iterators\">Incrementable Iterator</a>" |
| 3277 |
05 Jul 14 |
peter |
ALIASES += "single_pass_iterator=<a href=\"http://www.boost.org/doc/libs/1_55_0/libs/iterator/doc/new-iter-concepts.html#single-pass-iterators-lib-single-pass-iterators\">Single Pass Iterator</a>" |
| 3277 |
05 Jul 14 |
peter |
ALIASES += "forward_traversal_iterator=<a href=\"http://www.boost.org/doc/libs/1_55_0/libs/iterator/doc/new-iter-concepts.html#forward-traversal-iterators-lib-forward-traversal-iterators\">Forward Traversal Iterator</a>" |
| 3277 |
05 Jul 14 |
peter |
ALIASES += "bidirectional_traversal_iterator=<a href=\"http://www.boost.org/doc/libs/1_55_0/libs/iterator/doc/new-iter-concepts.html#bidirectional-traversal-iterators-lib-bidirectional-traversal-iterators\">Bidirectional Traversal Iterator</a>" |
| 3277 |
05 Jul 14 |
peter |
ALIASES += "random_access_traversal_iterator=<a href=\"http://www.boost.org/doc/libs/1_55_0/libs/iterator/doc/new-iter-concepts.html#random-access-traversal-iterators-lib-random-access-traversal-iterators\">Random Access Traversal Iterator</a>" |
| 3277 |
05 Jul 14 |
peter |
287 |
|
| 2801 |
29 Jul 12 |
peter |
ALIASES += "gsl_url=http://www.gnu.org/software/gsl/manual/html_node" |
| 5 |
26 Feb 03 |
jari |
289 |
|
| 2739 |
07 Jun 12 |
peter |
# The ENABLED_SECTIONS tag can be used to enable conditional |
| 5 |
26 Feb 03 |
jari |
# documentation sections, marked by \if sectionname ... \endif. |
| 5 |
26 Feb 03 |
jari |
292 |
|
| 2739 |
07 Jun 12 |
peter |
ENABLED_SECTIONS = |
| 5 |
26 Feb 03 |
jari |
294 |
|
| 2739 |
07 Jun 12 |
peter |
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines |
| 2739 |
07 Jun 12 |
peter |
# the initial value of a variable or define consist of for it to appear in |
| 2739 |
07 Jun 12 |
peter |
# the documentation. If the initializer consists of more lines than specified |
| 2739 |
07 Jun 12 |
peter |
# here it will be hidden. Use a value of 0 to hide initializers completely. |
| 2739 |
07 Jun 12 |
peter |
# The appearance of the initializer of individual variables and defines in the |
| 2739 |
07 Jun 12 |
peter |
# documentation can be controlled using \showinitializer or \hideinitializer |
| 5 |
26 Feb 03 |
jari |
# command in the documentation regardless of this setting. |
| 5 |
26 Feb 03 |
jari |
302 |
|
| 5 |
26 Feb 03 |
jari |
MAX_INITIALIZER_LINES = 30 |
| 5 |
26 Feb 03 |
jari |
304 |
|
| 2739 |
07 Jun 12 |
peter |
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources |
| 2739 |
07 Jun 12 |
peter |
# only. Doxygen will then generate output that is more tailored for C. |
| 2739 |
07 Jun 12 |
peter |
# For instance some of the names that are used will be different. The list |
| 5 |
26 Feb 03 |
jari |
# of all members will be omitted, etc. |
| 5 |
26 Feb 03 |
jari |
309 |
|
| 5 |
26 Feb 03 |
jari |
OPTIMIZE_OUTPUT_FOR_C = NO |
| 5 |
26 Feb 03 |
jari |
311 |
|
| 5 |
26 Feb 03 |
jari |
312 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
# configuration options related to warning and progress messages |
| 5 |
26 Feb 03 |
jari |
314 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
315 |
|
| 2739 |
07 Jun 12 |
peter |
# The QUIET tag can be used to turn on/off the messages that are generated |
| 5 |
26 Feb 03 |
jari |
# by doxygen. Possible values are YES and NO. If left blank NO is used. |
| 5 |
26 Feb 03 |
jari |
318 |
|
| 1226 |
12 Mar 08 |
peter |
QUIET = NO |
| 5 |
26 Feb 03 |
jari |
320 |
|
| 2739 |
07 Jun 12 |
peter |
# The WARNINGS tag can be used to turn on/off the warning messages that are |
| 2739 |
07 Jun 12 |
peter |
# generated by doxygen. Possible values are YES and NO. If left blank |
| 5 |
26 Feb 03 |
jari |
# NO is used. |
| 5 |
26 Feb 03 |
jari |
324 |
|
| 5 |
26 Feb 03 |
jari |
WARNINGS = YES |
| 5 |
26 Feb 03 |
jari |
326 |
|
| 2739 |
07 Jun 12 |
peter |
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings |
| 2739 |
07 Jun 12 |
peter |
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will |
| 5 |
26 Feb 03 |
jari |
# automatically be disabled. |
| 5 |
26 Feb 03 |
jari |
330 |
|
| 5 |
26 Feb 03 |
jari |
WARN_IF_UNDOCUMENTED = YES |
| 5 |
26 Feb 03 |
jari |
332 |
|
| 2739 |
07 Jun 12 |
peter |
# The WARN_FORMAT tag determines the format of the warning messages that |
| 2739 |
07 Jun 12 |
peter |
# doxygen can produce. The string should contain the $file, $line, and $text |
| 2739 |
07 Jun 12 |
peter |
# tags, which will be replaced by the file and line number from which the |
| 5 |
26 Feb 03 |
jari |
# warning originated and the warning text. |
| 5 |
26 Feb 03 |
jari |
337 |
|
| 2739 |
07 Jun 12 |
peter |
WARN_FORMAT = |
| 5 |
26 Feb 03 |
jari |
339 |
|
| 2739 |
07 Jun 12 |
peter |
# The WARN_LOGFILE tag can be used to specify a file to which warning |
| 2739 |
07 Jun 12 |
peter |
# and error messages should be written. If left blank the output is written |
| 5 |
26 Feb 03 |
jari |
# to stderr. |
| 5 |
26 Feb 03 |
jari |
343 |
|
| 2739 |
07 Jun 12 |
peter |
WARN_LOGFILE = doc/doxygen.error |
| 5 |
26 Feb 03 |
jari |
345 |
|
| 5 |
26 Feb 03 |
jari |
346 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
# configuration options related to the input files |
| 5 |
26 Feb 03 |
jari |
348 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
349 |
|
| 2739 |
07 Jun 12 |
peter |
# The RECURSIVE tag can be used to turn specify whether or not subdirectories |
| 2739 |
07 Jun 12 |
peter |
# should be searched for input files as well. Possible values are YES and NO. |
| 5 |
26 Feb 03 |
jari |
# If left blank NO is used. |
| 5 |
26 Feb 03 |
jari |
353 |
|
| 296 |
29 Apr 05 |
peter |
RECURSIVE = YES |
| 5 |
26 Feb 03 |
jari |
355 |
|
| 2739 |
07 Jun 12 |
peter |
# The EXCLUDE tag can be used to specify files and/or directories that should |
| 2739 |
07 Jun 12 |
peter |
# excluded from the INPUT source files. This way you can easily exclude a |
| 5 |
26 Feb 03 |
jari |
# subdirectory from a directory tree whose root is specified with the INPUT tag. |
| 5 |
26 Feb 03 |
jari |
359 |
|
| 2739 |
07 Jun 12 |
peter |
EXCLUDE = |
| 5 |
26 Feb 03 |
jari |
361 |
|
| 2739 |
07 Jun 12 |
peter |
# If the value of the INPUT tag contains directories, you can use the |
| 2739 |
07 Jun 12 |
peter |
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
| 5 |
26 Feb 03 |
jari |
# certain files from those directories. |
| 5 |
26 Feb 03 |
jari |
365 |
|
| 1809 |
19 Feb 09 |
peter |
EXCLUDE_PATTERNS = .svn .deps .libs .svndigest |
| 5 |
26 Feb 03 |
jari |
367 |
|
| 2739 |
07 Jun 12 |
peter |
# The EXAMPLE_PATH tag can be used to specify one or more files or |
| 2739 |
07 Jun 12 |
peter |
# directories that contain example code fragments that are included (see |
| 5 |
26 Feb 03 |
jari |
# the \include command). |
| 5 |
26 Feb 03 |
jari |
371 |
|
| 2739 |
07 Jun 12 |
peter |
EXAMPLE_PATH = |
| 5 |
26 Feb 03 |
jari |
373 |
|
| 2739 |
07 Jun 12 |
peter |
# If the value of the EXAMPLE_PATH tag contains directories, you can use the |
| 2739 |
07 Jun 12 |
peter |
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
| 2739 |
07 Jun 12 |
peter |
# and *.h) to filter out the source-files in the directories. If left |
| 5 |
26 Feb 03 |
jari |
# blank all files are included. |
| 5 |
26 Feb 03 |
jari |
378 |
|
| 2739 |
07 Jun 12 |
peter |
EXAMPLE_PATTERNS = |
| 5 |
26 Feb 03 |
jari |
380 |
|
| 2739 |
07 Jun 12 |
peter |
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
| 2739 |
07 Jun 12 |
peter |
# searched for input files to be used with the \include or \dontinclude |
| 2739 |
07 Jun 12 |
peter |
# commands irrespective of the value of the RECURSIVE tag. |
| 5 |
26 Feb 03 |
jari |
# Possible values are YES and NO. If left blank NO is used. |
| 5 |
26 Feb 03 |
jari |
385 |
|
| 5 |
26 Feb 03 |
jari |
EXAMPLE_RECURSIVE = NO |
| 5 |
26 Feb 03 |
jari |
387 |
|
| 2739 |
07 Jun 12 |
peter |
# The IMAGE_PATH tag can be used to specify one or more files or |
| 2739 |
07 Jun 12 |
peter |
# directories that contain image that are included in the documentation (see |
| 5 |
26 Feb 03 |
jari |
# the \image command). |
| 5 |
26 Feb 03 |
jari |
391 |
|
| 2739 |
07 Jun 12 |
peter |
IMAGE_PATH = |
| 5 |
26 Feb 03 |
jari |
393 |
|
| 2739 |
07 Jun 12 |
peter |
# The INPUT_FILTER tag can be used to specify a program that doxygen should |
| 2739 |
07 Jun 12 |
peter |
# invoke to filter for each input file. Doxygen will invoke the filter program |
| 2739 |
07 Jun 12 |
peter |
# by executing (via popen()) the command <filter> <input-file>, where <filter> |
| 2739 |
07 Jun 12 |
peter |
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
| 2739 |
07 Jun 12 |
peter |
# input file. Doxygen will then use the output that the filter program writes |
| 5 |
26 Feb 03 |
jari |
# to standard output. |
| 5 |
26 Feb 03 |
jari |
400 |
|
| 2739 |
07 Jun 12 |
peter |
INPUT_FILTER = |
| 5 |
26 Feb 03 |
jari |
402 |
|
| 2739 |
07 Jun 12 |
peter |
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
| 2739 |
07 Jun 12 |
peter |
# INPUT_FILTER) will be used to filter the input files when producing source |
| 5 |
26 Feb 03 |
jari |
# files to browse. |
| 5 |
26 Feb 03 |
jari |
406 |
|
| 5 |
26 Feb 03 |
jari |
FILTER_SOURCE_FILES = NO |
| 5 |
26 Feb 03 |
jari |
408 |
|
| 5 |
26 Feb 03 |
jari |
409 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
# configuration options related to source browsing |
| 5 |
26 Feb 03 |
jari |
411 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
412 |
|
| 2739 |
07 Jun 12 |
peter |
# If the SOURCE_BROWSER tag is set to YES then a list of source files will |
| 5 |
26 Feb 03 |
jari |
# be generated. Documented entities will be cross-referenced with these sources. |
| 5 |
26 Feb 03 |
jari |
415 |
|
| 5 |
26 Feb 03 |
jari |
SOURCE_BROWSER = NO |
| 5 |
26 Feb 03 |
jari |
417 |
|
| 2739 |
07 Jun 12 |
peter |
# Setting the INLINE_SOURCES tag to YES will include the body |
| 5 |
26 Feb 03 |
jari |
# of functions and classes directly in the documentation. |
| 5 |
26 Feb 03 |
jari |
420 |
|
| 5 |
26 Feb 03 |
jari |
INLINE_SOURCES = NO |
| 5 |
26 Feb 03 |
jari |
422 |
|
| 2739 |
07 Jun 12 |
peter |
# If the REFERENCED_BY_RELATION tag is set to YES (the default) |
| 2739 |
07 Jun 12 |
peter |
# then for each documented function all documented |
| 5 |
26 Feb 03 |
jari |
# functions referencing it will be listed. |
| 5 |
26 Feb 03 |
jari |
426 |
|
| 1791 |
11 Feb 09 |
peter |
REFERENCED_BY_RELATION = NO |
| 5 |
26 Feb 03 |
jari |
428 |
|
| 2739 |
07 Jun 12 |
peter |
# If the REFERENCES_RELATION tag is set to YES (the default) |
| 2739 |
07 Jun 12 |
peter |
# then for each documented function all documented entities |
| 5 |
26 Feb 03 |
jari |
# called/used by that function will be listed. |
| 5 |
26 Feb 03 |
jari |
432 |
|
| 1791 |
11 Feb 09 |
peter |
REFERENCES_RELATION = NO |
| 5 |
26 Feb 03 |
jari |
434 |
|
| 5 |
26 Feb 03 |
jari |
435 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
# configuration options related to the alphabetical class index |
| 5 |
26 Feb 03 |
jari |
437 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
438 |
|
| 2739 |
07 Jun 12 |
peter |
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
| 2739 |
07 Jun 12 |
peter |
# of all compounds will be generated. Enable this if the project |
| 5 |
26 Feb 03 |
jari |
# contains a lot of classes, structs, unions or interfaces. |
| 5 |
26 Feb 03 |
jari |
442 |
|
| 1258 |
07 Apr 08 |
peter |
ALPHABETICAL_INDEX = YES |
| 5 |
26 Feb 03 |
jari |
444 |
|
| 2739 |
07 Jun 12 |
peter |
# In case all classes in a project start with a common prefix, all |
| 2739 |
07 Jun 12 |
peter |
# classes will be put under the same header in the alphabetical index. |
| 2739 |
07 Jun 12 |
peter |
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that |
| 5 |
26 Feb 03 |
jari |
# should be ignored while generating the index headers. |
| 5 |
26 Feb 03 |
jari |
449 |
|
| 2739 |
07 Jun 12 |
peter |
IGNORE_PREFIX = |
| 5 |
26 Feb 03 |
jari |
451 |
|
| 5 |
26 Feb 03 |
jari |
452 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
# configuration options related to the HTML output |
| 5 |
26 Feb 03 |
jari |
454 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
455 |
|
| 2739 |
07 Jun 12 |
peter |
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will |
| 5 |
26 Feb 03 |
jari |
# generate HTML output. |
| 5 |
26 Feb 03 |
jari |
458 |
|
| 3966 |
11 Aug 20 |
peter |
GENERATE_HTML = YES |
| 5 |
26 Feb 03 |
jari |
460 |
|
| 2739 |
07 Jun 12 |
peter |
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. |
| 2739 |
07 Jun 12 |
peter |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
| 5 |
26 Feb 03 |
jari |
# put in front of it. If left blank `html' will be used as the default path. |
| 5 |
26 Feb 03 |
jari |
464 |
|
| 3966 |
11 Aug 20 |
peter |
HTML_OUTPUT = html |
| 5 |
26 Feb 03 |
jari |
466 |
|
| 2739 |
07 Jun 12 |
peter |
# The HTML_HEADER tag can be used to specify a personal HTML header for |
| 2739 |
07 Jun 12 |
peter |
# each generated HTML page. If it is left blank doxygen will generate a |
| 5 |
26 Feb 03 |
jari |
# standard header. |
| 5 |
26 Feb 03 |
jari |
470 |
|
| 2739 |
07 Jun 12 |
peter |
HTML_HEADER = |
| 5 |
26 Feb 03 |
jari |
472 |
|
| 2739 |
07 Jun 12 |
peter |
# The HTML_FOOTER tag can be used to specify a personal HTML footer for |
| 2739 |
07 Jun 12 |
peter |
# each generated HTML page. If it is left blank doxygen will generate a |
| 5 |
26 Feb 03 |
jari |
# standard footer. |
| 5 |
26 Feb 03 |
jari |
476 |
|
| 3966 |
11 Aug 20 |
peter |
HTML_FOOTER = @abs_top_srcdir@/doc/footer.html |
| 5 |
26 Feb 03 |
jari |
478 |
|
| 2739 |
07 Jun 12 |
peter |
# The HTML_STYLESHEET tag can be used to specify a user defined cascading |
| 2739 |
07 Jun 12 |
peter |
# style sheet that is used by each HTML page. It can be used to |
| 2739 |
07 Jun 12 |
peter |
# fine-tune the look of the HTML output. If the tag is left blank doxygen |
| 5 |
26 Feb 03 |
jari |
# will generate a default style sheet |
| 5 |
26 Feb 03 |
jari |
483 |
|
| 2739 |
07 Jun 12 |
peter |
HTML_STYLESHEET = |
| 5 |
26 Feb 03 |
jari |
485 |
|
| 2739 |
07 Jun 12 |
peter |
# If the GENERATE_HTMLHELP tag is set to YES, additional index files |
| 2739 |
07 Jun 12 |
peter |
# will be generated that can be used as input for tools like the |
| 2739 |
07 Jun 12 |
peter |
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) |
| 5 |
26 Feb 03 |
jari |
# of the generated HTML documentation. |
| 5 |
26 Feb 03 |
jari |
490 |
|
| 5 |
26 Feb 03 |
jari |
GENERATE_HTMLHELP = NO |
| 5 |
26 Feb 03 |
jari |
492 |
|
| 2739 |
07 Jun 12 |
peter |
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag |
| 2739 |
07 Jun 12 |
peter |
# controls if a separate .chi index file is generated (YES) or that |
| 5 |
26 Feb 03 |
jari |
# it should be included in the master .chm file (NO). |
| 5 |
26 Feb 03 |
jari |
496 |
|
| 5 |
26 Feb 03 |
jari |
GENERATE_CHI = NO |
| 5 |
26 Feb 03 |
jari |
498 |
|
| 2739 |
07 Jun 12 |
peter |
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag |
| 2739 |
07 Jun 12 |
peter |
# controls whether a binary table of contents is generated (YES) or a |
| 5 |
26 Feb 03 |
jari |
# normal table of contents (NO) in the .chm file. |
| 5 |
26 Feb 03 |
jari |
502 |
|
| 5 |
26 Feb 03 |
jari |
BINARY_TOC = NO |
| 5 |
26 Feb 03 |
jari |
504 |
|
| 2739 |
07 Jun 12 |
peter |
# The TOC_EXPAND flag can be set to YES to add extra items for group members |
| 5 |
26 Feb 03 |
jari |
# to the contents of the Html help documentation and to the tree view. |
| 5 |
26 Feb 03 |
jari |
507 |
|
| 5 |
26 Feb 03 |
jari |
TOC_EXPAND = NO |
| 5 |
26 Feb 03 |
jari |
509 |
|
| 2739 |
07 Jun 12 |
peter |
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
| 2739 |
07 Jun 12 |
peter |
# top of each HTML page. The value NO (the default) enables the index and |
| 5 |
26 Feb 03 |
jari |
# the value YES disables it. |
| 5 |
26 Feb 03 |
jari |
513 |
|
| 5 |
26 Feb 03 |
jari |
DISABLE_INDEX = NO |
| 5 |
26 Feb 03 |
jari |
515 |
|
| 2739 |
07 Jun 12 |
peter |
# This tag can be used to set the number of enum values (range [1..20]) |
| 5 |
26 Feb 03 |
jari |
# that doxygen will group on one line in the generated HTML documentation. |
| 5 |
26 Feb 03 |
jari |
518 |
|
| 5 |
26 Feb 03 |
jari |
ENUM_VALUES_PER_LINE = 4 |
| 5 |
26 Feb 03 |
jari |
520 |
|
| 5 |
26 Feb 03 |
jari |
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be |
| 2739 |
07 Jun 12 |
peter |
# generated containing a tree-like index structure (just like the one that |
| 2739 |
07 Jun 12 |
peter |
# is generated for HTML Help). For this to work a browser that supports |
| 2739 |
07 Jun 12 |
peter |
# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+, |
| 2739 |
07 Jun 12 |
peter |
# or Internet explorer 4.0+). Note that for large projects the tree generation |
| 2739 |
07 Jun 12 |
peter |
# can take a very long time. In such cases it is better to disable this feature. |
| 5 |
26 Feb 03 |
jari |
# Windows users are probably better off using the HTML help feature. |
| 5 |
26 Feb 03 |
jari |
528 |
|
| 5 |
26 Feb 03 |
jari |
GENERATE_TREEVIEW = NO |
| 5 |
26 Feb 03 |
jari |
530 |
|
| 2739 |
07 Jun 12 |
peter |
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
| 2739 |
07 Jun 12 |
peter |
# used to set the initial width (in pixels) of the frame in which the tree |
| 5 |
26 Feb 03 |
jari |
# is shown. |
| 5 |
26 Feb 03 |
jari |
534 |
|
| 5 |
26 Feb 03 |
jari |
TREEVIEW_WIDTH = 250 |
| 5 |
26 Feb 03 |
jari |
536 |
|
| 5 |
26 Feb 03 |
jari |
537 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
# configuration options related to the LaTeX output |
| 5 |
26 Feb 03 |
jari |
539 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
540 |
|
| 2739 |
07 Jun 12 |
peter |
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will |
| 5 |
26 Feb 03 |
jari |
# generate Latex output. |
| 5 |
26 Feb 03 |
jari |
543 |
|
| 1254 |
04 Apr 08 |
peter |
GENERATE_LATEX = NO |
| 5 |
26 Feb 03 |
jari |
545 |
|
| 2739 |
07 Jun 12 |
peter |
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. |
| 2739 |
07 Jun 12 |
peter |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
| 5 |
26 Feb 03 |
jari |
# put in front of it. If left blank `latex' will be used as the default path. |
| 5 |
26 Feb 03 |
jari |
549 |
|
| 2739 |
07 Jun 12 |
peter |
LATEX_OUTPUT = |
| 5 |
26 Feb 03 |
jari |
551 |
|
| 2739 |
07 Jun 12 |
peter |
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact |
| 2739 |
07 Jun 12 |
peter |
# LaTeX documents. This may be useful for small projects and may help to |
| 5 |
26 Feb 03 |
jari |
# save some trees in general. |
| 5 |
26 Feb 03 |
jari |
555 |
|
| 5 |
26 Feb 03 |
jari |
COMPACT_LATEX = NO |
| 5 |
26 Feb 03 |
jari |
557 |
|
| 2739 |
07 Jun 12 |
peter |
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX |
| 5 |
26 Feb 03 |
jari |
# packages that should be included in the LaTeX output. |
| 5 |
26 Feb 03 |
jari |
560 |
|
| 2739 |
07 Jun 12 |
peter |
EXTRA_PACKAGES = |
| 5 |
26 Feb 03 |
jari |
562 |
|
| 2739 |
07 Jun 12 |
peter |
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for |
| 2739 |
07 Jun 12 |
peter |
# the generated latex document. The header should contain everything until |
| 2739 |
07 Jun 12 |
peter |
# the first chapter. If it is left blank doxygen will generate a |
| 5 |
26 Feb 03 |
jari |
# standard header. Notice: only use this tag if you know what you are doing! |
| 5 |
26 Feb 03 |
jari |
567 |
|
| 2739 |
07 Jun 12 |
peter |
LATEX_HEADER = |
| 5 |
26 Feb 03 |
jari |
569 |
|
| 2739 |
07 Jun 12 |
peter |
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
| 2739 |
07 Jun 12 |
peter |
# is prepared for conversion to pdf (using ps2pdf). The pdf file will |
| 2739 |
07 Jun 12 |
peter |
# contain links (just like the HTML output) instead of page references |
| 5 |
26 Feb 03 |
jari |
# This makes the output suitable for online browsing using a pdf viewer. |
| 5 |
26 Feb 03 |
jari |
574 |
|
| 800 |
13 Mar 07 |
peter |
PDF_HYPERLINKS = YES |
| 5 |
26 Feb 03 |
jari |
576 |
|
| 2739 |
07 Jun 12 |
peter |
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of |
| 2739 |
07 Jun 12 |
peter |
# plain latex in the generated Makefile. Set this option to YES to get a |
| 5 |
26 Feb 03 |
jari |
# higher quality PDF documentation. |
| 5 |
26 Feb 03 |
jari |
580 |
|
| 800 |
13 Mar 07 |
peter |
USE_PDFLATEX = YES |
| 5 |
26 Feb 03 |
jari |
582 |
|
| 2739 |
07 Jun 12 |
peter |
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. |
| 2739 |
07 Jun 12 |
peter |
# command to the generated LaTeX files. This will instruct LaTeX to keep |
| 2739 |
07 Jun 12 |
peter |
# running if errors occur, instead of asking the user for help. |
| 5 |
26 Feb 03 |
jari |
# This option is also used when generating formulas in HTML. |
| 5 |
26 Feb 03 |
jari |
587 |
|
| 5 |
26 Feb 03 |
jari |
LATEX_BATCHMODE = NO |
| 5 |
26 Feb 03 |
jari |
589 |
|
| 5 |
26 Feb 03 |
jari |
590 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
# configuration options related to the RTF output |
| 5 |
26 Feb 03 |
jari |
592 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
593 |
|
| 2739 |
07 Jun 12 |
peter |
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output |
| 2739 |
07 Jun 12 |
peter |
# The RTF output is optimised for Word 97 and may not look very pretty with |
| 5 |
26 Feb 03 |
jari |
# other RTF readers or editors. |
| 5 |
26 Feb 03 |
jari |
597 |
|
| 5 |
26 Feb 03 |
jari |
GENERATE_RTF = NO |
| 5 |
26 Feb 03 |
jari |
599 |
|
| 2739 |
07 Jun 12 |
peter |
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. |
| 2739 |
07 Jun 12 |
peter |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
| 5 |
26 Feb 03 |
jari |
# put in front of it. If left blank `rtf' will be used as the default path. |
| 5 |
26 Feb 03 |
jari |
603 |
|
| 2739 |
07 Jun 12 |
peter |
RTF_OUTPUT = |
| 5 |
26 Feb 03 |
jari |
605 |
|
| 2739 |
07 Jun 12 |
peter |
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact |
| 2739 |
07 Jun 12 |
peter |
# RTF documents. This may be useful for small projects and may help to |
| 5 |
26 Feb 03 |
jari |
# save some trees in general. |
| 5 |
26 Feb 03 |
jari |
609 |
|
| 5 |
26 Feb 03 |
jari |
COMPACT_RTF = NO |
| 5 |
26 Feb 03 |
jari |
611 |
|
| 2739 |
07 Jun 12 |
peter |
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated |
| 2739 |
07 Jun 12 |
peter |
# will contain hyperlink fields. The RTF file will |
| 2739 |
07 Jun 12 |
peter |
# contain links (just like the HTML output) instead of page references. |
| 2739 |
07 Jun 12 |
peter |
# This makes the output suitable for online browsing using WORD or other |
| 2739 |
07 Jun 12 |
peter |
# programs which support those fields. |
| 5 |
26 Feb 03 |
jari |
# Note: wordpad (write) and others do not support links. |
| 5 |
26 Feb 03 |
jari |
618 |
|
| 5 |
26 Feb 03 |
jari |
RTF_HYPERLINKS = NO |
| 5 |
26 Feb 03 |
jari |
620 |
|
| 2739 |
07 Jun 12 |
peter |
# Load stylesheet definitions from file. Syntax is similar to doxygen's |
| 2739 |
07 Jun 12 |
peter |
# config file, i.e. a series of assigments. You only have to provide |
| 5 |
26 Feb 03 |
jari |
# replacements, missing definitions are set to their default value. |
| 5 |
26 Feb 03 |
jari |
624 |
|
| 2739 |
07 Jun 12 |
peter |
RTF_STYLESHEET_FILE = |
| 5 |
26 Feb 03 |
jari |
626 |
|
| 2739 |
07 Jun 12 |
peter |
# Set optional variables used in the generation of an rtf document. |
| 5 |
26 Feb 03 |
jari |
# Syntax is similar to doxygen's config file. |
| 5 |
26 Feb 03 |
jari |
629 |
|
| 2739 |
07 Jun 12 |
peter |
RTF_EXTENSIONS_FILE = |
| 5 |
26 Feb 03 |
jari |
631 |
|
| 5 |
26 Feb 03 |
jari |
632 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
# configuration options related to the man page output |
| 5 |
26 Feb 03 |
jari |
634 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
635 |
|
| 2739 |
07 Jun 12 |
peter |
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will |
| 5 |
26 Feb 03 |
jari |
# generate man pages |
| 5 |
26 Feb 03 |
jari |
638 |
|
| 5 |
26 Feb 03 |
jari |
GENERATE_MAN = NO |
| 5 |
26 Feb 03 |
jari |
640 |
|
| 2739 |
07 Jun 12 |
peter |
# The MAN_OUTPUT tag is used to specify where the man pages will be put. |
| 2739 |
07 Jun 12 |
peter |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
| 5 |
26 Feb 03 |
jari |
# put in front of it. If left blank `man' will be used as the default path. |
| 5 |
26 Feb 03 |
jari |
644 |
|
| 2739 |
07 Jun 12 |
peter |
MAN_OUTPUT = |
| 5 |
26 Feb 03 |
jari |
646 |
|
| 2739 |
07 Jun 12 |
peter |
# The MAN_EXTENSION tag determines the extension that is added to |
| 5 |
26 Feb 03 |
jari |
# the generated man pages (default is the subroutine's section .3) |
| 5 |
26 Feb 03 |
jari |
649 |
|
| 2739 |
07 Jun 12 |
peter |
MAN_EXTENSION = |
| 5 |
26 Feb 03 |
jari |
651 |
|
| 2739 |
07 Jun 12 |
peter |
# If the MAN_LINKS tag is set to YES and Doxygen generates man output, |
| 2739 |
07 Jun 12 |
peter |
# then it will generate one additional man file for each entity |
| 2739 |
07 Jun 12 |
peter |
# documented in the real man page(s). These additional files |
| 2739 |
07 Jun 12 |
peter |
# only source the real man page, but without them the man command |
| 5 |
26 Feb 03 |
jari |
# would be unable to find the correct page. The default is NO. |
| 5 |
26 Feb 03 |
jari |
657 |
|
| 5 |
26 Feb 03 |
jari |
MAN_LINKS = NO |
| 5 |
26 Feb 03 |
jari |
659 |
|
| 5 |
26 Feb 03 |
jari |
660 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
# configuration options related to the XML output |
| 5 |
26 Feb 03 |
jari |
662 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
663 |
|
| 2739 |
07 Jun 12 |
peter |
# If the GENERATE_XML tag is set to YES Doxygen will |
| 2739 |
07 Jun 12 |
peter |
# generate an XML file that captures the structure of |
| 2739 |
07 Jun 12 |
peter |
# the code including all documentation. Note that this |
| 2739 |
07 Jun 12 |
peter |
# feature is still experimental and incomplete at the |
| 5 |
26 Feb 03 |
jari |
# moment. |
| 5 |
26 Feb 03 |
jari |
669 |
|
| 5 |
26 Feb 03 |
jari |
GENERATE_XML = NO |
| 5 |
26 Feb 03 |
jari |
671 |
|
| 5 |
26 Feb 03 |
jari |
672 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
# configuration options for the AutoGen Definitions output |
| 5 |
26 Feb 03 |
jari |
674 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
675 |
|
| 2739 |
07 Jun 12 |
peter |
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will |
| 2739 |
07 Jun 12 |
peter |
# generate an AutoGen Definitions (see autogen.sf.net) file |
| 2739 |
07 Jun 12 |
peter |
# that captures the structure of the code including all |
| 2739 |
07 Jun 12 |
peter |
# documentation. Note that this feature is still experimental |
| 5 |
26 Feb 03 |
jari |
# and incomplete at the moment. |
| 5 |
26 Feb 03 |
jari |
681 |
|
| 5 |
26 Feb 03 |
jari |
GENERATE_AUTOGEN_DEF = NO |
| 5 |
26 Feb 03 |
jari |
683 |
|
| 5 |
26 Feb 03 |
jari |
684 |
#--------------------------------------------------------------------------- |
| 2739 |
07 Jun 12 |
peter |
# Configuration options related to the preprocessor |
| 5 |
26 Feb 03 |
jari |
686 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
687 |
|
| 2739 |
07 Jun 12 |
peter |
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will |
| 2739 |
07 Jun 12 |
peter |
# evaluate all C-preprocessor directives found in the sources and include |
| 5 |
26 Feb 03 |
jari |
# files. |
| 5 |
26 Feb 03 |
jari |
691 |
|
| 5 |
26 Feb 03 |
jari |
ENABLE_PREPROCESSING = YES |
| 5 |
26 Feb 03 |
jari |
693 |
|
| 2739 |
07 Jun 12 |
peter |
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro |
| 2739 |
07 Jun 12 |
peter |
# names in the source code. If set to NO (the default) only conditional |
| 2739 |
07 Jun 12 |
peter |
# compilation will be performed. Macro expansion can be done in a controlled |
| 5 |
26 Feb 03 |
jari |
# way by setting EXPAND_ONLY_PREDEF to YES. |
| 5 |
26 Feb 03 |
jari |
698 |
|
| 2353 |
27 Nov 10 |
peter |
MACRO_EXPANSION = YES |
| 5 |
26 Feb 03 |
jari |
700 |
|
| 2739 |
07 Jun 12 |
peter |
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
| 2739 |
07 Jun 12 |
peter |
# then the macro expansion is limited to the macros specified with the |
| 5 |
26 Feb 03 |
jari |
# PREDEFINED and EXPAND_AS_PREDEFINED tags. |
| 5 |
26 Feb 03 |
jari |
704 |
|
| 2353 |
27 Nov 10 |
peter |
EXPAND_ONLY_PREDEF = YES |
| 5 |
26 Feb 03 |
jari |
706 |
|
| 2739 |
07 Jun 12 |
peter |
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
| 5 |
26 Feb 03 |
jari |
# in the INCLUDE_PATH (see below) will be search if a #include is found. |
| 5 |
26 Feb 03 |
jari |
709 |
|
| 5 |
26 Feb 03 |
jari |
SEARCH_INCLUDES = YES |
| 5 |
26 Feb 03 |
jari |
711 |
|
| 2739 |
07 Jun 12 |
peter |
# The INCLUDE_PATH tag can be used to specify one or more directories that |
| 2739 |
07 Jun 12 |
peter |
# contain include files that are not input files but should be processed by |
| 5 |
26 Feb 03 |
jari |
# the preprocessor. |
| 5 |
26 Feb 03 |
jari |
715 |
|
| 2739 |
07 Jun 12 |
peter |
INCLUDE_PATH = |
| 5 |
26 Feb 03 |
jari |
717 |
|
| 2739 |
07 Jun 12 |
peter |
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
| 2739 |
07 Jun 12 |
peter |
# patterns (like *.h and *.hpp) to filter out the header-files in the |
| 2739 |
07 Jun 12 |
peter |
# directories. If left blank, the patterns specified with FILE_PATTERNS will |
| 5 |
26 Feb 03 |
jari |
# be used. |
| 5 |
26 Feb 03 |
jari |
722 |
|
| 2739 |
07 Jun 12 |
peter |
INCLUDE_FILE_PATTERNS = |
| 5 |
26 Feb 03 |
jari |
724 |
|
| 2739 |
07 Jun 12 |
peter |
# The PREDEFINED tag can be used to specify one or more macro names that |
| 2739 |
07 Jun 12 |
peter |
# are defined before the preprocessor is started (similar to the -D option of |
| 2739 |
07 Jun 12 |
peter |
# gcc). The argument of the tag is a list of macros of the form: name |
| 2739 |
07 Jun 12 |
peter |
# or name=definition (no spaces). If the definition and the = are |
| 5 |
26 Feb 03 |
jari |
# omitted =1 is assumed. |
| 5 |
26 Feb 03 |
jari |
730 |
|
| 2353 |
27 Nov 10 |
peter |
PREDEFINED = YAT_DEPRECATE= |
| 5 |
26 Feb 03 |
jari |
732 |
|
| 2739 |
07 Jun 12 |
peter |
# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then |
| 2739 |
07 Jun 12 |
peter |
# this tag can be used to specify a list of macro names that should be expanded. |
| 2739 |
07 Jun 12 |
peter |
# The macro definition that is found in the sources will be used. |
| 5 |
26 Feb 03 |
jari |
# Use the PREDEFINED tag if you want to use a different macro definition. |
| 5 |
26 Feb 03 |
jari |
737 |
|
| 2739 |
07 Jun 12 |
peter |
EXPAND_AS_DEFINED = |
| 5 |
26 Feb 03 |
jari |
739 |
|
| 2739 |
07 Jun 12 |
peter |
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then |
| 2739 |
07 Jun 12 |
peter |
# doxygen's preprocessor will remove all function-like macros that are alone |
| 2739 |
07 Jun 12 |
peter |
# on a line and do not end with a semicolon. Such function macros are typically |
| 5 |
26 Feb 03 |
jari |
# used for boiler-plate code, and will confuse the parser if not removed. |
| 5 |
26 Feb 03 |
jari |
744 |
|
| 5 |
26 Feb 03 |
jari |
SKIP_FUNCTION_MACROS = YES |
| 5 |
26 Feb 03 |
jari |
746 |
|
| 5 |
26 Feb 03 |
jari |
747 |
#--------------------------------------------------------------------------- |
| 2739 |
07 Jun 12 |
peter |
# Configuration::addtions related to external references |
| 5 |
26 Feb 03 |
jari |
749 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
750 |
|
| 5 |
26 Feb 03 |
jari |
# The TAGFILES tag can be used to specify one or more tagfiles. |
| 5 |
26 Feb 03 |
jari |
752 |
|
| 2739 |
07 Jun 12 |
peter |
TAGFILES = |
| 5 |
26 Feb 03 |
jari |
754 |
|
| 2739 |
07 Jun 12 |
peter |
# When a file name is specified after GENERATE_TAGFILE, doxygen will create |
| 5 |
26 Feb 03 |
jari |
# a tag file that is based on the input files it reads. |
| 5 |
26 Feb 03 |
jari |
757 |
|
| 2739 |
07 Jun 12 |
peter |
GENERATE_TAGFILE = |
| 5 |
26 Feb 03 |
jari |
759 |
|
| 2739 |
07 Jun 12 |
peter |
# If the ALLEXTERNALS tag is set to YES all external classes will be listed |
| 2739 |
07 Jun 12 |
peter |
# in the class index. If set to NO only the inherited external classes |
| 5 |
26 Feb 03 |
jari |
# will be listed. |
| 5 |
26 Feb 03 |
jari |
763 |
|
| 5 |
26 Feb 03 |
jari |
ALLEXTERNALS = NO |
| 5 |
26 Feb 03 |
jari |
765 |
|
| 5 |
26 Feb 03 |
jari |
766 |
#--------------------------------------------------------------------------- |
| 2739 |
07 Jun 12 |
peter |
# Configuration options related to the dot tool |
| 5 |
26 Feb 03 |
jari |
768 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
769 |
|
| 2739 |
07 Jun 12 |
peter |
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
| 2739 |
07 Jun 12 |
peter |
# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or |
| 2739 |
07 Jun 12 |
peter |
# super classes. Setting the tag to NO turns the diagrams off. Note that this |
| 2739 |
07 Jun 12 |
peter |
# option is superceded by the HAVE_DOT option below. This is only a fallback. It is |
| 5 |
26 Feb 03 |
jari |
# recommended to install and use dot, since it yield more powerful graphs. |
| 5 |
26 Feb 03 |
jari |
775 |
|
| 5 |
26 Feb 03 |
jari |
CLASS_DIAGRAMS = YES |
| 5 |
26 Feb 03 |
jari |
777 |
|
| 2739 |
07 Jun 12 |
peter |
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
| 2739 |
07 Jun 12 |
peter |
# available from the path. This tool is part of Graphviz, a graph visualization |
| 2739 |
07 Jun 12 |
peter |
# toolkit from AT&T and Lucent Bell Labs. The other options in this section |
| 5 |
26 Feb 03 |
jari |
# have no effect if this option is set to NO (the default) |
| 5 |
26 Feb 03 |
jari |
782 |
|
| 5 |
26 Feb 03 |
jari |
HAVE_DOT = NO |
| 5 |
26 Feb 03 |
jari |
784 |
|
| 2739 |
07 Jun 12 |
peter |
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
| 2739 |
07 Jun 12 |
peter |
# will generate a graph for each documented class showing the direct and |
| 2739 |
07 Jun 12 |
peter |
# indirect inheritance relations. Setting this tag to YES will force the |
| 5 |
26 Feb 03 |
jari |
# the CLASS_DIAGRAMS tag to NO. |
| 5 |
26 Feb 03 |
jari |
789 |
|
| 5 |
26 Feb 03 |
jari |
CLASS_GRAPH = YES |
| 5 |
26 Feb 03 |
jari |
791 |
|
| 2739 |
07 Jun 12 |
peter |
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen |
| 2739 |
07 Jun 12 |
peter |
# will generate a graph for each documented class showing the direct and |
| 2739 |
07 Jun 12 |
peter |
# indirect implementation dependencies (inheritance, containment, and |
| 5 |
26 Feb 03 |
jari |
# class references variables) of the class with other documented classes. |
| 5 |
26 Feb 03 |
jari |
796 |
|
| 5 |
26 Feb 03 |
jari |
COLLABORATION_GRAPH = YES |
| 5 |
26 Feb 03 |
jari |
798 |
|
| 2739 |
07 Jun 12 |
peter |
# If set to YES, the inheritance and collaboration graphs will show the |
| 5 |
26 Feb 03 |
jari |
# relations between templates and their instances. |
| 5 |
26 Feb 03 |
jari |
801 |
|
| 5 |
26 Feb 03 |
jari |
TEMPLATE_RELATIONS = YES |
| 5 |
26 Feb 03 |
jari |
803 |
|
| 2739 |
07 Jun 12 |
peter |
# If set to YES, the inheritance and collaboration graphs will hide |
| 2739 |
07 Jun 12 |
peter |
# inheritance and usage relations if the target is undocumented |
| 5 |
26 Feb 03 |
jari |
# or is not a class. |
| 5 |
26 Feb 03 |
jari |
807 |
|
| 5 |
26 Feb 03 |
jari |
HIDE_UNDOC_RELATIONS = YES |
| 5 |
26 Feb 03 |
jari |
809 |
|
| 2739 |
07 Jun 12 |
peter |
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT |
| 2739 |
07 Jun 12 |
peter |
# tags are set to YES then doxygen will generate a graph for each documented |
| 2739 |
07 Jun 12 |
peter |
# file showing the direct and indirect include dependencies of the file with |
| 5 |
26 Feb 03 |
jari |
# other documented files. |
| 5 |
26 Feb 03 |
jari |
814 |
|
| 5 |
26 Feb 03 |
jari |
INCLUDE_GRAPH = YES |
| 5 |
26 Feb 03 |
jari |
816 |
|
| 2739 |
07 Jun 12 |
peter |
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and |
| 2739 |
07 Jun 12 |
peter |
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each |
| 2739 |
07 Jun 12 |
peter |
# documented header file showing the documented files that directly or |
| 5 |
26 Feb 03 |
jari |
# indirectly include this file. |
| 5 |
26 Feb 03 |
jari |
821 |
|
| 5 |
26 Feb 03 |
jari |
INCLUDED_BY_GRAPH = YES |
| 5 |
26 Feb 03 |
jari |
823 |
|
| 2739 |
07 Jun 12 |
peter |
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
| 5 |
26 Feb 03 |
jari |
# will graphical hierarchy of all classes instead of a textual one. |
| 5 |
26 Feb 03 |
jari |
826 |
|
| 5 |
26 Feb 03 |
jari |
GRAPHICAL_HIERARCHY = YES |
| 5 |
26 Feb 03 |
jari |
828 |
|
| 2739 |
07 Jun 12 |
peter |
# The tag DOT_PATH can be used to specify the path where the dot tool can be |
| 5 |
26 Feb 03 |
jari |
# found. If left blank, it is assumed the dot tool can be found on the path. |
| 5 |
26 Feb 03 |
jari |
831 |
|
| 2739 |
07 Jun 12 |
peter |
DOT_PATH = |
| 5 |
26 Feb 03 |
jari |
833 |
|
| 2739 |
07 Jun 12 |
peter |
# The DOTFILE_DIRS tag can be used to specify one or more directories that |
| 2739 |
07 Jun 12 |
peter |
# contain dot files that are included in the documentation (see the |
| 5 |
26 Feb 03 |
jari |
# \dotfile command). |
| 5 |
26 Feb 03 |
jari |
837 |
|
| 2739 |
07 Jun 12 |
peter |
DOTFILE_DIRS = |
| 5 |
26 Feb 03 |
jari |
839 |
|
| 2739 |
07 Jun 12 |
peter |
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
| 2739 |
07 Jun 12 |
peter |
# generate a legend page explaining the meaning of the various boxes and |
| 5 |
26 Feb 03 |
jari |
# arrows in the dot generated graphs. |
| 5 |
26 Feb 03 |
jari |
843 |
|
| 5 |
26 Feb 03 |
jari |
GENERATE_LEGEND = YES |
| 5 |
26 Feb 03 |
jari |
845 |
|
| 2739 |
07 Jun 12 |
peter |
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will |
| 2739 |
07 Jun 12 |
peter |
# remove the intermedate dot files that are used to generate |
| 5 |
26 Feb 03 |
jari |
# the various graphs. |
| 5 |
26 Feb 03 |
jari |
849 |
|
| 5 |
26 Feb 03 |
jari |
DOT_CLEANUP = YES |
| 5 |
26 Feb 03 |
jari |
851 |
|
| 5 |
26 Feb 03 |
jari |
852 |
#--------------------------------------------------------------------------- |
| 2739 |
07 Jun 12 |
peter |
# Configuration::addtions related to the search engine |
| 5 |
26 Feb 03 |
jari |
854 |
#--------------------------------------------------------------------------- |
| 5 |
26 Feb 03 |
jari |
855 |
|
| 2739 |
07 Jun 12 |
peter |
# The SEARCHENGINE tag specifies whether or not a search engine should be |
| 5 |
26 Feb 03 |
jari |
# used. If set to NO the values of all tags below this one will be ignored. |
| 5 |
26 Feb 03 |
jari |
858 |
|
| 5 |
26 Feb 03 |
jari |
SEARCHENGINE = NO |
| 5 |
26 Feb 03 |
jari |
860 |
|
| 2739 |
07 Jun 12 |
peter |
# The CGI_NAME tag should be the name of the CGI script that |
| 2739 |
07 Jun 12 |
peter |
# starts the search engine (doxysearch) with the correct parameters. |
| 5 |
26 Feb 03 |
jari |
# A script with this name will be generated by doxygen. |
| 5 |
26 Feb 03 |
jari |
864 |
|
| 2739 |
07 Jun 12 |
peter |
#CGI_NAME = |
| 5 |
26 Feb 03 |
jari |
866 |
|
| 2739 |
07 Jun 12 |
peter |
# The CGI_URL tag should be the absolute URL to the directory where the |
| 2739 |
07 Jun 12 |
peter |
# cgi binaries are located. See the documentation of your http daemon for |
| 5 |
26 Feb 03 |
jari |
# details. |
| 5 |
26 Feb 03 |
jari |
870 |
|
| 2739 |
07 Jun 12 |
peter |
#CGI_URL = |
| 5 |
26 Feb 03 |
jari |
872 |
|
| 2739 |
07 Jun 12 |
peter |
# The DOC_URL tag should be the absolute URL to the directory where the |
| 2739 |
07 Jun 12 |
peter |
# documentation is located. If left blank the absolute path to the |
| 5 |
26 Feb 03 |
jari |
# documentation, with file:// prepended to it, will be used. |
| 5 |
26 Feb 03 |
jari |
876 |
|
| 2739 |
07 Jun 12 |
peter |
#DOC_URL = |
| 5 |
26 Feb 03 |
jari |
878 |
|
| 2739 |
07 Jun 12 |
peter |
# The DOC_ABSPATH tag should be the absolute path to the directory where the |
| 2739 |
07 Jun 12 |
peter |
# documentation is located. If left blank the directory on the local machine |
| 5 |
26 Feb 03 |
jari |
# will be used. |
| 5 |
26 Feb 03 |
jari |
882 |
|
| 2739 |
07 Jun 12 |
peter |
#DOC_ABSPATH = |
| 5 |
26 Feb 03 |
jari |
884 |
|
| 2739 |
07 Jun 12 |
peter |
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary |
| 5 |
26 Feb 03 |
jari |
# is installed. |
| 5 |
26 Feb 03 |
jari |
887 |
|
| 2739 |
07 Jun 12 |
peter |
#BIN_ABSPATH = |
| 5 |
26 Feb 03 |
jari |
889 |
|
| 2739 |
07 Jun 12 |
peter |
# The EXT_DOC_PATHS tag can be used to specify one or more paths to |
| 2739 |
07 Jun 12 |
peter |
# documentation generated for other projects. This allows doxysearch to search |
| 5 |
26 Feb 03 |
jari |
# the documentation for these projects as well. |
| 5 |
26 Feb 03 |
jari |
893 |
|
| 2739 |
07 Jun 12 |
peter |
#EXT_DOC_PATHS = |