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