]>
Commit | Line | Data |
---|---|---|
1490ff4d MW |
1 | # Doxyfile 1.5.6 |
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 (" ") | |
b1e69188 MW |
12 | |
13 | #--------------------------------------------------------------------------- | |
14 | # Project related configuration options | |
15 | #--------------------------------------------------------------------------- | |
1490ff4d | 16 | |
13f418b4 MW |
17 | # This tag specifies the encoding used for all characters in the config file |
18 | # that follow. The default is UTF-8 which is also the encoding used for all | |
19 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the | |
20 | # iconv built into libc) for the transcoding. See | |
1490ff4d MW |
21 | # http://www.gnu.org/software/libiconv for the list of possible encodings. |
22 | ||
23 | DOXYFILE_ENCODING = UTF-8 | |
24 | ||
13f418b4 | 25 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
1490ff4d MW |
26 | # by quotes) that should identify the project. |
27 | ||
28 | PROJECT_NAME = "@PACKAGE_NAME@" | |
29 | ||
13f418b4 MW |
30 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. |
31 | # This could be handy for archiving the generated documentation or | |
1490ff4d MW |
32 | # if some version control system is used. |
33 | ||
34 | PROJECT_NUMBER = "@PACKAGE_VERSION@" | |
35 | ||
13f418b4 MW |
36 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
37 | # base path where the generated documentation will be put. | |
38 | # If a relative path is entered, it will be relative to the location | |
1490ff4d MW |
39 | # where doxygen was started. If left blank the current directory will be used. |
40 | ||
41 | OUTPUT_DIRECTORY = apidoc | |
42 | ||
13f418b4 MW |
43 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create |
44 | # 4096 sub-directories (in 2 levels) under the output directory of each output | |
45 | # format and will distribute the generated files over these directories. | |
46 | # Enabling this option can be useful when feeding doxygen a huge amount of | |
47 | # source files, where putting all generated files in the same directory would | |
1490ff4d MW |
48 | # otherwise cause performance problems for the file system. |
49 | ||
50 | CREATE_SUBDIRS = NO | |
51 | ||
13f418b4 MW |
52 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all |
53 | # documentation generated by doxygen is written. Doxygen will use this | |
54 | # information to generate all constant output in the proper language. | |
55 | # The default language is English, other supported languages are: | |
56 | # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, | |
57 | # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, | |
58 | # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), | |
59 | # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, | |
60 | # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, | |
1490ff4d MW |
61 | # and Ukrainian. |
62 | ||
63 | OUTPUT_LANGUAGE = English | |
64 | ||
13f418b4 MW |
65 | # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
66 | # include brief member descriptions after the members that are listed in | |
67 | # the file and class documentation (similar to JavaDoc). | |
1490ff4d MW |
68 | # Set to NO to disable this. |
69 | ||
70 | BRIEF_MEMBER_DESC = YES | |
71 | ||
13f418b4 MW |
72 | # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend |
73 | # the brief description of a member or function before the detailed description. | |
74 | # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the | |
1490ff4d MW |
75 | # brief descriptions will be completely suppressed. |
76 | ||
77 | REPEAT_BRIEF = YES | |
78 | ||
13f418b4 MW |
79 | # This tag implements a quasi-intelligent brief description abbreviator |
80 | # that is used to form the text in various listings. Each string | |
81 | # in this list, if found as the leading text of the brief description, will be | |
82 | # stripped from the text and the result after processing the whole list, is | |
83 | # used as the annotated text. Otherwise, the brief description is used as-is. | |
84 | # If left blank, the following values are used ("$name" is automatically | |
85 | # replaced with the name of the entity): "The $name class" "The $name widget" | |
86 | # "The $name file" "is" "provides" "specifies" "contains" | |
1490ff4d MW |
87 | # "represents" "a" "an" "the" |
88 | ||
13f418b4 | 89 | ABBREVIATE_BRIEF = |
1490ff4d | 90 | |
13f418b4 MW |
91 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
92 | # Doxygen will generate a detailed section even if there is only a brief | |
1490ff4d MW |
93 | # description. |
94 | ||
95 | ALWAYS_DETAILED_SEC = NO | |
96 | ||
13f418b4 MW |
97 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all |
98 | # inherited members of a class in the documentation of that class as if those | |
99 | # members were ordinary class members. Constructors, destructors and assignment | |
1490ff4d MW |
100 | # operators of the base classes will not be shown. |
101 | ||
102 | INLINE_INHERITED_MEMB = NO | |
103 | ||
13f418b4 MW |
104 | # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
105 | # path before files name in the file list and in the header files. If set | |
1490ff4d MW |
106 | # to NO the shortest path that makes the file name unique will be used. |
107 | ||
108 | FULL_PATH_NAMES = YES | |
109 | ||
13f418b4 MW |
110 | # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
111 | # can be used to strip a user-defined part of the path. Stripping is | |
112 | # only done if one of the specified strings matches the left-hand part of | |
113 | # the path. The tag can be used to show relative paths in the file list. | |
114 | # If left blank the directory from which doxygen is run is used as the | |
1490ff4d MW |
115 | # path to strip. |
116 | ||
13f418b4 | 117 | STRIP_FROM_PATH = |
1490ff4d | 118 | |
13f418b4 MW |
119 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of |
120 | # the path mentioned in the documentation of a class, which tells | |
121 | # the reader which header file to include in order to use a class. | |
122 | # If left blank only the name of the header file containing the class | |
123 | # definition is used. Otherwise one should specify the include paths that | |
1490ff4d MW |
124 | # are normally passed to the compiler using the -I flag. |
125 | ||
13f418b4 | 126 | STRIP_FROM_INC_PATH = |
1490ff4d | 127 | |
13f418b4 MW |
128 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
129 | # (but less readable) file names. This can be useful is your file systems | |
1490ff4d MW |
130 | # doesn't support long names like on DOS, Mac, or CD-ROM. |
131 | ||
132 | SHORT_NAMES = NO | |
133 | ||
13f418b4 MW |
134 | # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
135 | # will interpret the first line (until the first dot) of a JavaDoc-style | |
136 | # comment as the brief description. If set to NO, the JavaDoc | |
137 | # comments will behave just like regular Qt-style comments | |
1490ff4d MW |
138 | # (thus requiring an explicit @brief command for a brief description.) |
139 | ||
140 | JAVADOC_AUTOBRIEF = YES | |
141 | ||
13f418b4 MW |
142 | # If the QT_AUTOBRIEF tag is set to YES then Doxygen will |
143 | # interpret the first line (until the first dot) of a Qt-style | |
144 | # comment as the brief description. If set to NO, the comments | |
145 | # will behave just like regular Qt-style comments (thus requiring | |
1490ff4d MW |
146 | # an explicit \brief command for a brief description.) |
147 | ||
148 | QT_AUTOBRIEF = NO | |
149 | ||
13f418b4 MW |
150 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen |
151 | # treat a multi-line C++ special comment block (i.e. a block of //! or /// | |
152 | # comments) as a brief description. This used to be the default behaviour. | |
153 | # The new default is to treat a multi-line C++ comment block as a detailed | |
1490ff4d MW |
154 | # description. Set this tag to YES if you prefer the old behaviour instead. |
155 | ||
b1e69188 | 156 | MULTILINE_CPP_IS_BRIEF = NO |
1490ff4d | 157 | |
13f418b4 MW |
158 | # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
159 | # member inherits the documentation from any documented member that it | |
1490ff4d MW |
160 | # re-implements. |
161 | ||
162 | INHERIT_DOCS = YES | |
163 | ||
13f418b4 MW |
164 | # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce |
165 | # a new page for each member. If set to NO, the documentation of a member will | |
1490ff4d MW |
166 | # be part of the file/class/namespace that contains it. |
167 | ||
168 | SEPARATE_MEMBER_PAGES = NO | |
169 | ||
13f418b4 | 170 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. |
1490ff4d MW |
171 | # Doxygen uses this value to replace tabs by spaces in code fragments. |
172 | ||
173 | TAB_SIZE = 4 | |
174 | ||
13f418b4 MW |
175 | # This tag can be used to specify a number of aliases that acts |
176 | # as commands in the documentation. An alias has the form "name=value". | |
177 | # For example adding "sideeffect=\par Side Effects:\n" will allow you to | |
178 | # put the command \sideeffect (or @sideeffect) in the documentation, which | |
179 | # will result in a user-defined paragraph with heading "Side Effects:". | |
1490ff4d MW |
180 | # You can put \n's in the value part of an alias to insert newlines. |
181 | ||
13f418b4 | 182 | ALIASES = |
1490ff4d | 183 | |
13f418b4 MW |
184 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C |
185 | # sources only. Doxygen will then generate output that is more tailored for C. | |
186 | # For instance, some of the names that are used will be different. The list | |
1490ff4d MW |
187 | # of all members will be omitted, etc. |
188 | ||
189 | OPTIMIZE_OUTPUT_FOR_C = NO | |
190 | ||
13f418b4 MW |
191 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java |
192 | # sources only. Doxygen will then generate output that is more tailored for | |
193 | # Java. For instance, namespaces will be presented as packages, qualified | |
1490ff4d MW |
194 | # scopes will look different, etc. |
195 | ||
196 | OPTIMIZE_OUTPUT_JAVA = NO | |
197 | ||
13f418b4 MW |
198 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran |
199 | # sources only. Doxygen will then generate output that is more tailored for | |
1490ff4d MW |
200 | # Fortran. |
201 | ||
202 | OPTIMIZE_FOR_FORTRAN = NO | |
203 | ||
13f418b4 MW |
204 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL |
205 | # sources. Doxygen will then generate output that is tailored for | |
1490ff4d MW |
206 | # VHDL. |
207 | ||
208 | OPTIMIZE_OUTPUT_VHDL = NO | |
209 | ||
13f418b4 MW |
210 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want |
211 | # to include (a tag file for) the STL sources as input, then you should | |
212 | # set this tag to YES in order to let doxygen match functions declarations and | |
213 | # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. | |
214 | # func(std::string) {}). This also make the inheritance and collaboration | |
1490ff4d MW |
215 | # diagrams that involve STL classes more complete and accurate. |
216 | ||
217 | BUILTIN_STL_SUPPORT = NO | |
218 | ||
219 | # If you use Microsoft's C++/CLI language, you should set this option to YES to | |
220 | # enable parsing support. | |
221 | ||
222 | CPP_CLI_SUPPORT = NO | |
223 | ||
13f418b4 MW |
224 | # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. |
225 | # Doxygen will parse them like normal C++ but will assume all classes use public | |
1490ff4d MW |
226 | # instead of private inheritance when no explicit protection keyword is present. |
227 | ||
228 | SIP_SUPPORT = NO | |
229 | ||
13f418b4 MW |
230 | # For Microsoft's IDL there are propget and propput attributes to indicate getter |
231 | # and setter methods for a property. Setting this option to YES (the default) | |
232 | # will make doxygen to replace the get and set methods by a property in the | |
233 | # documentation. This will only work if the methods are indeed getting or | |
234 | # setting a simple type. If this is not the case, or you want to show the | |
1490ff4d MW |
235 | # methods anyway, you should set this option to NO. |
236 | ||
237 | IDL_PROPERTY_SUPPORT = YES | |
238 | ||
13f418b4 MW |
239 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
240 | # tag is set to YES, then doxygen will reuse the documentation of the first | |
241 | # member in the group (if any) for the other members of the group. By default | |
1490ff4d MW |
242 | # all members of a group must be documented explicitly. |
243 | ||
244 | DISTRIBUTE_GROUP_DOC = NO | |
245 | ||
13f418b4 MW |
246 | # Set the SUBGROUPING tag to YES (the default) to allow class member groups of |
247 | # the same type (for instance a group of public functions) to be put as a | |
248 | # subgroup of that type (e.g. under the Public Functions section). Set it to | |
249 | # NO to prevent subgrouping. Alternatively, this can be done per class using | |
1490ff4d MW |
250 | # the \nosubgrouping command. |
251 | ||
252 | SUBGROUPING = YES | |
253 | ||
13f418b4 MW |
254 | # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum |
255 | # is documented as struct, union, or enum with the name of the typedef. So | |
256 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct | |
257 | # with name TypeT. When disabled the typedef will appear as a member of a file, | |
258 | # namespace, or class. And the struct will be named TypeS. This can typically | |
259 | # be useful for C code in case the coding convention dictates that all compound | |
1490ff4d MW |
260 | # types are typedef'ed and only the typedef is referenced, never the tag name. |
261 | ||
262 | TYPEDEF_HIDES_STRUCT = YES | |
263 | ||
b1e69188 MW |
264 | #--------------------------------------------------------------------------- |
265 | # Build related configuration options | |
266 | #--------------------------------------------------------------------------- | |
1490ff4d | 267 | |
13f418b4 MW |
268 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
269 | # documentation are documented, even if no documentation was available. | |
270 | # Private class members and static file members will be hidden unless | |
1490ff4d MW |
271 | # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
272 | ||
273 | EXTRACT_ALL = NO | |
274 | ||
13f418b4 | 275 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
1490ff4d MW |
276 | # will be included in the documentation. |
277 | ||
278 | EXTRACT_PRIVATE = NO | |
279 | ||
13f418b4 | 280 | # If the EXTRACT_STATIC tag is set to YES all static members of a file |
1490ff4d MW |
281 | # will be included in the documentation. |
282 | ||
283 | EXTRACT_STATIC = NO | |
284 | ||
13f418b4 MW |
285 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) |
286 | # defined locally in source files will be included in the documentation. | |
1490ff4d MW |
287 | # If set to NO only classes defined in header files are included. |
288 | ||
289 | EXTRACT_LOCAL_CLASSES = NO | |
290 | ||
13f418b4 MW |
291 | # This flag is only useful for Objective-C code. When set to YES local |
292 | # methods, which are defined in the implementation section but not in | |
293 | # the interface are included in the documentation. | |
1490ff4d MW |
294 | # If set to NO (the default) only methods in the interface are included. |
295 | ||
296 | EXTRACT_LOCAL_METHODS = NO | |
297 | ||
13f418b4 MW |
298 | # If this flag is set to YES, the members of anonymous namespaces will be |
299 | # extracted and appear in the documentation as a namespace called | |
300 | # 'anonymous_namespace{file}', where file will be replaced with the base | |
301 | # name of the file that contains the anonymous namespace. By default | |
1490ff4d MW |
302 | # anonymous namespace are hidden. |
303 | ||
304 | EXTRACT_ANON_NSPACES = NO | |
305 | ||
13f418b4 MW |
306 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
307 | # undocumented members of documented classes, files or namespaces. | |
308 | # If set to NO (the default) these members will be included in the | |
309 | # various overviews, but no documentation section is generated. | |
1490ff4d MW |
310 | # This option has no effect if EXTRACT_ALL is enabled. |
311 | ||
312 | HIDE_UNDOC_MEMBERS = NO | |
313 | ||
13f418b4 MW |
314 | # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
315 | # undocumented classes that are normally visible in the class hierarchy. | |
316 | # If set to NO (the default) these classes will be included in the various | |
1490ff4d MW |
317 | # overviews. This option has no effect if EXTRACT_ALL is enabled. |
318 | ||
319 | HIDE_UNDOC_CLASSES = NO | |
320 | ||
13f418b4 MW |
321 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all |
322 | # friend (class|struct|union) declarations. | |
323 | # If set to NO (the default) these declarations will be included in the | |
1490ff4d MW |
324 | # documentation. |
325 | ||
326 | HIDE_FRIEND_COMPOUNDS = NO | |
327 | ||
13f418b4 MW |
328 | # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any |
329 | # documentation blocks found inside the body of a function. | |
330 | # If set to NO (the default) these blocks will be appended to the | |
1490ff4d MW |
331 | # function's detailed documentation block. |
332 | ||
333 | HIDE_IN_BODY_DOCS = NO | |
334 | ||
13f418b4 MW |
335 | # The INTERNAL_DOCS tag determines if documentation |
336 | # that is typed after a \internal command is included. If the tag is set | |
337 | # to NO (the default) then the documentation will be excluded. | |
1490ff4d MW |
338 | # Set it to YES to include the internal documentation. |
339 | ||
340 | INTERNAL_DOCS = NO | |
341 | ||
13f418b4 MW |
342 | # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
343 | # file names in lower-case letters. If set to YES upper-case letters are also | |
344 | # allowed. This is useful if you have classes or files whose names only differ | |
345 | # in case and if your file system supports case sensitive file names. Windows | |
1490ff4d MW |
346 | # and Mac users are advised to set this option to NO. |
347 | ||
348 | CASE_SENSE_NAMES = YES | |
349 | ||
13f418b4 MW |
350 | # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
351 | # will show members with their full class and namespace scopes in the | |
1490ff4d MW |
352 | # documentation. If set to YES the scope will be hidden. |
353 | ||
354 | HIDE_SCOPE_NAMES = NO | |
355 | ||
13f418b4 MW |
356 | # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen |
357 | # will put a list of the files that are included by a file in the documentation | |
1490ff4d MW |
358 | # of that file. |
359 | ||
360 | SHOW_INCLUDE_FILES = NO | |
361 | ||
13f418b4 | 362 | # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] |
1490ff4d MW |
363 | # is inserted in the documentation for inline members. |
364 | ||
365 | INLINE_INFO = YES | |
366 | ||
13f418b4 MW |
367 | # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen |
368 | # will sort the (detailed) documentation of file and class members | |
369 | # alphabetically by member name. If set to NO the members will appear in | |
1490ff4d MW |
370 | # declaration order. |
371 | ||
372 | SORT_MEMBER_DOCS = NO | |
373 | ||
13f418b4 MW |
374 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the |
375 | # brief documentation of file, namespace and class members alphabetically | |
376 | # by member name. If set to NO (the default) the members will appear in | |
1490ff4d MW |
377 | # declaration order. |
378 | ||
379 | SORT_BRIEF_DOCS = NO | |
380 | ||
13f418b4 MW |
381 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the |
382 | # hierarchy of group names into alphabetical order. If set to NO (the default) | |
1490ff4d MW |
383 | # the group names will appear in their defined order. |
384 | ||
385 | SORT_GROUP_NAMES = NO | |
386 | ||
13f418b4 MW |
387 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be |
388 | # sorted by fully-qualified names, including namespaces. If set to | |
389 | # NO (the default), the class list will be sorted only by class name, | |
390 | # not including the namespace part. | |
1490ff4d | 391 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
13f418b4 | 392 | # Note: This option applies only to the class list, not to the |
1490ff4d MW |
393 | # alphabetical list. |
394 | ||
395 | SORT_BY_SCOPE_NAME = NO | |
396 | ||
13f418b4 MW |
397 | # The GENERATE_TODOLIST tag can be used to enable (YES) or |
398 | # disable (NO) the todo list. This list is created by putting \todo | |
1490ff4d MW |
399 | # commands in the documentation. |
400 | ||
401 | GENERATE_TODOLIST = NO | |
402 | ||
13f418b4 MW |
403 | # The GENERATE_TESTLIST tag can be used to enable (YES) or |
404 | # disable (NO) the test list. This list is created by putting \test | |
1490ff4d MW |
405 | # commands in the documentation. |
406 | ||
407 | GENERATE_TESTLIST = NO | |
408 | ||
13f418b4 MW |
409 | # The GENERATE_BUGLIST tag can be used to enable (YES) or |
410 | # disable (NO) the bug list. This list is created by putting \bug | |
1490ff4d MW |
411 | # commands in the documentation. |
412 | ||
413 | GENERATE_BUGLIST = NO | |
414 | ||
13f418b4 MW |
415 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or |
416 | # disable (NO) the deprecated list. This list is created by putting | |
1490ff4d MW |
417 | # \deprecated commands in the documentation. |
418 | ||
419 | GENERATE_DEPRECATEDLIST= NO | |
420 | ||
13f418b4 | 421 | # The ENABLED_SECTIONS tag can be used to enable conditional |
1490ff4d MW |
422 | # documentation sections, marked by \if sectionname ... \endif. |
423 | ||
13f418b4 | 424 | ENABLED_SECTIONS = |
1490ff4d | 425 | |
13f418b4 MW |
426 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines |
427 | # the initial value of a variable or define consists of for it to appear in | |
428 | # the documentation. If the initializer consists of more lines than specified | |
429 | # here it will be hidden. Use a value of 0 to hide initializers completely. | |
430 | # The appearance of the initializer of individual variables and defines in the | |
431 | # documentation can be controlled using \showinitializer or \hideinitializer | |
1490ff4d MW |
432 | # command in the documentation regardless of this setting. |
433 | ||
434 | MAX_INITIALIZER_LINES = 30 | |
435 | ||
13f418b4 MW |
436 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated |
437 | # at the bottom of the documentation of classes and structs. If set to YES the | |
1490ff4d MW |
438 | # list will mention the files that were used to generate the documentation. |
439 | ||
440 | SHOW_USED_FILES = NO | |
441 | ||
13f418b4 MW |
442 | # If the sources in your project are distributed over multiple directories |
443 | # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy | |
1490ff4d MW |
444 | # in the documentation. The default is NO. |
445 | ||
446 | SHOW_DIRECTORIES = YES | |
447 | ||
448 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. | |
13f418b4 | 449 | # This will remove the Files entry from the Quick Index and from the |
1490ff4d MW |
450 | # Folder Tree View (if specified). The default is YES. |
451 | ||
452 | SHOW_FILES = NO | |
453 | ||
13f418b4 | 454 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the |
1490ff4d MW |
455 | # Namespaces page. This will remove the Namespaces entry from the Quick Index |
456 | # and from the Folder Tree View (if specified). The default is YES. | |
457 | ||
458 | SHOW_NAMESPACES = YES | |
459 | ||
13f418b4 MW |
460 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that |
461 | # doxygen should invoke to get the current version for each file (typically from | |
462 | # the version control system). Doxygen will invoke the program by executing (via | |
463 | # popen()) the command <command> <input-file>, where <command> is the value of | |
464 | # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file | |
465 | # provided by doxygen. Whatever the program writes to standard output | |
1490ff4d MW |
466 | # is used as the file version. See the manual for examples. |
467 | ||
13f418b4 | 468 | FILE_VERSION_FILTER = |
1490ff4d | 469 | |
b1e69188 MW |
470 | #--------------------------------------------------------------------------- |
471 | # configuration options related to warning and progress messages | |
472 | #--------------------------------------------------------------------------- | |
1490ff4d | 473 | |
13f418b4 | 474 | # The QUIET tag can be used to turn on/off the messages that are generated |
1490ff4d MW |
475 | # by doxygen. Possible values are YES and NO. If left blank NO is used. |
476 | ||
477 | QUIET = NO | |
478 | ||
13f418b4 MW |
479 | # The WARNINGS tag can be used to turn on/off the warning messages that are |
480 | # generated by doxygen. Possible values are YES and NO. If left blank | |
1490ff4d MW |
481 | # NO is used. |
482 | ||
483 | WARNINGS = YES | |
484 | ||
13f418b4 MW |
485 | # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings |
486 | # for undocumented members. If EXTRACT_ALL is set to YES then this flag will | |
1490ff4d MW |
487 | # automatically be disabled. |
488 | ||
489 | WARN_IF_UNDOCUMENTED = NO | |
490 | ||
13f418b4 MW |
491 | # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for |
492 | # potential errors in the documentation, such as not documenting some | |
493 | # parameters in a documented function, or documenting parameters that | |
1490ff4d MW |
494 | # don't exist or using markup commands wrongly. |
495 | ||
496 | WARN_IF_DOC_ERROR = YES | |
497 | ||
13f418b4 MW |
498 | # This WARN_NO_PARAMDOC option can be abled to get warnings for |
499 | # functions that are documented, but have no documentation for their parameters | |
500 | # or return value. If set to NO (the default) doxygen will only warn about | |
501 | # wrong or incomplete parameter documentation, but not about the absence of | |
1490ff4d MW |
502 | # documentation. |
503 | ||
504 | WARN_NO_PARAMDOC = NO | |
505 | ||
13f418b4 MW |
506 | # The WARN_FORMAT tag determines the format of the warning messages that |
507 | # doxygen can produce. The string should contain the $file, $line, and $text | |
508 | # tags, which will be replaced by the file and line number from which the | |
509 | # warning originated and the warning text. Optionally the format may contain | |
510 | # $version, which will be replaced by the version of the file (if it could | |
1490ff4d MW |
511 | # be obtained via FILE_VERSION_FILTER) |
512 | ||
513 | WARN_FORMAT = "$file:$line: $text" | |
514 | ||
13f418b4 MW |
515 | # The WARN_LOGFILE tag can be used to specify a file to which warning |
516 | # and error messages should be written. If left blank the output is written | |
1490ff4d MW |
517 | # to stderr. |
518 | ||
13f418b4 | 519 | WARN_LOGFILE = |
1490ff4d | 520 | |
b1e69188 MW |
521 | #--------------------------------------------------------------------------- |
522 | # configuration options related to the input files | |
523 | #--------------------------------------------------------------------------- | |
1490ff4d | 524 | |
13f418b4 MW |
525 | # The INPUT tag can be used to specify the files and/or directories that contain |
526 | # documented source files. You may enter file names like "myfile.cpp" or | |
527 | # directories like "/usr/src/myproject". Separate the files or directories | |
1490ff4d MW |
528 | # with spaces. |
529 | ||
c33d4f29 | 530 | INPUT = @SRC_DIR@/src/libstrongswan \ |
83218f0d | 531 | @SRC_DIR@/src/libhydra \ |
bd3f8ea3 | 532 | @SRC_DIR@/src/libcharon \ |
c33d4f29 | 533 | @SRC_DIR@/src/libsimaka \ |
0f82a470 | 534 | @SRC_DIR@/src/libtls \ |
f0f94e2c | 535 | @SRC_DIR@/src/libradius \ |
abb89a97 TB |
536 | @SRC_DIR@/src/libtnccs \ |
537 | @SRC_DIR@/src/libtncif \ | |
c33d4f29 TB |
538 | @SRC_DIR@/src/libfast \ |
539 | @SRC_DIR@/src/manager | |
1490ff4d | 540 | |
13f418b4 MW |
541 | # This tag can be used to specify the character encoding of the source files |
542 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is | |
543 | # also the default input encoding. Doxygen uses libiconv (or the iconv built | |
544 | # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for | |
1490ff4d MW |
545 | # the list of possible encodings. |
546 | ||
547 | INPUT_ENCODING = UTF-8 | |
548 | ||
13f418b4 MW |
549 | # If the value of the INPUT tag contains directories, you can use the |
550 | # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | |
551 | # and *.h) to filter out the source-files in the directories. If left | |
552 | # blank the following patterns are tested: | |
553 | # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx | |
1490ff4d MW |
554 | # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 |
555 | ||
556 | FILE_PATTERNS = *.h | |
557 | ||
13f418b4 MW |
558 | # The RECURSIVE tag can be used to turn specify whether or not subdirectories |
559 | # should be searched for input files as well. Possible values are YES and NO. | |
1490ff4d MW |
560 | # If left blank NO is used. |
561 | ||
562 | RECURSIVE = YES | |
563 | ||
13f418b4 MW |
564 | # The EXCLUDE tag can be used to specify files and/or directories that should |
565 | # excluded from the INPUT source files. This way you can easily exclude a | |
1490ff4d MW |
566 | # subdirectory from a directory tree whose root is specified with the INPUT tag. |
567 | ||
13f418b4 | 568 | EXCLUDE = |
1490ff4d | 569 | |
13f418b4 MW |
570 | # The EXCLUDE_SYMLINKS tag can be used select whether or not files or |
571 | # directories that are symbolic links (a Unix filesystem feature) are excluded | |
1490ff4d MW |
572 | # from the input. |
573 | ||
574 | EXCLUDE_SYMLINKS = NO | |
575 | ||
13f418b4 MW |
576 | # If the value of the INPUT tag contains directories, you can use the |
577 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude | |
578 | # certain files from those directories. Note that the wildcards are matched | |
579 | # against the file with absolute path, so to exclude all test directories | |
1490ff4d MW |
580 | # for example use the pattern */test/* |
581 | ||
edb82ab8 | 582 | EXCLUDE_PATTERNS = */.git/* |
1490ff4d | 583 | |
13f418b4 MW |
584 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
585 | # (namespaces, classes, functions, etc.) that should be excluded from the | |
586 | # output. The symbol name can be a fully qualified name, a word, or if the | |
587 | # wildcard * is used, a substring. Examples: ANamespace, AClass, | |
1490ff4d MW |
588 | # AClass::ANamespace, ANamespace::*Test |
589 | ||
13f418b4 | 590 | EXCLUDE_SYMBOLS = |
1490ff4d | 591 | |
13f418b4 MW |
592 | # The EXAMPLE_PATH tag can be used to specify one or more files or |
593 | # directories that contain example code fragments that are included (see | |
1490ff4d MW |
594 | # the \include command). |
595 | ||
13f418b4 | 596 | EXAMPLE_PATH = |
1490ff4d | 597 | |
13f418b4 MW |
598 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the |
599 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | |
600 | # and *.h) to filter out the source-files in the directories. If left | |
1490ff4d MW |
601 | # blank all files are included. |
602 | ||
13f418b4 | 603 | EXAMPLE_PATTERNS = |
1490ff4d | 604 | |
13f418b4 MW |
605 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
606 | # searched for input files to be used with the \include or \dontinclude | |
607 | # commands irrespective of the value of the RECURSIVE tag. | |
1490ff4d MW |
608 | # Possible values are YES and NO. If left blank NO is used. |
609 | ||
610 | EXAMPLE_RECURSIVE = NO | |
611 | ||
13f418b4 MW |
612 | # The IMAGE_PATH tag can be used to specify one or more files or |
613 | # directories that contain image that are included in the documentation (see | |
1490ff4d MW |
614 | # the \image command). |
615 | ||
13f418b4 | 616 | IMAGE_PATH = |
1490ff4d | 617 | |
13f418b4 MW |
618 | # The INPUT_FILTER tag can be used to specify a program that doxygen should |
619 | # invoke to filter for each input file. Doxygen will invoke the filter program | |
620 | # by executing (via popen()) the command <filter> <input-file>, where <filter> | |
621 | # is the value of the INPUT_FILTER tag, and <input-file> is the name of an | |
622 | # input file. Doxygen will then use the output that the filter program writes | |
623 | # to standard output. If FILTER_PATTERNS is specified, this tag will be | |
1490ff4d MW |
624 | # ignored. |
625 | ||
13f418b4 | 626 | INPUT_FILTER = |
1490ff4d | 627 | |
13f418b4 MW |
628 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
629 | # basis. Doxygen will compare the file name with each pattern and apply the | |
630 | # filter if there is a match. The filters are a list of the form: | |
631 | # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further | |
632 | # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER | |
1490ff4d MW |
633 | # is applied to all files. |
634 | ||
13f418b4 | 635 | FILTER_PATTERNS = |
1490ff4d | 636 | |
13f418b4 MW |
637 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
638 | # INPUT_FILTER) will be used to filter the input files when producing source | |
1490ff4d MW |
639 | # files to browse (i.e. when SOURCE_BROWSER is set to YES). |
640 | ||
641 | FILTER_SOURCE_FILES = NO | |
642 | ||
b1e69188 MW |
643 | #--------------------------------------------------------------------------- |
644 | # configuration options related to source browsing | |
645 | #--------------------------------------------------------------------------- | |
1490ff4d | 646 | |
13f418b4 MW |
647 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will |
648 | # be generated. Documented entities will be cross-referenced with these sources. | |
649 | # Note: To get rid of all source code in the generated output, make sure also | |
1490ff4d MW |
650 | # VERBATIM_HEADERS is set to NO. |
651 | ||
652 | SOURCE_BROWSER = NO | |
653 | ||
13f418b4 | 654 | # Setting the INLINE_SOURCES tag to YES will include the body |
1490ff4d MW |
655 | # of functions and classes directly in the documentation. |
656 | ||
657 | INLINE_SOURCES = NO | |
658 | ||
13f418b4 MW |
659 | # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct |
660 | # doxygen to hide any special comment blocks from generated source code | |
1490ff4d MW |
661 | # fragments. Normal C and C++ comments will always remain visible. |
662 | ||
663 | STRIP_CODE_COMMENTS = NO | |
664 | ||
13f418b4 MW |
665 | # If the REFERENCED_BY_RELATION tag is set to YES |
666 | # then for each documented function all documented | |
1490ff4d MW |
667 | # functions referencing it will be listed. |
668 | ||
b1e69188 | 669 | REFERENCED_BY_RELATION = NO |
1490ff4d | 670 | |
13f418b4 MW |
671 | # If the REFERENCES_RELATION tag is set to YES |
672 | # then for each documented function all documented entities | |
1490ff4d MW |
673 | # called/used by that function will be listed. |
674 | ||
675 | REFERENCES_RELATION = NO | |
676 | ||
677 | # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) | |
678 | # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from | |
679 | # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will | |
680 | # link to the source code. Otherwise they will link to the documentstion. | |
681 | ||
682 | REFERENCES_LINK_SOURCE = YES | |
683 | ||
13f418b4 MW |
684 | # If the USE_HTAGS tag is set to YES then the references to source code |
685 | # will point to the HTML generated by the htags(1) tool instead of doxygen | |
686 | # built-in source browser. The htags tool is part of GNU's global source | |
687 | # tagging system (see http://www.gnu.org/software/global/global.html). You | |
1490ff4d MW |
688 | # will need version 4.8.6 or higher. |
689 | ||
690 | USE_HTAGS = NO | |
691 | ||
13f418b4 MW |
692 | # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
693 | # will generate a verbatim copy of the header file for each class for | |
1490ff4d MW |
694 | # which an include is specified. Set to NO to disable this. |
695 | ||
696 | VERBATIM_HEADERS = YES | |
697 | ||
b1e69188 MW |
698 | #--------------------------------------------------------------------------- |
699 | # configuration options related to the alphabetical class index | |
700 | #--------------------------------------------------------------------------- | |
1490ff4d | 701 | |
13f418b4 MW |
702 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
703 | # of all compounds will be generated. Enable this if the project | |
1490ff4d MW |
704 | # contains a lot of classes, structs, unions or interfaces. |
705 | ||
edb82ab8 | 706 | ALPHABETICAL_INDEX = YES |
1490ff4d | 707 | |
13f418b4 MW |
708 | # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then |
709 | # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns | |
1490ff4d MW |
710 | # in which this list will be split (can be a number in the range [1..20]) |
711 | ||
712 | COLS_IN_ALPHA_INDEX = 5 | |
713 | ||
13f418b4 MW |
714 | # In case all classes in a project start with a common prefix, all |
715 | # classes will be put under the same header in the alphabetical index. | |
716 | # The IGNORE_PREFIX tag can be used to specify one or more prefixes that | |
1490ff4d MW |
717 | # should be ignored while generating the index headers. |
718 | ||
13f418b4 | 719 | IGNORE_PREFIX = |
1490ff4d | 720 | |
b1e69188 MW |
721 | #--------------------------------------------------------------------------- |
722 | # configuration options related to the HTML output | |
723 | #--------------------------------------------------------------------------- | |
1490ff4d | 724 | |
13f418b4 | 725 | # If the GENERATE_HTML tag is set to YES (the default) Doxygen will |
1490ff4d MW |
726 | # generate HTML output. |
727 | ||
728 | GENERATE_HTML = YES | |
729 | ||
13f418b4 MW |
730 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. |
731 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
1490ff4d MW |
732 | # put in front of it. If left blank `html' will be used as the default path. |
733 | ||
734 | HTML_OUTPUT = . | |
735 | ||
13f418b4 MW |
736 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for |
737 | # each generated HTML page (for example: .htm,.php,.asp). If it is left blank | |
1490ff4d MW |
738 | # doxygen will generate files with .html extension. |
739 | ||
740 | HTML_FILE_EXTENSION = .html | |
741 | ||
13f418b4 MW |
742 | # The HTML_HEADER tag can be used to specify a personal HTML header for |
743 | # each generated HTML page. If it is left blank doxygen will generate a | |
1490ff4d MW |
744 | # standard header. |
745 | ||
13f418b4 | 746 | HTML_HEADER = |
1490ff4d | 747 | |
13f418b4 MW |
748 | # The HTML_FOOTER tag can be used to specify a personal HTML footer for |
749 | # each generated HTML page. If it is left blank doxygen will generate a | |
1490ff4d MW |
750 | # standard footer. |
751 | ||
13f418b4 | 752 | HTML_FOOTER = |
1490ff4d | 753 | |
13f418b4 MW |
754 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading |
755 | # style sheet that is used by each HTML page. It can be used to | |
756 | # fine-tune the look of the HTML output. If the tag is left blank doxygen | |
757 | # will generate a default style sheet. Note that doxygen will try to copy | |
758 | # the style sheet file to the HTML output directory, so don't put your own | |
1490ff4d MW |
759 | # stylesheet in the HTML output directory as well, or it will be erased! |
760 | ||
13f418b4 | 761 | HTML_STYLESHEET = |
1490ff4d | 762 | |
13f418b4 MW |
763 | # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, |
764 | # files or namespaces will be aligned in HTML using tables. If set to | |
1490ff4d MW |
765 | # NO a bullet list will be used. |
766 | ||
767 | HTML_ALIGN_MEMBERS = YES | |
768 | ||
13f418b4 MW |
769 | # If the GENERATE_HTMLHELP tag is set to YES, additional index files |
770 | # will be generated that can be used as input for tools like the | |
771 | # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) | |
1490ff4d MW |
772 | # of the generated HTML documentation. |
773 | ||
774 | GENERATE_HTMLHELP = NO | |
775 | ||
13f418b4 MW |
776 | # If the GENERATE_DOCSET tag is set to YES, additional index files |
777 | # will be generated that can be used as input for Apple's Xcode 3 | |
778 | # integrated development environment, introduced with OSX 10.5 (Leopard). | |
779 | # To create a documentation set, doxygen will generate a Makefile in the | |
780 | # HTML output directory. Running make will produce the docset in that | |
781 | # directory and running "make install" will install the docset in | |
782 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find | |
1490ff4d MW |
783 | # it at startup. |
784 | ||
785 | GENERATE_DOCSET = NO | |
786 | ||
13f418b4 MW |
787 | # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the |
788 | # feed. A documentation feed provides an umbrella under which multiple | |
789 | # documentation sets from a single provider (such as a company or product suite) | |
1490ff4d MW |
790 | # can be grouped. |
791 | ||
792 | DOCSET_FEEDNAME = "Doxygen generated docs" | |
793 | ||
13f418b4 MW |
794 | # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that |
795 | # should uniquely identify the documentation set bundle. This should be a | |
796 | # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen | |
1490ff4d MW |
797 | # will append .docset to the name. |
798 | ||
799 | DOCSET_BUNDLE_ID = org.doxygen.Project | |
800 | ||
13f418b4 MW |
801 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
802 | # documentation will contain sections that can be hidden and shown after the | |
803 | # page has loaded. For this to work a browser that supports | |
804 | # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox | |
1490ff4d MW |
805 | # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). |
806 | ||
807 | HTML_DYNAMIC_SECTIONS = NO | |
808 | ||
13f418b4 MW |
809 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can |
810 | # be used to specify the file name of the resulting .chm file. You | |
811 | # can add a path in front of the file if the result should not be | |
1490ff4d MW |
812 | # written to the html output directory. |
813 | ||
13f418b4 | 814 | CHM_FILE = |
1490ff4d | 815 | |
13f418b4 MW |
816 | # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can |
817 | # be used to specify the location (absolute path including file name) of | |
818 | # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run | |
1490ff4d MW |
819 | # the HTML help compiler on the generated index.hhp. |
820 | ||
13f418b4 | 821 | HHC_LOCATION = |
1490ff4d | 822 | |
13f418b4 MW |
823 | # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag |
824 | # controls if a separate .chi index file is generated (YES) or that | |
1490ff4d MW |
825 | # it should be included in the master .chm file (NO). |
826 | ||
827 | GENERATE_CHI = NO | |
828 | ||
829 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING | |
830 | # is used to encode HtmlHelp index (hhk), content (hhc) and project file | |
831 | # content. | |
832 | ||
13f418b4 | 833 | CHM_INDEX_ENCODING = |
1490ff4d | 834 | |
13f418b4 MW |
835 | # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag |
836 | # controls whether a binary table of contents is generated (YES) or a | |
1490ff4d MW |
837 | # normal table of contents (NO) in the .chm file. |
838 | ||
839 | BINARY_TOC = NO | |
840 | ||
13f418b4 | 841 | # The TOC_EXPAND flag can be set to YES to add extra items for group members |
1490ff4d MW |
842 | # to the contents of the HTML help documentation and to the tree view. |
843 | ||
844 | TOC_EXPAND = NO | |
845 | ||
13f418b4 MW |
846 | # The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
847 | # top of each HTML page. The value NO (the default) enables the index and | |
1490ff4d MW |
848 | # the value YES disables it. |
849 | ||
edb82ab8 | 850 | DISABLE_INDEX = NO |
1490ff4d | 851 | |
13f418b4 | 852 | # This tag can be used to set the number of enum values (range [1..20]) |
1490ff4d MW |
853 | # that doxygen will group on one line in the generated HTML documentation. |
854 | ||
855 | ENUM_VALUES_PER_LINE = 1 | |
856 | ||
857 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index | |
858 | # structure should be generated to display hierarchical information. | |
859 | # If the tag value is set to FRAME, a side panel will be generated | |
13f418b4 MW |
860 | # containing a tree-like index structure (just like the one that |
861 | # is generated for HTML Help). For this to work a browser that supports | |
862 | # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, | |
863 | # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are | |
864 | # probably better off using the HTML help feature. Other possible values | |
1490ff4d MW |
865 | # for this tag are: HIERARCHIES, which will generate the Groups, Directories, |
866 | # and Class Hiererachy pages using a tree view instead of an ordered list; | |
867 | # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which | |
868 | # disables this behavior completely. For backwards compatibility with previous | |
869 | # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE | |
870 | # respectively. | |
871 | ||
872 | GENERATE_TREEVIEW = YES | |
873 | ||
13f418b4 MW |
874 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
875 | # used to set the initial width (in pixels) of the frame in which the tree | |
1490ff4d MW |
876 | # is shown. |
877 | ||
878 | TREEVIEW_WIDTH = 250 | |
879 | ||
13f418b4 MW |
880 | # Use this tag to change the font size of Latex formulas included |
881 | # as images in the HTML documentation. The default is 10. Note that | |
882 | # when you change the font size after a successful doxygen run you need | |
883 | # to manually remove any form_*.png images from the HTML output directory | |
1490ff4d MW |
884 | # to force them to be regenerated. |
885 | ||
886 | FORMULA_FONTSIZE = 10 | |
887 | ||
b1e69188 MW |
888 | #--------------------------------------------------------------------------- |
889 | # configuration options related to the LaTeX output | |
890 | #--------------------------------------------------------------------------- | |
1490ff4d | 891 | |
13f418b4 | 892 | # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will |
1490ff4d MW |
893 | # generate Latex output. |
894 | ||
895 | GENERATE_LATEX = NO | |
896 | ||
13f418b4 MW |
897 | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. |
898 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
1490ff4d MW |
899 | # put in front of it. If left blank `latex' will be used as the default path. |
900 | ||
901 | LATEX_OUTPUT = latex | |
902 | ||
13f418b4 | 903 | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
1490ff4d MW |
904 | # invoked. If left blank `latex' will be used as the default command name. |
905 | ||
906 | LATEX_CMD_NAME = latex | |
907 | ||
13f418b4 MW |
908 | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to |
909 | # generate index for LaTeX. If left blank `makeindex' will be used as the | |
1490ff4d MW |
910 | # default command name. |
911 | ||
912 | MAKEINDEX_CMD_NAME = makeindex | |
913 | ||
13f418b4 MW |
914 | # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact |
915 | # LaTeX documents. This may be useful for small projects and may help to | |
1490ff4d MW |
916 | # save some trees in general. |
917 | ||
918 | COMPACT_LATEX = NO | |
919 | ||
13f418b4 MW |
920 | # The PAPER_TYPE tag can be used to set the paper type that is used |
921 | # by the printer. Possible values are: a4, a4wide, letter, legal and | |
1490ff4d MW |
922 | # executive. If left blank a4wide will be used. |
923 | ||
924 | PAPER_TYPE = a4wide | |
925 | ||
13f418b4 | 926 | # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX |
1490ff4d MW |
927 | # packages that should be included in the LaTeX output. |
928 | ||
13f418b4 | 929 | EXTRA_PACKAGES = |
1490ff4d | 930 | |
13f418b4 MW |
931 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for |
932 | # the generated latex document. The header should contain everything until | |
933 | # the first chapter. If it is left blank doxygen will generate a | |
1490ff4d MW |
934 | # standard header. Notice: only use this tag if you know what you are doing! |
935 | ||
13f418b4 | 936 | LATEX_HEADER = |
1490ff4d | 937 | |
13f418b4 MW |
938 | # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
939 | # is prepared for conversion to pdf (using ps2pdf). The pdf file will | |
940 | # contain links (just like the HTML output) instead of page references | |
1490ff4d MW |
941 | # This makes the output suitable for online browsing using a pdf viewer. |
942 | ||
943 | PDF_HYPERLINKS = NO | |
944 | ||
13f418b4 MW |
945 | # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of |
946 | # plain latex in the generated Makefile. Set this option to YES to get a | |
1490ff4d MW |
947 | # higher quality PDF documentation. |
948 | ||
949 | USE_PDFLATEX = NO | |
950 | ||
13f418b4 MW |
951 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. |
952 | # command to the generated LaTeX files. This will instruct LaTeX to keep | |
953 | # running if errors occur, instead of asking the user for help. | |
1490ff4d MW |
954 | # This option is also used when generating formulas in HTML. |
955 | ||
956 | LATEX_BATCHMODE = NO | |
957 | ||
13f418b4 MW |
958 | # If LATEX_HIDE_INDICES is set to YES then doxygen will not |
959 | # include the index chapters (such as File Index, Compound Index, etc.) | |
1490ff4d MW |
960 | # in the output. |
961 | ||
962 | LATEX_HIDE_INDICES = NO | |
963 | ||
b1e69188 MW |
964 | #--------------------------------------------------------------------------- |
965 | # configuration options related to the RTF output | |
966 | #--------------------------------------------------------------------------- | |
1490ff4d | 967 | |
13f418b4 MW |
968 | # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output |
969 | # The RTF output is optimized for Word 97 and may not look very pretty with | |
1490ff4d MW |
970 | # other RTF readers or editors. |
971 | ||
972 | GENERATE_RTF = NO | |
973 | ||
13f418b4 MW |
974 | # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. |
975 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
1490ff4d MW |
976 | # put in front of it. If left blank `rtf' will be used as the default path. |
977 | ||
978 | RTF_OUTPUT = rtf | |
979 | ||
13f418b4 MW |
980 | # If the COMPACT_RTF tag is set to YES Doxygen generates more compact |
981 | # RTF documents. This may be useful for small projects and may help to | |
1490ff4d MW |
982 | # save some trees in general. |
983 | ||
984 | COMPACT_RTF = NO | |
985 | ||
13f418b4 MW |
986 | # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated |
987 | # will contain hyperlink fields. The RTF file will | |
988 | # contain links (just like the HTML output) instead of page references. | |
989 | # This makes the output suitable for online browsing using WORD or other | |
990 | # programs which support those fields. | |
1490ff4d MW |
991 | # Note: wordpad (write) and others do not support links. |
992 | ||
993 | RTF_HYPERLINKS = NO | |
994 | ||
13f418b4 MW |
995 | # Load stylesheet definitions from file. Syntax is similar to doxygen's |
996 | # config file, i.e. a series of assignments. You only have to provide | |
1490ff4d MW |
997 | # replacements, missing definitions are set to their default value. |
998 | ||
13f418b4 | 999 | RTF_STYLESHEET_FILE = |
1490ff4d | 1000 | |
13f418b4 | 1001 | # Set optional variables used in the generation of an rtf document. |
1490ff4d MW |
1002 | # Syntax is similar to doxygen's config file. |
1003 | ||
13f418b4 | 1004 | RTF_EXTENSIONS_FILE = |
1490ff4d | 1005 | |
b1e69188 MW |
1006 | #--------------------------------------------------------------------------- |
1007 | # configuration options related to the man page output | |
1008 | #--------------------------------------------------------------------------- | |
1490ff4d | 1009 | |
13f418b4 | 1010 | # If the GENERATE_MAN tag is set to YES (the default) Doxygen will |
1490ff4d MW |
1011 | # generate man pages |
1012 | ||
1013 | GENERATE_MAN = NO | |
1014 | ||
13f418b4 MW |
1015 | # The MAN_OUTPUT tag is used to specify where the man pages will be put. |
1016 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
1490ff4d MW |
1017 | # put in front of it. If left blank `man' will be used as the default path. |
1018 | ||
1019 | MAN_OUTPUT = man | |
1020 | ||
13f418b4 | 1021 | # The MAN_EXTENSION tag determines the extension that is added to |
1490ff4d MW |
1022 | # the generated man pages (default is the subroutine's section .3) |
1023 | ||
1024 | MAN_EXTENSION = .3 | |
1025 | ||
13f418b4 MW |
1026 | # If the MAN_LINKS tag is set to YES and Doxygen generates man output, |
1027 | # then it will generate one additional man file for each entity | |
1028 | # documented in the real man page(s). These additional files | |
1029 | # only source the real man page, but without them the man command | |
1490ff4d MW |
1030 | # would be unable to find the correct page. The default is NO. |
1031 | ||
1032 | MAN_LINKS = YES | |
1033 | ||
b1e69188 MW |
1034 | #--------------------------------------------------------------------------- |
1035 | # configuration options related to the XML output | |
1036 | #--------------------------------------------------------------------------- | |
1490ff4d | 1037 | |
13f418b4 MW |
1038 | # If the GENERATE_XML tag is set to YES Doxygen will |
1039 | # generate an XML file that captures the structure of | |
1490ff4d MW |
1040 | # the code including all documentation. |
1041 | ||
1042 | GENERATE_XML = NO | |
1043 | ||
13f418b4 MW |
1044 | # The XML_OUTPUT tag is used to specify where the XML pages will be put. |
1045 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
1490ff4d MW |
1046 | # put in front of it. If left blank `xml' will be used as the default path. |
1047 | ||
1048 | XML_OUTPUT = xml | |
1049 | ||
13f418b4 MW |
1050 | # The XML_SCHEMA tag can be used to specify an XML schema, |
1051 | # which can be used by a validating XML parser to check the | |
1490ff4d MW |
1052 | # syntax of the XML files. |
1053 | ||
13f418b4 | 1054 | XML_SCHEMA = |
1490ff4d | 1055 | |
13f418b4 MW |
1056 | # The XML_DTD tag can be used to specify an XML DTD, |
1057 | # which can be used by a validating XML parser to check the | |
1490ff4d MW |
1058 | # syntax of the XML files. |
1059 | ||
13f418b4 | 1060 | XML_DTD = |
1490ff4d | 1061 | |
13f418b4 MW |
1062 | # If the XML_PROGRAMLISTING tag is set to YES Doxygen will |
1063 | # dump the program listings (including syntax highlighting | |
1064 | # and cross-referencing information) to the XML output. Note that | |
1490ff4d MW |
1065 | # enabling this will significantly increase the size of the XML output. |
1066 | ||
1067 | XML_PROGRAMLISTING = YES | |
1068 | ||
b1e69188 MW |
1069 | #--------------------------------------------------------------------------- |
1070 | # configuration options for the AutoGen Definitions output | |
1071 | #--------------------------------------------------------------------------- | |
1490ff4d | 1072 | |
13f418b4 MW |
1073 | # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will |
1074 | # generate an AutoGen Definitions (see autogen.sf.net) file | |
1075 | # that captures the structure of the code including all | |
1076 | # documentation. Note that this feature is still experimental | |
1490ff4d MW |
1077 | # and incomplete at the moment. |
1078 | ||
1079 | GENERATE_AUTOGEN_DEF = NO | |
1080 | ||
b1e69188 MW |
1081 | #--------------------------------------------------------------------------- |
1082 | # configuration options related to the Perl module output | |
1083 | #--------------------------------------------------------------------------- | |
1490ff4d | 1084 | |
13f418b4 MW |
1085 | # If the GENERATE_PERLMOD tag is set to YES Doxygen will |
1086 | # generate a Perl module file that captures the structure of | |
1087 | # the code including all documentation. Note that this | |
1088 | # feature is still experimental and incomplete at the | |
1490ff4d MW |
1089 | # moment. |
1090 | ||
1091 | GENERATE_PERLMOD = NO | |
1092 | ||
13f418b4 MW |
1093 | # If the PERLMOD_LATEX tag is set to YES Doxygen will generate |
1094 | # the necessary Makefile rules, Perl scripts and LaTeX code to be able | |
1490ff4d MW |
1095 | # to generate PDF and DVI output from the Perl module output. |
1096 | ||
1097 | PERLMOD_LATEX = NO | |
1098 | ||
13f418b4 MW |
1099 | # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be |
1100 | # nicely formatted so it can be parsed by a human reader. This is useful | |
1101 | # if you want to understand what is going on. On the other hand, if this | |
1102 | # tag is set to NO the size of the Perl module output will be much smaller | |
1490ff4d MW |
1103 | # and Perl will parse it just the same. |
1104 | ||
1105 | PERLMOD_PRETTY = YES | |
1106 | ||
13f418b4 MW |
1107 | # The names of the make variables in the generated doxyrules.make file |
1108 | # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. | |
1109 | # This is useful so different doxyrules.make files included by the same | |
1490ff4d MW |
1110 | # Makefile don't overwrite each other's variables. |
1111 | ||
13f418b4 | 1112 | PERLMOD_MAKEVAR_PREFIX = |
1490ff4d | 1113 | |
b1e69188 | 1114 | #--------------------------------------------------------------------------- |
13f418b4 | 1115 | # Configuration options related to the preprocessor |
b1e69188 | 1116 | #--------------------------------------------------------------------------- |
1490ff4d | 1117 | |
13f418b4 MW |
1118 | # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will |
1119 | # evaluate all C-preprocessor directives found in the sources and include | |
1490ff4d MW |
1120 | # files. |
1121 | ||
1122 | ENABLE_PREPROCESSING = YES | |
1123 | ||
13f418b4 MW |
1124 | # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro |
1125 | # names in the source code. If set to NO (the default) only conditional | |
1126 | # compilation will be performed. Macro expansion can be done in a controlled | |
1490ff4d MW |
1127 | # way by setting EXPAND_ONLY_PREDEF to YES. |
1128 | ||
1129 | MACRO_EXPANSION = YES | |
1130 | ||
13f418b4 MW |
1131 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
1132 | # then the macro expansion is limited to the macros specified with the | |
1490ff4d MW |
1133 | # PREDEFINED and EXPAND_AS_DEFINED tags. |
1134 | ||
1135 | EXPAND_ONLY_PREDEF = NO | |
1136 | ||
13f418b4 | 1137 | # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
1490ff4d MW |
1138 | # in the INCLUDE_PATH (see below) will be search if a #include is found. |
1139 | ||
1140 | SEARCH_INCLUDES = YES | |
1141 | ||
13f418b4 MW |
1142 | # The INCLUDE_PATH tag can be used to specify one or more directories that |
1143 | # contain include files that are not input files but should be processed by | |
1490ff4d MW |
1144 | # the preprocessor. |
1145 | ||
13f418b4 | 1146 | INCLUDE_PATH = |
1490ff4d | 1147 | |
13f418b4 MW |
1148 | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
1149 | # patterns (like *.h and *.hpp) to filter out the header-files in the | |
1150 | # directories. If left blank, the patterns specified with FILE_PATTERNS will | |
1490ff4d MW |
1151 | # be used. |
1152 | ||
13f418b4 | 1153 | INCLUDE_FILE_PATTERNS = |
1490ff4d | 1154 | |
13f418b4 MW |
1155 | # The PREDEFINED tag can be used to specify one or more macro names that |
1156 | # are defined before the preprocessor is started (similar to the -D option of | |
1157 | # gcc). The argument of the tag is a list of macros of the form: name | |
1158 | # or name=definition (no spaces). If the definition and the = are | |
1159 | # omitted =1 is assumed. To prevent a macro definition from being | |
1160 | # undefined via #undef or recursively expanded use the := operator | |
1490ff4d MW |
1161 | # instead of the = operator. |
1162 | ||
1163 | PREDEFINED = LEAK_DETECTIVE | |
1164 | ||
13f418b4 MW |
1165 | # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then |
1166 | # this tag can be used to specify a list of macro names that should be expanded. | |
1167 | # The macro definition that is found in the sources will be used. | |
1490ff4d MW |
1168 | # Use the PREDEFINED tag if you want to use a different macro definition. |
1169 | ||
13f418b4 | 1170 | EXPAND_AS_DEFINED = |
1490ff4d | 1171 | |
13f418b4 MW |
1172 | # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then |
1173 | # doxygen's preprocessor will remove all function-like macros that are alone | |
1174 | # on a line, have an all uppercase name, and do not end with a semicolon. Such | |
1175 | # function macros are typically used for boiler-plate code, and will confuse | |
1490ff4d MW |
1176 | # the parser if not removed. |
1177 | ||
1178 | SKIP_FUNCTION_MACROS = YES | |
1179 | ||
b1e69188 | 1180 | #--------------------------------------------------------------------------- |
13f418b4 | 1181 | # Configuration::additions related to external references |
b1e69188 | 1182 | #--------------------------------------------------------------------------- |
1490ff4d | 1183 | |
13f418b4 MW |
1184 | # The TAGFILES option can be used to specify one or more tagfiles. |
1185 | # Optionally an initial location of the external documentation | |
1186 | # can be added for each tagfile. The format of a tag file without | |
1187 | # this location is as follows: | |
1188 | # TAGFILES = file1 file2 ... | |
1189 | # Adding location for the tag files is done as follows: | |
1190 | # TAGFILES = file1=loc1 "file2 = loc2" ... | |
1191 | # where "loc1" and "loc2" can be relative or absolute paths or | |
1192 | # URLs. If a location is present for each tag, the installdox tool | |
1490ff4d MW |
1193 | # does not have to be run to correct the links. |
1194 | # Note that each tag file must have a unique name | |
1195 | # (where the name does NOT include the path) | |
13f418b4 | 1196 | # If a tag file is not located in the directory in which doxygen |
1490ff4d MW |
1197 | # is run, you must also specify the path to the tagfile here. |
1198 | ||
13f418b4 | 1199 | TAGFILES = |
1490ff4d | 1200 | |
13f418b4 | 1201 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create |
1490ff4d MW |
1202 | # a tag file that is based on the input files it reads. |
1203 | ||
13f418b4 | 1204 | GENERATE_TAGFILE = |
1490ff4d | 1205 | |
13f418b4 MW |
1206 | # If the ALLEXTERNALS tag is set to YES all external classes will be listed |
1207 | # in the class index. If set to NO only the inherited external classes | |
1490ff4d MW |
1208 | # will be listed. |
1209 | ||
1210 | ALLEXTERNALS = NO | |
1211 | ||
13f418b4 MW |
1212 | # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed |
1213 | # in the modules index. If set to NO, only the current project's groups will | |
1490ff4d MW |
1214 | # be listed. |
1215 | ||
1216 | EXTERNAL_GROUPS = YES | |
1217 | ||
13f418b4 | 1218 | # The PERL_PATH should be the absolute path and name of the perl script |
1490ff4d MW |
1219 | # interpreter (i.e. the result of `which perl'). |
1220 | ||
1221 | PERL_PATH = /usr/bin/perl | |
1222 | ||
b1e69188 | 1223 | #--------------------------------------------------------------------------- |
13f418b4 | 1224 | # Configuration options related to the dot tool |
b1e69188 | 1225 | #--------------------------------------------------------------------------- |
1490ff4d | 1226 | |
13f418b4 MW |
1227 | # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
1228 | # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base | |
1229 | # or super classes. Setting the tag to NO turns the diagrams off. Note that | |
1230 | # this option is superseded by the HAVE_DOT option below. This is only a | |
1231 | # fallback. It is recommended to install and use dot, since it yields more | |
1490ff4d MW |
1232 | # powerful graphs. |
1233 | ||
1234 | CLASS_DIAGRAMS = YES | |
1235 | ||
13f418b4 MW |
1236 | # You can define message sequence charts within doxygen comments using the \msc |
1237 | # command. Doxygen will then run the mscgen tool (see | |
1238 | # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the | |
1239 | # documentation. The MSCGEN_PATH tag allows you to specify the directory where | |
1240 | # the mscgen tool resides. If left empty the tool is assumed to be found in the | |
1490ff4d MW |
1241 | # default search path. |
1242 | ||
13f418b4 | 1243 | MSCGEN_PATH = |
1490ff4d | 1244 | |
13f418b4 MW |
1245 | # If set to YES, the inheritance and collaboration graphs will hide |
1246 | # inheritance and usage relations if the target is undocumented | |
1490ff4d MW |
1247 | # or is not a class. |
1248 | ||
1249 | HIDE_UNDOC_RELATIONS = YES | |
1250 | ||
13f418b4 MW |
1251 | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
1252 | # available from the path. This tool is part of Graphviz, a graph visualization | |
1253 | # toolkit from AT&T and Lucent Bell Labs. The other options in this section | |
1490ff4d MW |
1254 | # have no effect if this option is set to NO (the default) |
1255 | ||
1256 | HAVE_DOT = NO | |
1257 | ||
13f418b4 MW |
1258 | # By default doxygen will write a font called FreeSans.ttf to the output |
1259 | # directory and reference it in all dot files that doxygen generates. This | |
1260 | # font does not include all possible unicode characters however, so when you need | |
1261 | # these (or just want a differently looking font) you can specify the font name | |
1262 | # using DOT_FONTNAME. You need need to make sure dot is able to find the font, | |
1263 | # which can be done by putting it in a standard location or by setting the | |
1264 | # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory | |
1490ff4d MW |
1265 | # containing the font. |
1266 | ||
1267 | DOT_FONTNAME = FreeSans | |
1268 | ||
13f418b4 MW |
1269 | # By default doxygen will tell dot to use the output directory to look for the |
1270 | # FreeSans.ttf font (which doxygen will put there itself). If you specify a | |
1271 | # different font using DOT_FONTNAME you can set the path where dot | |
1490ff4d MW |
1272 | # can find it using this tag. |
1273 | ||
13f418b4 | 1274 | DOT_FONTPATH = |
1490ff4d | 1275 | |
13f418b4 MW |
1276 | # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
1277 | # will generate a graph for each documented class showing the direct and | |
1278 | # indirect inheritance relations. Setting this tag to YES will force the | |
1490ff4d MW |
1279 | # the CLASS_DIAGRAMS tag to NO. |
1280 | ||
1281 | CLASS_GRAPH = YES | |
1282 | ||
13f418b4 MW |
1283 | # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen |
1284 | # will generate a graph for each documented class showing the direct and | |
1285 | # indirect implementation dependencies (inheritance, containment, and | |
1490ff4d MW |
1286 | # class references variables) of the class with other documented classes. |
1287 | ||
1288 | COLLABORATION_GRAPH = YES | |
1289 | ||
13f418b4 | 1290 | # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen |
1490ff4d MW |
1291 | # will generate a graph for groups, showing the direct groups dependencies |
1292 | ||
1293 | GROUP_GRAPHS = YES | |
1294 | ||
13f418b4 MW |
1295 | # If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
1296 | # collaboration diagrams in a style similar to the OMG's Unified Modeling | |
1490ff4d MW |
1297 | # Language. |
1298 | ||
1299 | UML_LOOK = NO | |
1300 | ||
13f418b4 | 1301 | # If set to YES, the inheritance and collaboration graphs will show the |
1490ff4d MW |
1302 | # relations between templates and their instances. |
1303 | ||
1304 | TEMPLATE_RELATIONS = NO | |
1305 | ||
13f418b4 MW |
1306 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT |
1307 | # tags are set to YES then doxygen will generate a graph for each documented | |
1308 | # file showing the direct and indirect include dependencies of the file with | |
1490ff4d MW |
1309 | # other documented files. |
1310 | ||
1311 | INCLUDE_GRAPH = YES | |
1312 | ||
13f418b4 MW |
1313 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and |
1314 | # HAVE_DOT tags are set to YES then doxygen will generate a graph for each | |
1315 | # documented header file showing the documented files that directly or | |
1490ff4d MW |
1316 | # indirectly include this file. |
1317 | ||
1318 | INCLUDED_BY_GRAPH = YES | |
1319 | ||
13f418b4 MW |
1320 | # If the CALL_GRAPH and HAVE_DOT options are set to YES then |
1321 | # doxygen will generate a call dependency graph for every global function | |
1322 | # or class method. Note that enabling this option will significantly increase | |
1323 | # the time of a run. So in most cases it will be better to enable call graphs | |
1490ff4d MW |
1324 | # for selected functions only using the \callgraph command. |
1325 | ||
1326 | CALL_GRAPH = NO | |
1327 | ||
13f418b4 MW |
1328 | # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then |
1329 | # doxygen will generate a caller dependency graph for every global function | |
1330 | # or class method. Note that enabling this option will significantly increase | |
1331 | # the time of a run. So in most cases it will be better to enable caller | |
1490ff4d MW |
1332 | # graphs for selected functions only using the \callergraph command. |
1333 | ||
1334 | CALLER_GRAPH = NO | |
1335 | ||
13f418b4 | 1336 | # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
1490ff4d MW |
1337 | # will graphical hierarchy of all classes instead of a textual one. |
1338 | ||
1339 | GRAPHICAL_HIERARCHY = YES | |
1340 | ||
13f418b4 MW |
1341 | # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES |
1342 | # then doxygen will show the dependencies a directory has on other directories | |
1490ff4d MW |
1343 | # in a graphical way. The dependency relations are determined by the #include |
1344 | # relations between the files in the directories. | |
1345 | ||
1346 | DIRECTORY_GRAPH = YES | |
1347 | ||
13f418b4 | 1348 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
1490ff4d MW |
1349 | # generated by dot. Possible values are png, jpg, or gif |
1350 | # If left blank png will be used. | |
1351 | ||
1352 | DOT_IMAGE_FORMAT = png | |
1353 | ||
13f418b4 | 1354 | # The tag DOT_PATH can be used to specify the path where the dot tool can be |
1490ff4d MW |
1355 | # found. If left blank, it is assumed the dot tool can be found in the path. |
1356 | ||
13f418b4 | 1357 | DOT_PATH = |
1490ff4d | 1358 | |
13f418b4 MW |
1359 | # The DOTFILE_DIRS tag can be used to specify one or more directories that |
1360 | # contain dot files that are included in the documentation (see the | |
1490ff4d MW |
1361 | # \dotfile command). |
1362 | ||
13f418b4 | 1363 | DOTFILE_DIRS = |
1490ff4d | 1364 | |
13f418b4 MW |
1365 | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of |
1366 | # nodes that will be shown in the graph. If the number of nodes in a graph | |
1367 | # becomes larger than this value, doxygen will truncate the graph, which is | |
1368 | # visualized by representing a node as a red box. Note that doxygen if the | |
1369 | # number of direct children of the root node in a graph is already larger than | |
1370 | # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note | |
1490ff4d MW |
1371 | # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. |
1372 | ||
1373 | DOT_GRAPH_MAX_NODES = 50 | |
1374 | ||
13f418b4 MW |
1375 | # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the |
1376 | # graphs generated by dot. A depth value of 3 means that only nodes reachable | |
1377 | # from the root by following a path via at most 3 edges will be shown. Nodes | |
1378 | # that lay further from the root node will be omitted. Note that setting this | |
1379 | # option to 1 or 2 may greatly reduce the computation time needed for large | |
1380 | # code bases. Also note that the size of a graph can be further restricted by | |
1490ff4d MW |
1381 | # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. |
1382 | ||
1383 | MAX_DOT_GRAPH_DEPTH = 0 | |
1384 | ||
13f418b4 MW |
1385 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent |
1386 | # background. This is enabled by default, which results in a transparent | |
1387 | # background. Warning: Depending on the platform used, enabling this option | |
1388 | # may lead to badly anti-aliased labels on the edges of a graph (i.e. they | |
1490ff4d MW |
1389 | # become hard to read). |
1390 | ||
1391 | DOT_TRANSPARENT = NO | |
1392 | ||
13f418b4 MW |
1393 | # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output |
1394 | # files in one run (i.e. multiple -o and -T options on the command line). This | |
1395 | # makes dot run faster, but since only newer versions of dot (>1.8.10) | |
1490ff4d MW |
1396 | # support this, this feature is disabled by default. |
1397 | ||
1398 | DOT_MULTI_TARGETS = NO | |
1399 | ||
13f418b4 MW |
1400 | # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
1401 | # generate a legend page explaining the meaning of the various boxes and | |
1490ff4d MW |
1402 | # arrows in the dot generated graphs. |
1403 | ||
1404 | GENERATE_LEGEND = YES | |
1405 | ||
13f418b4 MW |
1406 | # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will |
1407 | # remove the intermediate dot files that are used to generate | |
1490ff4d MW |
1408 | # the various graphs. |
1409 | ||
1410 | DOT_CLEANUP = YES | |
1411 | ||
b1e69188 | 1412 | #--------------------------------------------------------------------------- |
13f418b4 | 1413 | # Configuration::additions related to the search engine |
b1e69188 | 1414 | #--------------------------------------------------------------------------- |
1490ff4d | 1415 | |
13f418b4 | 1416 | # The SEARCHENGINE tag specifies whether or not a search engine should be |
1490ff4d MW |
1417 | # used. If set to NO the values of all tags below this one will be ignored. |
1418 | ||
1419 | SEARCHENGINE = NO |