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