Debian Codegraph @

Doxyfile

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