Update contrib.
3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project
6 # All text after a hash (#) is considered a comment and will be ignored
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 (" ")
13 #---------------------------------------------------------------------------
14 # General configuration options
15 #---------------------------------------------------------------------------
17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18 # by quotes) that should identify the project.
20 PROJECT_NAME = "Crypto Token Framework"
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
23 # This could be handy for archiving the generated documentation or
24 # if some version control system is used.
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29 # base path where the generated documentation will be put.
30 # If a relative path is entered, it will be relative to the location
31 # where doxygen was started. If left blank the current directory will be used.
33 OUTPUT_DIRECTORY = ../docs/
35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
36 # documentation generated by doxygen is written. Doxygen will use this
37 # information to generate all constant output in the proper language.
38 # The default language is English, other supported languages are:
39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
41 # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,
42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
44 OUTPUT_LANGUAGE = English
46 # This tag can be used to specify the encoding used in the generated output.
47 # The encoding is not always determined by the language that is chosen,
48 # but also whether or not the output is meant for Windows or non-Windows users.
49 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
50 # forces the Windows encoding (this is the default for the Windows binary),
51 # whereas setting the tag to NO uses a Unix-style encoding (the default for
52 # all platforms other than Windows).
54 USE_WINDOWS_ENCODING = YES
56 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
57 # documentation are documented, even if no documentation was available.
58 # Private class members and static file members will be hidden unless
59 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
63 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
64 # will be included in the documentation.
68 # If the EXTRACT_STATIC tag is set to YES all static members of a file
69 # will be included in the documentation.
72 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
73 # defined locally in source files will be included in the documentation.
74 # If set to NO only classes defined in header files are included.
76 EXTRACT_LOCAL_CLASSES = NO
78 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
79 # undocumented members of documented classes, files or namespaces.
80 # If set to NO (the default) these members will be included in the
81 # various overviews, but no documentation section is generated.
82 # This option has no effect if EXTRACT_ALL is enabled.
84 HIDE_UNDOC_MEMBERS = NO
86 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
87 # undocumented classes that are normally visible in the class hierarchy.
88 # If set to NO (the default) these classes will be included in the various
89 # overviews. This option has no effect if EXTRACT_ALL is enabled.
91 HIDE_UNDOC_CLASSES = NO
93 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
94 # friend (class|struct|union) declarations.
95 # If set to NO (the default) these declarations will be included in the
98 HIDE_FRIEND_COMPOUNDS = NO
100 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
101 # documentation blocks found inside the body of a function.
102 # If set to NO (the default) these blocks will be appended to the
103 # function's detailed documentation block.
105 HIDE_IN_BODY_DOCS = NO
107 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
108 # include brief member descriptions after the members that are listed in
109 # the file and class documentation (similar to JavaDoc).
110 # Set to NO to disable this.
112 BRIEF_MEMBER_DESC = YES
114 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
115 # the brief description of a member or function before the detailed description.
116 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
117 # brief descriptions will be completely suppressed.
121 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
122 # Doxygen will generate a detailed section even if there is only a brief
125 ALWAYS_DETAILED_SEC = NO
127 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
128 # members of a class in the documentation of that class as if those members were
129 # ordinary class members. Constructors, destructors and assignment operators of
130 # the base classes will not be shown.
132 INLINE_INHERITED_MEMB = NO
134 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
135 # path before files name in the file list and in the header files. If set
136 # to NO the shortest path that makes the file name unique will be used.
140 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
141 # can be used to strip a user defined part of the path. Stripping is
142 # only done if one of the specified strings matches the left-hand part of
143 # the path. It is allowed to use relative paths in the argument list.
145 STRIP_FROM_PATH = ../..
147 # The INTERNAL_DOCS tag determines if documentation
148 # that is typed after a \internal command is included. If the tag is set
149 # to NO (the default) then the documentation will be excluded.
150 # Set it to YES to include the internal documentation.
154 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
155 # file names in lower case letters. If set to YES upper case letters are also
156 # allowed. This is useful if you have classes or files whose names only differ
157 # in case and if your file system supports case sensitive file names. Windows
158 # users are advised to set this option to NO.
160 CASE_SENSE_NAMES = YES
162 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
163 # (but less readable) file names. This can be useful is your file systems
164 # doesn't support long names like on DOS, Mac, or CD-ROM.
168 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
169 # will show members with their full class and namespace scopes in the
170 # documentation. If set to YES the scope will be hidden.
172 HIDE_SCOPE_NAMES = NO
174 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
175 # will put list of the files that are included by a file in the documentation
178 SHOW_INCLUDE_FILES = YES
180 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
181 # will interpret the first line (until the first dot) of a JavaDoc-style
182 # comment as the brief description. If set to NO, the JavaDoc
183 # comments will behave just like the Qt-style comments (thus requiring an
184 # explict @brief command for a brief description.
186 JAVADOC_AUTOBRIEF = YES
188 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
189 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
190 # comments) as a brief description. This used to be the default behaviour.
191 # The new default is to treat a multi-line C++ comment block as a detailed
192 # description. Set this tag to YES if you prefer the old behaviour instead.
194 MULTILINE_CPP_IS_BRIEF = NO
196 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
197 # will output the detailed description near the top, like JavaDoc.
198 # If set to NO, the detailed description appears after the member
203 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
204 # member inherits the documentation from any documented member that it
209 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
210 # is inserted in the documentation for inline members.
214 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
215 # will sort the (detailed) documentation of file and class members
216 # alphabetically by member name. If set to NO the members will appear in
219 SORT_MEMBER_DOCS = NO
221 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
222 # tag is set to YES, then doxygen will reuse the documentation of the first
223 # member in the group (if any) for the other members of the group. By default
224 # all members of a group must be documented explicitly.
226 DISTRIBUTE_GROUP_DOC = YES
228 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
229 # Doxygen uses this value to replace tabs by spaces in code fragments.
233 # The GENERATE_TODOLIST tag can be used to enable (YES) or
234 # disable (NO) the list. This list is created by putting keyword
235 # commands in the documentation.
237 GENERATE_TODOLIST = YES
239 # The GENERATE_TESTLIST tag can be used to enable (YES) or
240 # disable (NO) the test list. This list is created by putting \test
241 # commands in the documentation.
243 GENERATE_TESTLIST = YES
245 # The GENERATE_BUGLIST tag can be used to enable (YES) or
246 # disable (NO) the list. This list is created by putting keyword
247 # commands in the documentation.
249 GENERATE_BUGLIST = YES
251 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
252 # disable (NO) the deprecated list. This list is created by putting
253 # \deprecated commands in the documentation.
255 GENERATE_DEPRECATEDLIST= YES
257 # This tag can be used to specify a number of aliases that acts
258 # as commands in the documentation. An alias has the form "name=value".
259 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
260 # put the command \sideeffect (or @sideeffect) in the documentation, which
261 # will result in a user defined paragraph with heading "Side Effects:".
262 # You can put \n's in the value part of an alias to insert newlines.
265 "publishedAll=@par publishedAll\n" \
266 "publishedPartner=@par publishedPartner\n" \
267 "internalAll=@par internalAll\n" \
268 "internalComponent=@par internalComponent\n" \
269 "internalTechnology=@par internalTechnology\n" \
270 "prototype=@par prototype\n" \
271 "interim=@par interim\n" \
272 "released=@par released\n" \
273 "deprecated=@par deprecated\n" \
274 "removed=@par removed\n" \
275 "capability=@par capability\n" \
276 "leave=@par leave\n" \
279 # The ENABLED_SECTIONS tag can be used to enable conditional
280 # documentation sections, marked by \if sectionname ... \endif.
284 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
285 # the initial value of a variable or define consists of for it to appear in
286 # the documentation. If the initializer consists of more lines than specified
287 # here it will be hidden. Use a value of 0 to hide initializers completely.
288 # The appearance of the initializer of individual variables and defines in the
289 # documentation can be controlled using \showinitializer or \hideinitializer
290 # command in the documentation regardless of this setting.
292 MAX_INITIALIZER_LINES = 30
294 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
295 # only. Doxygen will then generate output that is more tailored for C.
296 # For instance, some of the names that are used will be different. The list
297 # of all members will be omitted, etc.
299 OPTIMIZE_OUTPUT_FOR_C = NO
301 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
302 # only. Doxygen will then generate output that is more tailored for Java.
303 # For instance, namespaces will be presented as packages, qualified scopes
304 # will look different, etc.
306 OPTIMIZE_OUTPUT_JAVA = NO
308 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
309 # at the bottom of the documentation of classes and structs. If set to YES the
310 # list will mention the files that were used to generate the documentation.
312 SHOW_USED_FILES = YES
314 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
315 # the same type (for instance a group of public functions) to be put as a
316 # subgroup of that type (e.g. under the Public Functions section). Set it to
317 # NO to prevent subgrouping. Alternatively, this can be done per class using
318 # the \nosubgrouping command.
322 #---------------------------------------------------------------------------
323 # configuration options related to warning and progress messages
324 #---------------------------------------------------------------------------
326 # The QUIET tag can be used to turn on/off the messages that are generated
327 # by doxygen. Possible values are YES and NO. If left blank NO is used.
331 # The WARNINGS tag can be used to turn on/off the warning messages that are
332 # generated by doxygen. Possible values are YES and NO. If left blank
337 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
338 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
339 # automatically be disabled.
341 WARN_IF_UNDOCUMENTED = YES
343 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
344 # potential errors in the documentation, such as not documenting some
345 # parameters in a documented function, or documenting parameters that
346 # don't exist or using markup commands wrongly.
348 WARN_IF_DOC_ERROR = YES
350 # The WARN_FORMAT tag determines the format of the warning messages that
351 # doxygen can produce. The string should contain the $file, $line, and $text
352 # tags, which will be replaced by the file and line number from which the
353 # warning originated and the warning text.
355 WARN_FORMAT = "$file:$line: $text"
357 # The WARN_LOGFILE tag can be used to specify a file to which warning
358 # and error messages should be written. If left blank the output is written
361 WARN_LOGFILE = "warning.log"
363 #---------------------------------------------------------------------------
364 # configuration options related to the input files
365 #---------------------------------------------------------------------------
367 # The INPUT tag can be used to specify the files and/or directories that contain
368 # documented source files. You may enter file names like "myfile.cpp" or
369 # directories like "/usr/src/myproject". Separate the files or directories
372 INPUT = ../inc/ct ../docsrc ../inc_interfaces ../inc
374 # If the value of the INPUT tag contains directories, you can use the
375 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
376 # and *.h) to filter out the source-files in the directories. If left
377 # blank the following patterns are tested:
378 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
379 # *.h++ *.idl *.odl *.cs
381 FILE_PATTERNS = *.cpp \
390 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
391 # should be searched for input files as well. Possible values are YES and NO.
392 # If left blank NO is used.
396 # The EXCLUDE tag can be used to specify files and/or directories that should
397 # excluded from the INPUT source files. This way you can easily exclude a
398 # subdirectory from a directory tree whose root is specified with the INPUT tag.
402 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
403 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
405 EXCLUDE_SYMLINKS = NO
407 # If the value of the INPUT tag contains directories, you can use the
408 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
409 # certain files from those directories.
413 # The EXAMPLE_PATH tag can be used to specify one or more files or
414 # directories that contain example code fragments that are included (see
415 # the \include command).
419 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
420 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
421 # and *.h) to filter out the source-files in the directories. If left
422 # blank all files are included.
426 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
427 # searched for input files to be used with the \include or \dontinclude
428 # commands irrespective of the value of the RECURSIVE tag.
429 # Possible values are YES and NO. If left blank NO is used.
431 EXAMPLE_RECURSIVE = NO
433 # The IMAGE_PATH tag can be used to specify one or more files or
434 # directories that contain image that are included in the documentation (see
435 # the \image command).
437 IMAGE_PATH = ../docsrc
439 # The INPUT_FILTER tag can be used to specify a program that doxygen should
440 # invoke to filter for each input file. Doxygen will invoke the filter program
441 # by executing (via popen()) the command <filter> <input-file>, where <filter>
442 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
443 # input file. Doxygen will then use the output that the filter program writes
444 # to standard output.
448 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
449 # INPUT_FILTER) will be used to filter the input files when producing source
450 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
452 FILTER_SOURCE_FILES = NO
454 #---------------------------------------------------------------------------
455 # configuration options related to source browsing
456 #---------------------------------------------------------------------------
458 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
459 # be generated. Documented entities will be cross-referenced with these sources.
463 # Setting the INLINE_SOURCES tag to YES will include the body
464 # of functions and classes directly in the documentation.
468 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
469 # doxygen to hide any special comment blocks from generated source code
470 # fragments. Normal C and C++ comments will always remain visible.
472 STRIP_CODE_COMMENTS = YES
474 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
475 # then for each documented function all documented
476 # functions referencing it will be listed.
478 REFERENCED_BY_RELATION = YES
480 # If the REFERENCES_RELATION tag is set to YES (the default)
481 # then for each documented function all documented entities
482 # called/used by that function will be listed.
484 REFERENCES_RELATION = YES
486 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
487 # will generate a verbatim copy of the header file for each class for
488 # which an include is specified. Set to NO to disable this.
490 VERBATIM_HEADERS = YES
492 #---------------------------------------------------------------------------
493 # configuration options related to the alphabetical class index
494 #---------------------------------------------------------------------------
496 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
497 # of all compounds will be generated. Enable this if the project
498 # contains a lot of classes, structs, unions or interfaces.
500 ALPHABETICAL_INDEX = YES
502 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
503 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
504 # in which this list will be split (can be a number in the range [1..20])
506 COLS_IN_ALPHA_INDEX = 5
508 # In case all classes in a project start with a common prefix, all
509 # classes will be put under the same header in the alphabetical index.
510 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
511 # should be ignored while generating the index headers.
518 #---------------------------------------------------------------------------
519 # configuration options related to the HTML output
520 #---------------------------------------------------------------------------
522 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
523 # generate HTML output.
527 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
528 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
529 # put in front of it. If left blank `html' will be used as the default path.
533 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
534 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
535 # doxygen will generate files with .html extension.
537 HTML_FILE_EXTENSION = .html
539 # The HTML_HEADER tag can be used to specify a personal HTML header for
540 # each generated HTML page. If it is left blank doxygen will generate a
543 HTML_HEADER = "c:/apps/doxygen/symdox/html_headerfile.txt"
545 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
546 # each generated HTML page. If it is left blank doxygen will generate a
549 HTML_FOOTER = "c:/apps/doxygen/symdox/html_footerfile.txt"
551 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
552 # style sheet that is used by each HTML page. It can be used to
553 # fine-tune the look of the HTML output. If the tag is left blank doxygen
554 # will generate a default style sheet
558 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
559 # files or namespaces will be aligned in HTML using tables. If set to
560 # NO a bullet list will be used.
562 HTML_ALIGN_MEMBERS = YES
564 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
565 # will be generated that can be used as input for tools like the
566 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
567 # of the generated HTML documentation.
569 GENERATE_HTMLHELP = NO
571 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
572 # be used to specify the file name of the resulting .chm file. You
573 # can add a path in front of the file if the result should not be
574 # written to the html output dir.
576 CHM_FILE = "Security.chm"
578 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
579 # be used to specify the location (absolute path including file name) of
580 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
581 # the HTML help compiler on the generated index.hhp.
583 HHC_LOCATION = "C:\Program Files\HTML Help Workshop\hhc.exe"
585 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
586 # controls if a separate .chi index file is generated (YES) or that
587 # it should be included in the master .chm file (NO).
591 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
592 # controls whether a binary table of contents is generated (YES) or a
593 # normal table of contents (NO) in the .chm file.
597 # The TOC_EXPAND flag can be set to YES to add extra items for group members
598 # to the contents of the HTML help documentation and to the tree view.
602 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
603 # top of each HTML page. The value NO (the default) enables the index and
604 # the value YES disables it.
608 # This tag can be used to set the number of enum values (range [1..20])
609 # that doxygen will group on one line in the generated HTML documentation.
611 ENUM_VALUES_PER_LINE = 4
613 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
614 # generated containing a tree-like index structure (just like the one that
615 # is generated for HTML Help). For this to work a browser that supports
616 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
617 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
618 # probably better off using the HTML help feature.
620 GENERATE_TREEVIEW = NO
622 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
623 # used to set the initial width (in pixels) of the frame in which the tree
628 #---------------------------------------------------------------------------
629 # configuration options related to the LaTeX output
630 #---------------------------------------------------------------------------
632 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
633 # generate Latex output.
637 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
638 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
639 # put in front of it. If left blank `latex' will be used as the default path.
643 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
644 # invoked. If left blank `latex' will be used as the default command name.
646 LATEX_CMD_NAME = latex
648 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
649 # generate index for LaTeX. If left blank `makeindex' will be used as the
650 # default command name.
652 MAKEINDEX_CMD_NAME = makeindex
654 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
655 # LaTeX documents. This may be useful for small projects and may help to
656 # save some trees in general.
660 # The PAPER_TYPE tag can be used to set the paper type that is used
661 # by the printer. Possible values are: a4, a4wide, letter, legal and
662 # executive. If left blank a4wide will be used.
666 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
667 # packages that should be included in the LaTeX output.
671 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
672 # the generated latex document. The header should contain everything until
673 # the first chapter. If it is left blank doxygen will generate a
674 # standard header. Notice: only use this tag if you know what you are doing!
678 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
679 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
680 # contain links (just like the HTML output) instead of page references
681 # This makes the output suitable for online browsing using a pdf viewer.
685 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
686 # plain latex in the generated Makefile. Set this option to YES to get a
687 # higher quality PDF documentation.
691 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
692 # command to the generated LaTeX files. This will instruct LaTeX to keep
693 # running if errors occur, instead of asking the user for help.
694 # This option is also used when generating formulas in HTML.
698 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
699 # include the index chapters (such as File Index, Compound Index, etc.)
702 LATEX_HIDE_INDICES = NO
704 #---------------------------------------------------------------------------
705 # configuration options related to the RTF output
706 #---------------------------------------------------------------------------
708 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
709 # The RTF output is optimised for Word 97 and may not look very pretty with
710 # other RTF readers or editors.
714 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
715 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
716 # put in front of it. If left blank `rtf' will be used as the default path.
720 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
721 # RTF documents. This may be useful for small projects and may help to
722 # save some trees in general.
726 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
727 # will contain hyperlink fields. The RTF file will
728 # contain links (just like the HTML output) instead of page references.
729 # This makes the output suitable for online browsing using WORD or other
730 # programs which support those fields.
731 # Note: wordpad (write) and others do not support links.
735 # Load stylesheet definitions from file. Syntax is similar to doxygen's
736 # config file, i.e. a series of assigments. You only have to provide
737 # replacements, missing definitions are set to their default value.
739 RTF_STYLESHEET_FILE =
741 # Set optional variables used in the generation of an rtf document.
742 # Syntax is similar to doxygen's config file.
744 RTF_EXTENSIONS_FILE =
746 #---------------------------------------------------------------------------
747 # configuration options related to the man page output
748 #---------------------------------------------------------------------------
750 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
755 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
756 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
757 # put in front of it. If left blank `man' will be used as the default path.
761 # The MAN_EXTENSION tag determines the extension that is added to
762 # the generated man pages (default is the subroutine's section .3)
766 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
767 # then it will generate one additional man file for each entity
768 # documented in the real man page(s). These additional files
769 # only source the real man page, but without them the man command
770 # would be unable to find the correct page. The default is NO.
774 #---------------------------------------------------------------------------
775 # configuration options related to the XML output
776 #---------------------------------------------------------------------------
778 # If the GENERATE_XML tag is set to YES Doxygen will
779 # generate an XML file that captures the structure of
780 # the code including all documentation. Note that this
781 # feature is still experimental and not complete at the
786 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
787 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
788 # put in front of it. If left blank `xml' will be used as the default path.
792 # The XML_SCHEMA tag can be used to specify an XML schema,
793 # which can be used by a validating XML parser to check the
794 # syntax of the XML files.
798 # The XML_DTD tag can be used to specify an XML DTD,
799 # which can be used by a validating XML parser to check the
800 # syntax of the XML files.
804 #---------------------------------------------------------------------------
805 # configuration options for the AutoGen Definitions output
806 #---------------------------------------------------------------------------
808 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
809 # generate an AutoGen Definitions (see autogen.sf.net) file
810 # that captures the structure of the code including all
811 # documentation. Note that this feature is still experimental
812 # and not complete at the moment.
814 GENERATE_AUTOGEN_DEF = NO
816 #---------------------------------------------------------------------------
817 # configuration options related to the Perl module output
818 #---------------------------------------------------------------------------
820 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
821 # generate a Perl module file that captures the structure of
822 # the code including all documentation. Note that this
823 # feature is still experimental and not complete at the
826 GENERATE_PERLMOD = NO
828 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
829 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
830 # to generate PDF and DVI output from the Perl module output.
834 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
835 # nicely formatted so it can be parsed by a human reader. This is useful
836 # if you want to understand what is going on. On the other hand, if this
837 # tag is set to NO the size of the Perl module output will be much smaller
838 # and Perl will parse it just the same.
842 # The names of the make variables in the generated doxyrules.make file
843 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
844 # This is useful so different doxyrules.make files included by the same
845 # Makefile don't overwrite each other's variables.
847 PERLMOD_MAKEVAR_PREFIX =
849 #---------------------------------------------------------------------------
850 # Configuration options related to the preprocessor
851 #---------------------------------------------------------------------------
853 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
854 # evaluate all C-preprocessor directives found in the sources and include
857 ENABLE_PREPROCESSING = YES
859 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
860 # names in the source code. If set to NO (the default) only conditional
861 # compilation will be performed. Macro expansion can be done in a controlled
862 # way by setting EXPAND_ONLY_PREDEF to YES.
866 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
867 # then the macro expansion is limited to the macros specified with the
868 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
870 EXPAND_ONLY_PREDEF = NO
872 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
873 # in the INCLUDE_PATH (see below) will be search if a #include is found.
875 SEARCH_INCLUDES = YES
877 # The INCLUDE_PATH tag can be used to specify one or more directories that
878 # contain include files that are not input files but should be processed by
883 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
884 # patterns (like *.h and *.hpp) to filter out the header-files in the
885 # directories. If left blank, the patterns specified with FILE_PATTERNS will
888 INCLUDE_FILE_PATTERNS =
890 # The PREDEFINED tag can be used to specify one or more macro names that
891 # are defined before the preprocessor is started (similar to the -D option of
892 # gcc). The argument of the tag is a list of macros of the form: name
893 # or name=definition (no spaces). If the definition and the = are
894 # omitted =1 is assumed.
896 PREDEFINED = NDEBUG \
905 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
906 # this tag can be used to specify a list of macro names that should be expanded.
907 # The macro definition that is found in the sources will be used.
908 # Use the PREDEFINED tag if you want to use a different macro definition.
912 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
913 # doxygen's preprocessor will remove all function-like macros that are alone
914 # on a line, have an all uppercase name, and do not end with a semicolon. Such
915 # function macros are typically used for boiler-plate code, and will confuse the
916 # parser if not removed.
918 SKIP_FUNCTION_MACROS = YES
920 #---------------------------------------------------------------------------
921 # Configuration::addtions related to external references
922 #---------------------------------------------------------------------------
924 # The TAGFILES option can be used to specify one or more tagfiles.
925 # Optionally an initial location of the external documentation
926 # can be added for each tagfile. The format of a tag file without
927 # this location is as follows:
928 # TAGFILES = file1 file2 ...
929 # Adding location for the tag files is done as follows:
930 # TAGFILES = file1=loc1 "file2 = loc2" ...
931 # where "loc1" and "loc2" can be relative or absolute paths or
932 # URLs. If a location is present for each tag, the installdox tool
933 # does not have to be run to correct the links.
934 # Note that each tag file must have a unique name
935 # (where the name does NOT include the path)
936 # If a tag file is not located in the directory in which doxygen
937 # is run, you must also specify the path to the tagfile here.
941 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
942 # a tag file that is based on the input files it reads.
946 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
947 # in the class index. If set to NO only the inherited external classes
952 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
953 # in the modules index. If set to NO, only the current project's groups will
956 EXTERNAL_GROUPS = YES
958 # The PERL_PATH should be the absolute path and name of the perl script
959 # interpreter (i.e. the result of `which perl').
961 PERL_PATH = C:\perl\bin\perl
963 #---------------------------------------------------------------------------
964 # Configuration options related to the dot tool
965 #---------------------------------------------------------------------------
967 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
968 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
969 # super classes. Setting the tag to NO turns the diagrams off. Note that this
970 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
971 # recommended to install and use dot, since it yields more powerful graphs.
975 # If set to YES, the inheritance and collaboration graphs will hide
976 # inheritance and usage relations if the target is undocumented
979 HIDE_UNDOC_RELATIONS = YES
981 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
982 # available from the path. This tool is part of Graphviz, a graph visualization
983 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
984 # have no effect if this option is set to NO (the default)
988 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
989 # will generate a graph for each documented class showing the direct and
990 # indirect inheritance relations. Setting this tag to YES will force the
991 # the CLASS_DIAGRAMS tag to NO.
995 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
996 # will generate a graph for each documented class showing the direct and
997 # indirect implementation dependencies (inheritance, containment, and
998 # class references variables) of the class with other documented classes.
1000 COLLABORATION_GRAPH = YES
1002 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1003 # collaboration diagrams in a style similiar to the OMG's Unified Modeling
1008 # If set to YES, the inheritance and collaboration graphs will show the
1009 # relations between templates and their instances.
1011 TEMPLATE_RELATIONS = YES
1013 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1014 # tags are set to YES then doxygen will generate a graph for each documented
1015 # file showing the direct and indirect include dependencies of the file with
1016 # other documented files.
1020 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1021 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1022 # documented header file showing the documented files that directly or
1023 # indirectly include this file.
1025 INCLUDED_BY_GRAPH = YES
1027 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1028 # generate a call dependency graph for every global function or class method.
1029 # Note that enabling this option will significantly increase the time of a run.
1030 # So in most cases it will be better to enable call graphs for selected
1031 # functions only using the \callgraph command.
1035 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1036 # will graphical hierarchy of all classes instead of a textual one.
1038 GRAPHICAL_HIERARCHY = YES
1040 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1041 # generated by dot. Possible values are png, jpg, or gif
1042 # If left blank png will be used.
1044 DOT_IMAGE_FORMAT = png
1046 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1047 # found. If left blank, it is assumed the dot tool can be found on the path.
1049 DOT_PATH = "C:\apps\doxygen\graphviz\bin"
1051 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1052 # contain dot files that are included in the documentation (see the
1053 # \dotfile command).
1057 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1058 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1059 # this value, doxygen will try to truncate the graph, so that it fits within
1060 # the specified constraint. Beware that most browsers cannot cope with very
1063 MAX_DOT_GRAPH_WIDTH = 1024
1065 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1066 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1067 # this value, doxygen will try to truncate the graph, so that it fits within
1068 # the specified constraint. Beware that most browsers cannot cope with very
1071 MAX_DOT_GRAPH_HEIGHT = 1024
1073 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1074 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1075 # from the root by following a path via at most 3 edges will be shown. Nodes that
1076 # lay further from the root node will be omitted. Note that setting this option to
1077 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1078 # note that a graph may be further truncated if the graph's image dimensions are
1079 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1080 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
1082 MAX_DOT_GRAPH_DEPTH = 0
1084 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1085 # generate a legend page explaining the meaning of the various boxes and
1086 # arrows in the dot generated graphs.
1088 GENERATE_LEGEND = YES
1090 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1091 # remove the intermediate dot files that are used to generate
1092 # the various graphs.
1096 #---------------------------------------------------------------------------
1097 # Configuration::addtions related to the search engine
1098 #---------------------------------------------------------------------------
1100 # The SEARCHENGINE tag specifies whether or not a search engine should be
1101 # used. If set to NO the values of all tags below this one will be ignored.
1105 # The CGI_NAME tag should be the name of the CGI script that
1106 # starts the search engine (doxysearch) with the correct parameters.
1107 # A script with this name will be generated by doxygen.
1109 # CGI_NAME = search.cgi
1111 # The CGI_URL tag should be the absolute URL to the directory where the
1112 # cgi binaries are located. See the documentation of your http daemon for
1117 # The DOC_URL tag should be the absolute URL to the directory where the
1118 # documentation is located. If left blank the absolute path to the
1119 # documentation, with file:// prepended to it, will be used.
1123 # The DOC_ABSPATH tag should be the absolute path to the directory where the
1124 # documentation is located. If left blank the directory on the local machine
1129 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
1132 # BIN_ABSPATH = /usr/local/bin/
1134 # The EXT_DOC_PATHS tag can be used to specify one or more paths to
1135 # documentation generated for other projects. This allows doxysearch to search
1136 # the documentation for these projects as well.