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