Mercurial > mplayer.hg
annotate DOCS/tech/Doxyfile @ 33263:5f527a9a9521
Add an exit function.
This function will allow performing clean-up operations.
(MPlayer calls guiDone() before exiting, but only if the GUI has been
initialized, i.e. if guiInit() has been called successfully. Any
exit_player()/exit_player_with_rc() after GUI's cfg_read() until
guiInit(), or any exit_player() during guiInit() itself will end the GUI
without calling guiDone(). This exit function will at least handle
abortions during guiInit() itself. It will be called twice in case of an
guiExit() after GUI initialization - first directly, next by guiDone()
via MPlayer's exit_player_with_rc().)
author | ib |
---|---|
date | Tue, 03 May 2011 12:19:22 +0000 |
parents | 0f1b5b68af32 |
children | 490ee81b6181 |
rev | line source |
---|---|
13097 | 1 # Doxyfile 1.3.7 |
2 | |
3 # This file describes the settings to be used by the documentation system | |
4 # doxygen (www.doxygen.org) for a project | |
5 # | |
6 # All text after a hash (#) is considered a comment and will be ignored | |
7 # The format is: | |
8 # TAG = value [value, ...] | |
9 # For lists items can also be appended using: | |
10 # TAG += value [value, ...] | |
11 # Values that contain spaces should be placed between quotes (" ") | |
12 | |
13 #--------------------------------------------------------------------------- | |
14 # Project related configuration options | |
15 #--------------------------------------------------------------------------- | |
16 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
13097 | 18 # by quotes) that should identify the project. |
19 | |
20 PROJECT_NAME = MPlayer | |
21 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
23 # This could be handy for archiving the generated documentation or |
13097 | 24 # if some version control system is used. |
25 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
26 PROJECT_NUMBER = |
13097 | 27 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
29 # base path where the generated documentation will be put. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
30 # If a relative path is entered, it will be relative to the location |
13097 | 31 # where doxygen was started. If left blank the current directory will be used. |
32 | |
33 OUTPUT_DIRECTORY = DOCS/tech/doxygen | |
34 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
36 # 2 levels of 10 sub-directories under the output directory of each output |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
37 # format and will distribute the generated files over these directories. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
38 # Enabling this option can be useful when feeding doxygen a huge amount of source |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
39 # files, where putting all generated files in the same directory would otherwise |
13097 | 40 # cause performance problems for the file system. |
41 | |
42 CREATE_SUBDIRS = YES | |
43 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
45 # documentation generated by doxygen is written. Doxygen will use this |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
46 # information to generate all constant output in the proper language. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
47 # The default language is English, other supported languages are: |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
49 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
50 # (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese, |
13097 | 51 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. |
52 | |
53 OUTPUT_LANGUAGE = English | |
54 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
55 # This tag can be used to specify the encoding used in the generated output. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
56 # The encoding is not always determined by the language that is chosen, |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
57 # but also whether or not the output is meant for Windows or non-Windows users. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
58 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
59 # forces the Windows encoding (this is the default for the Windows binary), |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
60 # whereas setting the tag to NO uses a Unix-style encoding (the default for |
13097 | 61 # all platforms other than Windows). |
62 | |
63 USE_WINDOWS_ENCODING = NO | |
64 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
66 # include brief member descriptions after the members that are listed in |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
67 # the file and class documentation (similar to JavaDoc). |
13097 | 68 # Set to NO to disable this. |
69 | |
70 BRIEF_MEMBER_DESC = YES | |
71 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
73 # the brief description of a member or function before the detailed description. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
13097 | 75 # brief descriptions will be completely suppressed. |
76 | |
77 REPEAT_BRIEF = YES | |
78 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
79 # This tag implements a quasi-intelligent brief description abbreviator |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
80 # that is used to form the text in various listings. Each string |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
81 # in this list, if found as the leading text of the brief description, will be |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
82 # stripped from the text and the result after processing the whole list, is used |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
83 # as the annotated text. Otherwise, the brief description is used as-is. If left |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
84 # blank, the following values are used ("$name" is automatically replaced with the |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
85 # name of the entity): "The $name class" "The $name widget" "The $name file" |
13097 | 86 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the" |
87 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
88 ABBREVIATE_BRIEF = |
13097 | 89 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
90 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
91 # Doxygen will generate a detailed section even if there is only a brief |
13097 | 92 # description. |
93 | |
94 ALWAYS_DETAILED_SEC = NO | |
95 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
96 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
97 # members of a class in the documentation of that class as if those members were |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
98 # ordinary class members. Constructors, destructors and assignment operators of |
13097 | 99 # the base classes will not be shown. |
100 | |
101 INLINE_INHERITED_MEMB = YES | |
102 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
103 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
104 # path before files name in the file list and in the header files. If set |
13097 | 105 # to NO the shortest path that makes the file name unique will be used. |
106 | |
107 FULL_PATH_NAMES = YES | |
108 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
109 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
110 # can be used to strip a user-defined part of the path. Stripping is |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
111 # only done if one of the specified strings matches the left-hand part of |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
112 # the path. The tag can be used to show relative paths in the file list. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
113 # If left blank the directory from which doxygen is run is used as the |
13097 | 114 # path to strip. |
115 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
116 STRIP_FROM_PATH = |
13097 | 117 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
118 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
119 # the path mentioned in the documentation of a class, which tells |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
120 # the reader which header file to include in order to use a class. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
121 # If left blank only the name of the header file containing the class |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
122 # definition is used. Otherwise one should specify the include paths that |
13097 | 123 # are normally passed to the compiler using the -I flag. |
124 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
125 STRIP_FROM_INC_PATH = |
13097 | 126 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
127 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
128 # (but less readable) file names. This can be useful is your file systems |
13097 | 129 # doesn't support long names like on DOS, Mac, or CD-ROM. |
130 | |
131 SHORT_NAMES = NO | |
132 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
133 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
134 # will interpret the first line (until the first dot) of a JavaDoc-style |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
135 # comment as the brief description. If set to NO, the JavaDoc |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
136 # comments will behave just like the Qt-style comments (thus requiring an |
13097 | 137 # explicit @brief command for a brief description. |
138 | |
139 JAVADOC_AUTOBRIEF = NO | |
140 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
141 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
142 # treat a multi-line C++ special comment block (i.e. a block of //! or /// |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
143 # comments) as a brief description. This used to be the default behaviour. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
144 # The new default is to treat a multi-line C++ comment block as a detailed |
13097 | 145 # description. Set this tag to YES if you prefer the old behaviour instead. |
146 | |
147 MULTILINE_CPP_IS_BRIEF = NO | |
148 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
149 # If the DETAILS_AT_TOP tag is set to YES then Doxygen |
13097 | 150 # will output the detailed description near the top, like JavaDoc. |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
151 # If set to NO, the detailed description appears after the member |
13097 | 152 # documentation. |
153 | |
154 DETAILS_AT_TOP = NO | |
155 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
156 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
157 # member inherits the documentation from any documented member that it |
13097 | 158 # re-implements. |
159 | |
160 INHERIT_DOCS = YES | |
161 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
162 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
163 # tag is set to YES, then doxygen will reuse the documentation of the first |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
164 # member in the group (if any) for the other members of the group. By default |
13097 | 165 # all members of a group must be documented explicitly. |
166 | |
167 DISTRIBUTE_GROUP_DOC = NO | |
168 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
169 # The TAB_SIZE tag can be used to set the number of spaces in a tab. |
13097 | 170 # Doxygen uses this value to replace tabs by spaces in code fragments. |
171 | |
172 TAB_SIZE = 8 | |
173 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
174 # This tag can be used to specify a number of aliases that acts |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
175 # as commands in the documentation. An alias has the form "name=value". |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
176 # For example adding "sideeffect=\par Side Effects:\n" will allow you to |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
177 # put the command \sideeffect (or @sideeffect) in the documentation, which |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
178 # will result in a user-defined paragraph with heading "Side Effects:". |
13097 | 179 # You can put \n's in the value part of an alias to insert newlines. |
180 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
181 ALIASES = |
13097 | 182 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
183 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
184 # only. Doxygen will then generate output that is more tailored for C. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
185 # For instance, some of the names that are used will be different. The list |
13097 | 186 # of all members will be omitted, etc. |
187 | |
188 OPTIMIZE_OUTPUT_FOR_C = NO | |
189 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
190 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
191 # only. Doxygen will then generate output that is more tailored for Java. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
192 # For instance, namespaces will be presented as packages, qualified scopes |
13097 | 193 # will look different, etc. |
194 | |
195 OPTIMIZE_OUTPUT_JAVA = NO | |
196 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
197 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
198 # the same type (for instance a group of public functions) to be put as a |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
199 # subgroup of that type (e.g. under the Public Functions section). Set it to |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
200 # NO to prevent subgrouping. Alternatively, this can be done per class using |
13097 | 201 # the \nosubgrouping command. |
202 | |
203 SUBGROUPING = YES | |
204 | |
205 #--------------------------------------------------------------------------- | |
206 # Build related configuration options | |
207 #--------------------------------------------------------------------------- | |
208 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
209 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
210 # documentation are documented, even if no documentation was available. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
211 # Private class members and static file members will be hidden unless |
13097 | 212 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
213 | |
214 EXTRACT_ALL = YES | |
215 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
216 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
13097 | 217 # will be included in the documentation. |
218 | |
219 EXTRACT_PRIVATE = YES | |
220 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
221 # If the EXTRACT_STATIC tag is set to YES all static members of a file |
13097 | 222 # will be included in the documentation. |
223 | |
224 EXTRACT_STATIC = YES | |
225 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
226 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
227 # defined locally in source files will be included in the documentation. |
13097 | 228 # If set to NO only classes defined in header files are included. |
229 | |
230 EXTRACT_LOCAL_CLASSES = YES | |
231 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
232 # This flag is only useful for Objective-C code. When set to YES local |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
233 # methods, which are defined in the implementation section but not in |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
234 # the interface are included in the documentation. |
13097 | 235 # If set to NO (the default) only methods in the interface are included. |
236 | |
237 EXTRACT_LOCAL_METHODS = NO | |
238 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
239 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
240 # undocumented members of documented classes, files or namespaces. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
241 # If set to NO (the default) these members will be included in the |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
242 # various overviews, but no documentation section is generated. |
13097 | 243 # This option has no effect if EXTRACT_ALL is enabled. |
244 | |
245 HIDE_UNDOC_MEMBERS = NO | |
246 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
247 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
248 # undocumented classes that are normally visible in the class hierarchy. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
249 # If set to NO (the default) these classes will be included in the various |
13097 | 250 # overviews. This option has no effect if EXTRACT_ALL is enabled. |
251 | |
252 HIDE_UNDOC_CLASSES = NO | |
253 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
254 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
255 # friend (class|struct|union) declarations. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
256 # If set to NO (the default) these declarations will be included in the |
13097 | 257 # documentation. |
258 | |
259 HIDE_FRIEND_COMPOUNDS = NO | |
260 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
261 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
262 # documentation blocks found inside the body of a function. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
263 # If set to NO (the default) these blocks will be appended to the |
13097 | 264 # function's detailed documentation block. |
265 | |
266 HIDE_IN_BODY_DOCS = NO | |
267 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
268 # The INTERNAL_DOCS tag determines if documentation |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
269 # that is typed after a \internal command is included. If the tag is set |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
270 # to NO (the default) then the documentation will be excluded. |
13097 | 271 # Set it to YES to include the internal documentation. |
272 | |
273 INTERNAL_DOCS = NO | |
274 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
275 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
276 # file names in lower-case letters. If set to YES upper-case letters are also |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
277 # allowed. This is useful if you have classes or files whose names only differ |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
278 # in case and if your file system supports case sensitive file names. Windows |
13097 | 279 # users are advised to set this option to NO. |
280 | |
281 CASE_SENSE_NAMES = YES | |
282 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
283 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
284 # will show members with their full class and namespace scopes in the |
13097 | 285 # documentation. If set to YES the scope will be hidden. |
286 | |
287 HIDE_SCOPE_NAMES = NO | |
288 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
289 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
290 # will put a list of the files that are included by a file in the documentation |
13097 | 291 # of that file. |
292 | |
293 SHOW_INCLUDE_FILES = YES | |
294 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
295 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] |
13097 | 296 # is inserted in the documentation for inline members. |
297 | |
298 INLINE_INFO = YES | |
299 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
300 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
301 # will sort the (detailed) documentation of file and class members |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
302 # alphabetically by member name. If set to NO the members will appear in |
13097 | 303 # declaration order. |
304 | |
305 SORT_MEMBER_DOCS = YES | |
306 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
307 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
308 # brief documentation of file, namespace and class members alphabetically |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
309 # by member name. If set to NO (the default) the members will appear in |
13097 | 310 # declaration order. |
311 | |
312 SORT_BRIEF_DOCS = NO | |
313 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
314 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
315 # sorted by fully-qualified names, including namespaces. If set to |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
316 # NO (the default), the class list will be sorted only by class name, |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
317 # not including the namespace part. |
13097 | 318 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
319 # Note: This option applies only to the class list, not to the |
13097 | 320 # alphabetical list. |
321 | |
322 SORT_BY_SCOPE_NAME = NO | |
323 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
324 # The GENERATE_TODOLIST tag can be used to enable (YES) or |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
325 # disable (NO) the todo list. This list is created by putting \todo |
13097 | 326 # commands in the documentation. |
327 | |
328 GENERATE_TODOLIST = YES | |
329 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
330 # The GENERATE_TESTLIST tag can be used to enable (YES) or |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
331 # disable (NO) the test list. This list is created by putting \test |
13097 | 332 # commands in the documentation. |
333 | |
334 GENERATE_TESTLIST = YES | |
335 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
336 # The GENERATE_BUGLIST tag can be used to enable (YES) or |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
337 # disable (NO) the bug list. This list is created by putting \bug |
13097 | 338 # commands in the documentation. |
339 | |
340 GENERATE_BUGLIST = YES | |
341 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
342 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
343 # disable (NO) the deprecated list. This list is created by putting |
13097 | 344 # \deprecated commands in the documentation. |
345 | |
346 GENERATE_DEPRECATEDLIST= YES | |
347 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
348 # The ENABLED_SECTIONS tag can be used to enable conditional |
13097 | 349 # documentation sections, marked by \if sectionname ... \endif. |
350 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
351 ENABLED_SECTIONS = |
13097 | 352 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
353 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
354 # the initial value of a variable or define consists of for it to appear in |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
355 # the documentation. If the initializer consists of more lines than specified |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
356 # here it will be hidden. Use a value of 0 to hide initializers completely. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
357 # The appearance of the initializer of individual variables and defines in the |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
358 # documentation can be controlled using \showinitializer or \hideinitializer |
13097 | 359 # command in the documentation regardless of this setting. |
360 | |
361 MAX_INITIALIZER_LINES = 30 | |
362 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
363 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
364 # at the bottom of the documentation of classes and structs. If set to YES the |
13097 | 365 # list will mention the files that were used to generate the documentation. |
366 | |
367 SHOW_USED_FILES = YES | |
368 | |
369 #--------------------------------------------------------------------------- | |
370 # configuration options related to warning and progress messages | |
371 #--------------------------------------------------------------------------- | |
372 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
373 # The QUIET tag can be used to turn on/off the messages that are generated |
13097 | 374 # by doxygen. Possible values are YES and NO. If left blank NO is used. |
375 | |
376 QUIET = NO | |
377 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
378 # The WARNINGS tag can be used to turn on/off the warning messages that are |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
379 # generated by doxygen. Possible values are YES and NO. If left blank |
13097 | 380 # NO is used. |
381 | |
382 WARNINGS = YES | |
383 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
384 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
385 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will |
13097 | 386 # automatically be disabled. |
387 | |
388 WARN_IF_UNDOCUMENTED = NO | |
389 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
390 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
391 # potential errors in the documentation, such as not documenting some |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
392 # parameters in a documented function, or documenting parameters that |
13097 | 393 # don't exist or using markup commands wrongly. |
394 | |
395 WARN_IF_DOC_ERROR = NO | |
396 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
397 # The WARN_FORMAT tag determines the format of the warning messages that |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
398 # doxygen can produce. The string should contain the $file, $line, and $text |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
399 # tags, which will be replaced by the file and line number from which the |
13097 | 400 # warning originated and the warning text. |
401 | |
402 WARN_FORMAT = "$file:$line: $text" | |
403 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
404 # The WARN_LOGFILE tag can be used to specify a file to which warning |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
405 # and error messages should be written. If left blank the output is written |
13097 | 406 # to stderr. |
407 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
408 WARN_LOGFILE = |
13097 | 409 |
410 #--------------------------------------------------------------------------- | |
411 # configuration options related to the input files | |
412 #--------------------------------------------------------------------------- | |
413 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
414 # The INPUT tag can be used to specify the files and/or directories that contain |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
415 # documented source files. You may enter file names like "myfile.cpp" or |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
416 # directories like "/usr/src/myproject". Separate the files or directories |
13097 | 417 # with spaces. |
418 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
419 INPUT = |
13097 | 420 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
421 # If the value of the INPUT tag contains directories, you can use the |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
422 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
423 # and *.h) to filter out the source-files in the directories. If left |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
424 # blank the following patterns are tested: |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
425 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp |
13097 | 426 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm |
427 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
428 FILE_PATTERNS = |
13097 | 429 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
430 # The RECURSIVE tag can be used to turn specify whether or not subdirectories |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
431 # should be searched for input files as well. Possible values are YES and NO. |
13097 | 432 # If left blank NO is used. |
433 | |
434 RECURSIVE = YES | |
435 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
436 # The EXCLUDE tag can be used to specify files and/or directories that should |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
437 # excluded from the INPUT source files. This way you can easily exclude a |
13097 | 438 # subdirectory from a directory tree whose root is specified with the INPUT tag. |
439 | |
440 EXCLUDE = DOCS TOOLS | |
441 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
442 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories |
13097 | 443 # that are symbolic links (a Unix filesystem feature) are excluded from the input. |
444 | |
445 EXCLUDE_SYMLINKS = NO | |
446 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
447 # If the value of the INPUT tag contains directories, you can use the |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
448 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
13097 | 449 # certain files from those directories. |
450 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
451 EXCLUDE_PATTERNS = |
13097 | 452 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
453 # The EXAMPLE_PATH tag can be used to specify one or more files or |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
454 # directories that contain example code fragments that are included (see |
13097 | 455 # the \include command). |
456 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
457 EXAMPLE_PATH = |
13097 | 458 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
459 # If the value of the EXAMPLE_PATH tag contains directories, you can use the |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
460 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
461 # and *.h) to filter out the source-files in the directories. If left |
13097 | 462 # blank all files are included. |
463 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
464 EXAMPLE_PATTERNS = |
13097 | 465 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
466 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
467 # searched for input files to be used with the \include or \dontinclude |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
468 # commands irrespective of the value of the RECURSIVE tag. |
13097 | 469 # Possible values are YES and NO. If left blank NO is used. |
470 | |
471 EXAMPLE_RECURSIVE = NO | |
472 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
473 # The IMAGE_PATH tag can be used to specify one or more files or |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
474 # directories that contain image that are included in the documentation (see |
13097 | 475 # the \image command). |
476 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
477 IMAGE_PATH = |
13097 | 478 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
479 # The INPUT_FILTER tag can be used to specify a program that doxygen should |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
480 # invoke to filter for each input file. Doxygen will invoke the filter program |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
481 # by executing (via popen()) the command <filter> <input-file>, where <filter> |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
482 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
483 # input file. Doxygen will then use the output that the filter program writes |
13097 | 484 # to standard output. |
485 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
486 INPUT_FILTER = |
13097 | 487 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
488 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
489 # INPUT_FILTER) will be used to filter the input files when producing source |
13097 | 490 # files to browse (i.e. when SOURCE_BROWSER is set to YES). |
491 | |
492 FILTER_SOURCE_FILES = NO | |
493 | |
494 #--------------------------------------------------------------------------- | |
495 # configuration options related to source browsing | |
496 #--------------------------------------------------------------------------- | |
497 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
498 # If the SOURCE_BROWSER tag is set to YES then a list of source files will |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
499 # be generated. Documented entities will be cross-referenced with these sources. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
500 # Note: To get rid of all source code in the generated output, make sure also |
13097 | 501 # VERBATIM_HEADERS is set to NO. |
502 | |
503 SOURCE_BROWSER = YES | |
504 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
505 # Setting the INLINE_SOURCES tag to YES will include the body |
13097 | 506 # of functions and classes directly in the documentation. |
507 | |
508 INLINE_SOURCES = YES | |
509 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
510 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
511 # doxygen to hide any special comment blocks from generated source code |
13097 | 512 # fragments. Normal C and C++ comments will always remain visible. |
513 | |
514 STRIP_CODE_COMMENTS = YES | |
515 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
516 # If the REFERENCED_BY_RELATION tag is set to YES (the default) |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
517 # then for each documented function all documented |
13097 | 518 # functions referencing it will be listed. |
519 | |
520 REFERENCED_BY_RELATION = YES | |
521 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
522 # If the REFERENCES_RELATION tag is set to YES (the default) |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
523 # then for each documented function all documented entities |
13097 | 524 # called/used by that function will be listed. |
525 | |
526 REFERENCES_RELATION = YES | |
527 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
528 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
529 # will generate a verbatim copy of the header file for each class for |
13097 | 530 # which an include is specified. Set to NO to disable this. |
531 | |
532 VERBATIM_HEADERS = YES | |
533 | |
534 #--------------------------------------------------------------------------- | |
535 # configuration options related to the alphabetical class index | |
536 #--------------------------------------------------------------------------- | |
537 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
538 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
539 # of all compounds will be generated. Enable this if the project |
13097 | 540 # contains a lot of classes, structs, unions or interfaces. |
541 | |
542 ALPHABETICAL_INDEX = YES | |
543 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
544 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
545 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns |
13097 | 546 # in which this list will be split (can be a number in the range [1..20]) |
547 | |
548 COLS_IN_ALPHA_INDEX = 2 | |
549 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
550 # In case all classes in a project start with a common prefix, all |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
551 # classes will be put under the same header in the alphabetical index. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
552 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that |
13097 | 553 # should be ignored while generating the index headers. |
554 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
555 IGNORE_PREFIX = |
13097 | 556 |
557 #--------------------------------------------------------------------------- | |
558 # configuration options related to the HTML output | |
559 #--------------------------------------------------------------------------- | |
560 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
561 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will |
13097 | 562 # generate HTML output. |
563 | |
564 GENERATE_HTML = YES | |
565 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
566 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
567 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
13097 | 568 # put in front of it. If left blank `html' will be used as the default path. |
569 | |
570 HTML_OUTPUT = html | |
571 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
572 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
573 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank |
13097 | 574 # doxygen will generate files with .html extension. |
575 | |
576 HTML_FILE_EXTENSION = .html | |
577 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
578 # The HTML_HEADER tag can be used to specify a personal HTML header for |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
579 # each generated HTML page. If it is left blank doxygen will generate a |
13097 | 580 # standard header. |
581 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
582 HTML_HEADER = |
13097 | 583 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
584 # The HTML_FOOTER tag can be used to specify a personal HTML footer for |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
585 # each generated HTML page. If it is left blank doxygen will generate a |
13097 | 586 # standard footer. |
587 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
588 HTML_FOOTER = |
13097 | 589 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
590 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
591 # style sheet that is used by each HTML page. It can be used to |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
592 # fine-tune the look of the HTML output. If the tag is left blank doxygen |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
593 # will generate a default style sheet. Note that doxygen will try to copy |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
594 # the style sheet file to the HTML output directory, so don't put your own |
13097 | 595 # stylesheet in the HTML output directory as well, or it will be erased! |
596 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
597 HTML_STYLESHEET = |
13097 | 598 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
599 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
600 # files or namespaces will be aligned in HTML using tables. If set to |
13097 | 601 # NO a bullet list will be used. |
602 | |
603 HTML_ALIGN_MEMBERS = YES | |
604 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
605 # If the GENERATE_HTMLHELP tag is set to YES, additional index files |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
606 # will be generated that can be used as input for tools like the |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
607 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) |
13097 | 608 # of the generated HTML documentation. |
609 | |
610 GENERATE_HTMLHELP = NO | |
611 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
612 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
613 # be used to specify the file name of the resulting .chm file. You |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
614 # can add a path in front of the file if the result should not be |
13097 | 615 # written to the html output directory. |
616 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
617 CHM_FILE = |
13097 | 618 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
619 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
620 # be used to specify the location (absolute path including file name) of |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
621 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run |
13097 | 622 # the HTML help compiler on the generated index.hhp. |
623 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
624 HHC_LOCATION = |
13097 | 625 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
626 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
627 # controls if a separate .chi index file is generated (YES) or that |
13097 | 628 # it should be included in the master .chm file (NO). |
629 | |
630 GENERATE_CHI = NO | |
631 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
632 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
633 # controls whether a binary table of contents is generated (YES) or a |
13097 | 634 # normal table of contents (NO) in the .chm file. |
635 | |
636 BINARY_TOC = NO | |
637 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
638 # The TOC_EXPAND flag can be set to YES to add extra items for group members |
13097 | 639 # to the contents of the HTML help documentation and to the tree view. |
640 | |
641 TOC_EXPAND = NO | |
642 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
643 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
644 # top of each HTML page. The value NO (the default) enables the index and |
13097 | 645 # the value YES disables it. |
646 | |
647 DISABLE_INDEX = NO | |
648 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
649 # This tag can be used to set the number of enum values (range [1..20]) |
13097 | 650 # that doxygen will group on one line in the generated HTML documentation. |
651 | |
652 ENUM_VALUES_PER_LINE = 4 | |
653 | |
654 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
655 # generated containing a tree-like index structure (just like the one that |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
656 # is generated for HTML Help). For this to work a browser that supports |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
657 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
658 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are |
13097 | 659 # probably better off using the HTML help feature. |
660 | |
661 GENERATE_TREEVIEW = NO | |
662 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
663 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
664 # used to set the initial width (in pixels) of the frame in which the tree |
13097 | 665 # is shown. |
666 | |
667 TREEVIEW_WIDTH = 250 | |
668 | |
669 #--------------------------------------------------------------------------- | |
670 # configuration options related to the LaTeX output | |
671 #--------------------------------------------------------------------------- | |
672 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
673 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will |
13097 | 674 # generate Latex output. |
675 | |
676 GENERATE_LATEX = NO | |
677 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
678 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
679 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
13097 | 680 # put in front of it. If left blank `latex' will be used as the default path. |
681 | |
682 LATEX_OUTPUT = latex | |
683 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
684 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
13097 | 685 # invoked. If left blank `latex' will be used as the default command name. |
686 | |
687 LATEX_CMD_NAME = latex | |
688 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
689 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
690 # generate index for LaTeX. If left blank `makeindex' will be used as the |
13097 | 691 # default command name. |
692 | |
693 MAKEINDEX_CMD_NAME = makeindex | |
694 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
695 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
696 # LaTeX documents. This may be useful for small projects and may help to |
13097 | 697 # save some trees in general. |
698 | |
699 COMPACT_LATEX = NO | |
700 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
701 # The PAPER_TYPE tag can be used to set the paper type that is used |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
702 # by the printer. Possible values are: a4, a4wide, letter, legal and |
13097 | 703 # executive. If left blank a4wide will be used. |
704 | |
705 PAPER_TYPE = a4wide | |
706 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
707 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX |
13097 | 708 # packages that should be included in the LaTeX output. |
709 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
710 EXTRA_PACKAGES = |
13097 | 711 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
712 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
713 # the generated latex document. The header should contain everything until |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
714 # the first chapter. If it is left blank doxygen will generate a |
13097 | 715 # standard header. Notice: only use this tag if you know what you are doing! |
716 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
717 LATEX_HEADER = |
13097 | 718 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
719 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
720 # is prepared for conversion to pdf (using ps2pdf). The pdf file will |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
721 # contain links (just like the HTML output) instead of page references |
13097 | 722 # This makes the output suitable for online browsing using a pdf viewer. |
723 | |
724 PDF_HYPERLINKS = NO | |
725 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
726 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
727 # plain latex in the generated Makefile. Set this option to YES to get a |
13097 | 728 # higher quality PDF documentation. |
729 | |
730 USE_PDFLATEX = NO | |
731 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
732 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
733 # command to the generated LaTeX files. This will instruct LaTeX to keep |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
734 # running if errors occur, instead of asking the user for help. |
13097 | 735 # This option is also used when generating formulas in HTML. |
736 | |
737 LATEX_BATCHMODE = NO | |
738 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
739 # If LATEX_HIDE_INDICES is set to YES then doxygen will not |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
740 # include the index chapters (such as File Index, Compound Index, etc.) |
13097 | 741 # in the output. |
742 | |
743 LATEX_HIDE_INDICES = NO | |
744 | |
745 #--------------------------------------------------------------------------- | |
746 # configuration options related to the RTF output | |
747 #--------------------------------------------------------------------------- | |
748 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
749 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
750 # The RTF output is optimized for Word 97 and may not look very pretty with |
13097 | 751 # other RTF readers or editors. |
752 | |
753 GENERATE_RTF = NO | |
754 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
755 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
756 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
13097 | 757 # put in front of it. If left blank `rtf' will be used as the default path. |
758 | |
759 RTF_OUTPUT = rtf | |
760 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
761 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
762 # RTF documents. This may be useful for small projects and may help to |
13097 | 763 # save some trees in general. |
764 | |
765 COMPACT_RTF = NO | |
766 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
767 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
768 # will contain hyperlink fields. The RTF file will |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
769 # contain links (just like the HTML output) instead of page references. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
770 # This makes the output suitable for online browsing using WORD or other |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
771 # programs which support those fields. |
13097 | 772 # Note: wordpad (write) and others do not support links. |
773 | |
774 RTF_HYPERLINKS = NO | |
775 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
776 # Load stylesheet definitions from file. Syntax is similar to doxygen's |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
777 # config file, i.e. a series of assignments. You only have to provide |
13097 | 778 # replacements, missing definitions are set to their default value. |
779 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
780 RTF_STYLESHEET_FILE = |
13097 | 781 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
782 # Set optional variables used in the generation of an rtf document. |
13097 | 783 # Syntax is similar to doxygen's config file. |
784 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
785 RTF_EXTENSIONS_FILE = |
13097 | 786 |
787 #--------------------------------------------------------------------------- | |
788 # configuration options related to the man page output | |
789 #--------------------------------------------------------------------------- | |
790 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
791 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will |
13097 | 792 # generate man pages |
793 | |
794 GENERATE_MAN = NO | |
795 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
796 # The MAN_OUTPUT tag is used to specify where the man pages will be put. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
797 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
13097 | 798 # put in front of it. If left blank `man' will be used as the default path. |
799 | |
800 MAN_OUTPUT = man | |
801 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
802 # The MAN_EXTENSION tag determines the extension that is added to |
13097 | 803 # the generated man pages (default is the subroutine's section .3) |
804 | |
805 MAN_EXTENSION = .3 | |
806 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
807 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
808 # then it will generate one additional man file for each entity |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
809 # documented in the real man page(s). These additional files |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
810 # only source the real man page, but without them the man command |
13097 | 811 # would be unable to find the correct page. The default is NO. |
812 | |
813 MAN_LINKS = NO | |
814 | |
815 #--------------------------------------------------------------------------- | |
816 # configuration options related to the XML output | |
817 #--------------------------------------------------------------------------- | |
818 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
819 # If the GENERATE_XML tag is set to YES Doxygen will |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
820 # generate an XML file that captures the structure of |
13097 | 821 # the code including all documentation. |
822 | |
823 GENERATE_XML = NO | |
824 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
825 # The XML_OUTPUT tag is used to specify where the XML pages will be put. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
826 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
13097 | 827 # put in front of it. If left blank `xml' will be used as the default path. |
828 | |
829 XML_OUTPUT = xml | |
830 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
831 # The XML_SCHEMA tag can be used to specify an XML schema, |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
832 # which can be used by a validating XML parser to check the |
13097 | 833 # syntax of the XML files. |
834 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
835 XML_SCHEMA = |
13097 | 836 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
837 # The XML_DTD tag can be used to specify an XML DTD, |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
838 # which can be used by a validating XML parser to check the |
13097 | 839 # syntax of the XML files. |
840 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
841 XML_DTD = |
13097 | 842 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
843 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
844 # dump the program listings (including syntax highlighting |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
845 # and cross-referencing information) to the XML output. Note that |
13097 | 846 # enabling this will significantly increase the size of the XML output. |
847 | |
848 XML_PROGRAMLISTING = YES | |
849 | |
850 #--------------------------------------------------------------------------- | |
851 # configuration options for the AutoGen Definitions output | |
852 #--------------------------------------------------------------------------- | |
853 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
854 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
855 # generate an AutoGen Definitions (see autogen.sf.net) file |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
856 # that captures the structure of the code including all |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
857 # documentation. Note that this feature is still experimental |
13097 | 858 # and incomplete at the moment. |
859 | |
860 GENERATE_AUTOGEN_DEF = NO | |
861 | |
862 #--------------------------------------------------------------------------- | |
863 # configuration options related to the Perl module output | |
864 #--------------------------------------------------------------------------- | |
865 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
866 # If the GENERATE_PERLMOD tag is set to YES Doxygen will |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
867 # generate a Perl module file that captures the structure of |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
868 # the code including all documentation. Note that this |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
869 # feature is still experimental and incomplete at the |
13097 | 870 # moment. |
871 | |
872 GENERATE_PERLMOD = NO | |
873 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
874 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
875 # the necessary Makefile rules, Perl scripts and LaTeX code to be able |
13097 | 876 # to generate PDF and DVI output from the Perl module output. |
877 | |
878 PERLMOD_LATEX = NO | |
879 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
880 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
881 # nicely formatted so it can be parsed by a human reader. This is useful |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
882 # if you want to understand what is going on. On the other hand, if this |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
883 # tag is set to NO the size of the Perl module output will be much smaller |
13097 | 884 # and Perl will parse it just the same. |
885 | |
886 PERLMOD_PRETTY = YES | |
887 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
888 # The names of the make variables in the generated doxyrules.make file |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
889 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
890 # This is useful so different doxyrules.make files included by the same |
13097 | 891 # Makefile don't overwrite each other's variables. |
892 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
893 PERLMOD_MAKEVAR_PREFIX = |
13097 | 894 |
895 #--------------------------------------------------------------------------- | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
896 # Configuration options related to the preprocessor |
13097 | 897 #--------------------------------------------------------------------------- |
898 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
899 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
900 # evaluate all C-preprocessor directives found in the sources and include |
13097 | 901 # files. |
902 | |
903 ENABLE_PREPROCESSING = YES | |
904 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
905 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
906 # names in the source code. If set to NO (the default) only conditional |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
907 # compilation will be performed. Macro expansion can be done in a controlled |
13097 | 908 # way by setting EXPAND_ONLY_PREDEF to YES. |
909 | |
910 MACRO_EXPANSION = NO | |
911 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
912 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
913 # then the macro expansion is limited to the macros specified with the |
13097 | 914 # PREDEFINED and EXPAND_AS_PREDEFINED tags. |
915 | |
916 EXPAND_ONLY_PREDEF = NO | |
917 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
918 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
13097 | 919 # in the INCLUDE_PATH (see below) will be search if a #include is found. |
920 | |
921 SEARCH_INCLUDES = YES | |
922 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
923 # The INCLUDE_PATH tag can be used to specify one or more directories that |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
924 # contain include files that are not input files but should be processed by |
13097 | 925 # the preprocessor. |
926 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
927 INCLUDE_PATH = |
13097 | 928 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
929 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
930 # patterns (like *.h and *.hpp) to filter out the header-files in the |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
931 # directories. If left blank, the patterns specified with FILE_PATTERNS will |
13097 | 932 # be used. |
933 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
934 INCLUDE_FILE_PATTERNS = |
13097 | 935 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
936 # The PREDEFINED tag can be used to specify one or more macro names that |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
937 # are defined before the preprocessor is started (similar to the -D option of |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
938 # gcc). The argument of the tag is a list of macros of the form: name |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
939 # or name=definition (no spaces). If the definition and the = are |
13097 | 940 # omitted =1 is assumed. |
941 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
942 PREDEFINED = |
13097 | 943 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
944 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
945 # this tag can be used to specify a list of macro names that should be expanded. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
946 # The macro definition that is found in the sources will be used. |
13097 | 947 # Use the PREDEFINED tag if you want to use a different macro definition. |
948 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
949 EXPAND_AS_DEFINED = |
13097 | 950 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
951 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
952 # doxygen's preprocessor will remove all function-like macros that are alone |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
953 # on a line, have an all uppercase name, and do not end with a semicolon. Such |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
954 # function macros are typically used for boiler-plate code, and will confuse the |
13097 | 955 # parser if not removed. |
956 | |
957 SKIP_FUNCTION_MACROS = YES | |
958 | |
959 #--------------------------------------------------------------------------- | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
960 # Configuration::additions related to external references |
13097 | 961 #--------------------------------------------------------------------------- |
962 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
963 # The TAGFILES option can be used to specify one or more tagfiles. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
964 # Optionally an initial location of the external documentation |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
965 # can be added for each tagfile. The format of a tag file without |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
966 # this location is as follows: |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
967 # TAGFILES = file1 file2 ... |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
968 # Adding location for the tag files is done as follows: |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
969 # TAGFILES = file1=loc1 "file2 = loc2" ... |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
970 # where "loc1" and "loc2" can be relative or absolute paths or |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
971 # URLs. If a location is present for each tag, the installdox tool |
13097 | 972 # does not have to be run to correct the links. |
973 # Note that each tag file must have a unique name | |
974 # (where the name does NOT include the path) | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
975 # If a tag file is not located in the directory in which doxygen |
13097 | 976 # is run, you must also specify the path to the tagfile here. |
977 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
978 TAGFILES = |
13097 | 979 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
980 # When a file name is specified after GENERATE_TAGFILE, doxygen will create |
13097 | 981 # a tag file that is based on the input files it reads. |
982 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
983 GENERATE_TAGFILE = |
13097 | 984 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
985 # If the ALLEXTERNALS tag is set to YES all external classes will be listed |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
986 # in the class index. If set to NO only the inherited external classes |
13097 | 987 # will be listed. |
988 | |
989 ALLEXTERNALS = NO | |
990 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
991 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
992 # in the modules index. If set to NO, only the current project's groups will |
13097 | 993 # be listed. |
994 | |
995 EXTERNAL_GROUPS = YES | |
996 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
997 # The PERL_PATH should be the absolute path and name of the perl script |
13097 | 998 # interpreter (i.e. the result of `which perl'). |
999 | |
1000 PERL_PATH = /usr/bin/perl | |
1001 | |
1002 #--------------------------------------------------------------------------- | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1003 # Configuration options related to the dot tool |
13097 | 1004 #--------------------------------------------------------------------------- |
1005 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1006 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1007 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1008 # super classes. Setting the tag to NO turns the diagrams off. Note that this |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1009 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is |
13097 | 1010 # recommended to install and use dot, since it yields more powerful graphs. |
1011 | |
1012 CLASS_DIAGRAMS = NO | |
1013 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1014 # If set to YES, the inheritance and collaboration graphs will hide |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1015 # inheritance and usage relations if the target is undocumented |
13097 | 1016 # or is not a class. |
1017 | |
1018 HIDE_UNDOC_RELATIONS = YES | |
1019 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1020 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1021 # available from the path. This tool is part of Graphviz, a graph visualization |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1022 # toolkit from AT&T and Lucent Bell Labs. The other options in this section |
13097 | 1023 # have no effect if this option is set to NO (the default) |
1024 | |
1025 HAVE_DOT = NO | |
1026 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1027 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1028 # will generate a graph for each documented class showing the direct and |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1029 # indirect inheritance relations. Setting this tag to YES will force the |
13097 | 1030 # the CLASS_DIAGRAMS tag to NO. |
1031 | |
1032 CLASS_GRAPH = YES | |
1033 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1034 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1035 # will generate a graph for each documented class showing the direct and |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1036 # indirect implementation dependencies (inheritance, containment, and |
13097 | 1037 # class references variables) of the class with other documented classes. |
1038 | |
1039 COLLABORATION_GRAPH = YES | |
1040 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1041 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1042 # collaboration diagrams in a style similar to the OMG's Unified Modeling |
13097 | 1043 # Language. |
1044 | |
1045 UML_LOOK = NO | |
1046 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1047 # If set to YES, the inheritance and collaboration graphs will show the |
13097 | 1048 # relations between templates and their instances. |
1049 | |
1050 TEMPLATE_RELATIONS = NO | |
1051 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1052 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1053 # tags are set to YES then doxygen will generate a graph for each documented |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1054 # file showing the direct and indirect include dependencies of the file with |
13097 | 1055 # other documented files. |
1056 | |
1057 INCLUDE_GRAPH = YES | |
1058 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1059 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1060 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1061 # documented header file showing the documented files that directly or |
13097 | 1062 # indirectly include this file. |
1063 | |
1064 INCLUDED_BY_GRAPH = YES | |
1065 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1066 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1067 # generate a call dependency graph for every global function or class method. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1068 # Note that enabling this option will significantly increase the time of a run. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1069 # So in most cases it will be better to enable call graphs for selected |
13097 | 1070 # functions only using the \callgraph command. |
1071 | |
1072 CALL_GRAPH = NO | |
1073 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1074 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
13097 | 1075 # will graphical hierarchy of all classes instead of a textual one. |
1076 | |
1077 GRAPHICAL_HIERARCHY = YES | |
1078 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1079 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
13097 | 1080 # generated by dot. Possible values are png, jpg, or gif |
1081 # If left blank png will be used. | |
1082 | |
1083 DOT_IMAGE_FORMAT = png | |
1084 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1085 # The tag DOT_PATH can be used to specify the path where the dot tool can be |
13097 | 1086 # found. If left blank, it is assumed the dot tool can be found on the path. |
1087 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1088 DOT_PATH = |
13097 | 1089 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1090 # The DOTFILE_DIRS tag can be used to specify one or more directories that |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1091 # contain dot files that are included in the documentation (see the |
13097 | 1092 # \dotfile command). |
1093 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1094 DOTFILE_DIRS = |
13097 | 1095 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1096 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1097 # (in pixels) of the graphs generated by dot. If a graph becomes larger than |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1098 # this value, doxygen will try to truncate the graph, so that it fits within |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1099 # the specified constraint. Beware that most browsers cannot cope with very |
13097 | 1100 # large images. |
1101 | |
1102 MAX_DOT_GRAPH_WIDTH = 1024 | |
1103 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1104 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1105 # (in pixels) of the graphs generated by dot. If a graph becomes larger than |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1106 # this value, doxygen will try to truncate the graph, so that it fits within |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1107 # the specified constraint. Beware that most browsers cannot cope with very |
13097 | 1108 # large images. |
1109 | |
1110 MAX_DOT_GRAPH_HEIGHT = 1024 | |
1111 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1112 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1113 # graphs generated by dot. A depth value of 3 means that only nodes reachable |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1114 # from the root by following a path via at most 3 edges will be shown. Nodes that |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1115 # lay further from the root node will be omitted. Note that setting this option to |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1116 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1117 # note that a graph may be further truncated if the graph's image dimensions are |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1118 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). |
13097 | 1119 # If 0 is used for the depth value (the default), the graph is not depth-constrained. |
1120 | |
1121 MAX_DOT_GRAPH_DEPTH = 0 | |
1122 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1123 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1124 # generate a legend page explaining the meaning of the various boxes and |
13097 | 1125 # arrows in the dot generated graphs. |
1126 | |
1127 GENERATE_LEGEND = YES | |
1128 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1129 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1130 # remove the intermediate dot files that are used to generate |
13097 | 1131 # the various graphs. |
1132 | |
1133 DOT_CLEANUP = YES | |
1134 | |
1135 #--------------------------------------------------------------------------- | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1136 # Configuration::additions related to the search engine |
13097 | 1137 #--------------------------------------------------------------------------- |
1138 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1139 # The SEARCHENGINE tag specifies whether or not a search engine should be |
13097 | 1140 # used. If set to NO the values of all tags below this one will be ignored. |
1141 | |
1142 SEARCHENGINE = NO |