3 # This file describes the settings to be used by the documentation system
\r
4 # doxygen (www.doxygen.org) for a project
\r
6 # All text after a hash (#) is considered a comment and will be ignored
\r
8 # TAG = value [value, ...]
\r
9 # For lists items can also be appended using:
\r
10 # TAG += value [value, ...]
\r
11 # Values that contain spaces should be placed between quotes (" ")
\r
13 #---------------------------------------------------------------------------
\r
14 # Project related configuration options
\r
15 #---------------------------------------------------------------------------
\r
17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
\r
18 # by quotes) that should identify the project.
\r
20 PROJECT_NAME = axTLS
\r
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
\r
23 # This could be handy for archiving the generated documentation or
\r
24 # if some version control system is used.
\r
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
\r
29 # base path where the generated documentation will be put.
\r
30 # If a relative path is entered, it will be relative to the location
\r
31 # where doxygen was started. If left blank the current directory will be used.
\r
35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
\r
36 # 4096 sub-directories (in 2 levels) under the output directory of each output
\r
37 # format and will distribute the generated files over these directories.
\r
38 # Enabling this option can be useful when feeding doxygen a huge amount of
\r
39 # source files, where putting all generated files in the same directory would
\r
40 # otherwise cause performance problems for the file system.
\r
44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
\r
45 # documentation generated by doxygen is written. Doxygen will use this
\r
46 # information to generate all constant output in the proper language.
\r
47 # The default language is English, other supported languages are:
\r
48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
\r
49 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
\r
50 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
\r
51 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
\r
52 # Swedish, and Ukrainian.
\r
54 OUTPUT_LANGUAGE = English
\r
56 # This tag can be used to specify the encoding used in the generated output.
\r
57 # The encoding is not always determined by the language that is chosen,
\r
58 # but also whether or not the output is meant for Windows or non-Windows users.
\r
59 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
\r
60 # forces the Windows encoding (this is the default for the Windows binary),
\r
61 # whereas setting the tag to NO uses a Unix-style encoding (the default for
\r
62 # all platforms other than Windows).
\r
64 USE_WINDOWS_ENCODING = NO
\r
66 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
\r
67 # include brief member descriptions after the members that are listed in
\r
68 # the file and class documentation (similar to JavaDoc).
\r
69 # Set to NO to disable this.
\r
71 BRIEF_MEMBER_DESC = YES
\r
73 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
\r
74 # the brief description of a member or function before the detailed description.
\r
75 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
\r
76 # brief descriptions will be completely suppressed.
\r
80 # This tag implements a quasi-intelligent brief description abbreviator
\r
81 # that is used to form the text in various listings. Each string
\r
82 # in this list, if found as the leading text of the brief description, will be
\r
83 # stripped from the text and the result after processing the whole list, is
\r
84 # used as the annotated text. Otherwise, the brief description is used as-is.
\r
85 # If left blank, the following values are used ("$name" is automatically
\r
86 # replaced with the name of the entity): "The $name class" "The $name widget"
\r
87 # "The $name file" "is" "provides" "specifies" "contains"
\r
88 # "represents" "a" "an" "the"
\r
92 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
\r
93 # Doxygen will generate a detailed section even if there is only a brief
\r
96 ALWAYS_DETAILED_SEC = NO
\r
98 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
\r
99 # inherited members of a class in the documentation of that class as if those
\r
100 # members were ordinary class members. Constructors, destructors and assignment
\r
101 # operators of the base classes will not be shown.
\r
103 INLINE_INHERITED_MEMB = NO
\r
105 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
\r
106 # path before files name in the file list and in the header files. If set
\r
107 # to NO the shortest path that makes the file name unique will be used.
\r
109 FULL_PATH_NAMES = NO
\r
111 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
\r
112 # can be used to strip a user-defined part of the path. Stripping is
\r
113 # only done if one of the specified strings matches the left-hand part of
\r
114 # the path. The tag can be used to show relative paths in the file list.
\r
115 # If left blank the directory from which doxygen is run is used as the
\r
120 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
\r
121 # the path mentioned in the documentation of a class, which tells
\r
122 # the reader which header file to include in order to use a class.
\r
123 # If left blank only the name of the header file containing the class
\r
124 # definition is used. Otherwise one should specify the include paths that
\r
125 # are normally passed to the compiler using the -I flag.
\r
127 STRIP_FROM_INC_PATH =
\r
129 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
\r
130 # (but less readable) file names. This can be useful is your file systems
\r
131 # doesn't support long names like on DOS, Mac, or CD-ROM.
\r
135 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
\r
136 # will interpret the first line (until the first dot) of a JavaDoc-style
\r
137 # comment as the brief description. If set to NO, the JavaDoc
\r
138 # comments will behave just like the Qt-style comments (thus requiring an
\r
139 # explicit @brief command for a brief description.
\r
141 JAVADOC_AUTOBRIEF = NO
\r
143 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
\r
144 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
\r
145 # comments) as a brief description. This used to be the default behaviour.
\r
146 # The new default is to treat a multi-line C++ comment block as a detailed
\r
147 # description. Set this tag to YES if you prefer the old behaviour instead.
\r
149 MULTILINE_CPP_IS_BRIEF = NO
\r
151 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
\r
152 # will output the detailed description near the top, like JavaDoc.
\r
153 # If set to NO, the detailed description appears after the member
\r
156 DETAILS_AT_TOP = NO
\r
158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
\r
159 # member inherits the documentation from any documented member that it
\r
164 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
\r
165 # a new page for each member. If set to NO, the documentation of a member will
\r
166 # be part of the file/class/namespace that contains it.
\r
168 SEPARATE_MEMBER_PAGES = NO
\r
170 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
\r
171 # Doxygen uses this value to replace tabs by spaces in code fragments.
\r
175 # This tag can be used to specify a number of aliases that acts
\r
176 # as commands in the documentation. An alias has the form "name=value".
\r
177 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
\r
178 # put the command \sideeffect (or @sideeffect) in the documentation, which
\r
179 # will result in a user-defined paragraph with heading "Side Effects:".
\r
180 # You can put \n's in the value part of an alias to insert newlines.
\r
184 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
\r
185 # sources only. Doxygen will then generate output that is more tailored for C.
\r
186 # For instance, some of the names that are used will be different. The list
\r
187 # of all members will be omitted, etc.
\r
189 OPTIMIZE_OUTPUT_FOR_C = YES
\r
191 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
\r
192 # sources only. Doxygen will then generate output that is more tailored for Java.
\r
193 # For instance, namespaces will be presented as packages, qualified scopes
\r
194 # will look different, etc.
\r
196 OPTIMIZE_OUTPUT_JAVA = NO
\r
198 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
\r
199 # include (a tag file for) the STL sources as input, then you should
\r
200 # set this tag to YES in order to let doxygen match functions declarations and
\r
201 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
\r
202 # func(std::string) {}). This also make the inheritance and collaboration
\r
203 # diagrams that involve STL classes more complete and accurate.
\r
205 BUILTIN_STL_SUPPORT = NO
\r
207 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
\r
208 # tag is set to YES, then doxygen will reuse the documentation of the first
\r
209 # member in the group (if any) for the other members of the group. By default
\r
210 # all members of a group must be documented explicitly.
\r
212 DISTRIBUTE_GROUP_DOC = NO
\r
214 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
\r
215 # the same type (for instance a group of public functions) to be put as a
\r
216 # subgroup of that type (e.g. under the Public Functions section). Set it to
\r
217 # NO to prevent subgrouping. Alternatively, this can be done per class using
\r
218 # the \nosubgrouping command.
\r
222 #---------------------------------------------------------------------------
\r
223 # Build related configuration options
\r
224 #---------------------------------------------------------------------------
\r
226 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
\r
227 # documentation are documented, even if no documentation was available.
\r
228 # Private class members and static file members will be hidden unless
\r
229 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
\r
233 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
\r
234 # will be included in the documentation.
\r
236 EXTRACT_PRIVATE = NO
\r
238 # If the EXTRACT_STATIC tag is set to YES all static members of a file
\r
239 # will be included in the documentation.
\r
241 EXTRACT_STATIC = NO
\r
243 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
\r
244 # defined locally in source files will be included in the documentation.
\r
245 # If set to NO only classes defined in header files are included.
\r
247 EXTRACT_LOCAL_CLASSES = YES
\r
249 # This flag is only useful for Objective-C code. When set to YES local
\r
250 # methods, which are defined in the implementation section but not in
\r
251 # the interface are included in the documentation.
\r
252 # If set to NO (the default) only methods in the interface are included.
\r
254 EXTRACT_LOCAL_METHODS = NO
\r
256 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
\r
257 # undocumented members of documented classes, files or namespaces.
\r
258 # If set to NO (the default) these members will be included in the
\r
259 # various overviews, but no documentation section is generated.
\r
260 # This option has no effect if EXTRACT_ALL is enabled.
\r
262 HIDE_UNDOC_MEMBERS = NO
\r
264 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
\r
265 # undocumented classes that are normally visible in the class hierarchy.
\r
266 # If set to NO (the default) these classes will be included in the various
\r
267 # overviews. This option has no effect if EXTRACT_ALL is enabled.
\r
269 HIDE_UNDOC_CLASSES = NO
\r
271 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
\r
272 # friend (class|struct|union) declarations.
\r
273 # If set to NO (the default) these declarations will be included in the
\r
276 HIDE_FRIEND_COMPOUNDS = NO
\r
278 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
\r
279 # documentation blocks found inside the body of a function.
\r
280 # If set to NO (the default) these blocks will be appended to the
\r
281 # function's detailed documentation block.
\r
283 HIDE_IN_BODY_DOCS = NO
\r
285 # The INTERNAL_DOCS tag determines if documentation
\r
286 # that is typed after a \internal command is included. If the tag is set
\r
287 # to NO (the default) then the documentation will be excluded.
\r
288 # Set it to YES to include the internal documentation.
\r
292 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
\r
293 # file names in lower-case letters. If set to YES upper-case letters are also
\r
294 # allowed. This is useful if you have classes or files whose names only differ
\r
295 # in case and if your file system supports case sensitive file names. Windows
\r
296 # and Mac users are advised to set this option to NO.
\r
298 CASE_SENSE_NAMES = YES
\r
300 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
\r
301 # will show members with their full class and namespace scopes in the
\r
302 # documentation. If set to YES the scope will be hidden.
\r
304 HIDE_SCOPE_NAMES = NO
\r
306 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
\r
307 # will put a list of the files that are included by a file in the documentation
\r
310 SHOW_INCLUDE_FILES = NO
\r
312 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
\r
313 # is inserted in the documentation for inline members.
\r
317 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
\r
318 # will sort the (detailed) documentation of file and class members
\r
319 # alphabetically by member name. If set to NO the members will appear in
\r
320 # declaration order.
\r
322 SORT_MEMBER_DOCS = NO
\r
324 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
\r
325 # brief documentation of file, namespace and class members alphabetically
\r
326 # by member name. If set to NO (the default) the members will appear in
\r
327 # declaration order.
\r
329 SORT_BRIEF_DOCS = NO
\r
331 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
\r
332 # sorted by fully-qualified names, including namespaces. If set to
\r
333 # NO (the default), the class list will be sorted only by class name,
\r
334 # not including the namespace part.
\r
335 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
\r
336 # Note: This option applies only to the class list, not to the
\r
337 # alphabetical list.
\r
339 SORT_BY_SCOPE_NAME = NO
\r
341 # The GENERATE_TODOLIST tag can be used to enable (YES) or
\r
342 # disable (NO) the todo list. This list is created by putting \todo
\r
343 # commands in the documentation.
\r
345 GENERATE_TODOLIST = YES
\r
347 # The GENERATE_TESTLIST tag can be used to enable (YES) or
\r
348 # disable (NO) the test list. This list is created by putting \test
\r
349 # commands in the documentation.
\r
351 GENERATE_TESTLIST = YES
\r
353 # The GENERATE_BUGLIST tag can be used to enable (YES) or
\r
354 # disable (NO) the bug list. This list is created by putting \bug
\r
355 # commands in the documentation.
\r
357 GENERATE_BUGLIST = YES
\r
359 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
\r
360 # disable (NO) the deprecated list. This list is created by putting
\r
361 # \deprecated commands in the documentation.
\r
363 GENERATE_DEPRECATEDLIST= YES
\r
365 # The ENABLED_SECTIONS tag can be used to enable conditional
\r
366 # documentation sections, marked by \if sectionname ... \endif.
\r
368 ENABLED_SECTIONS =
\r
370 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
\r
371 # the initial value of a variable or define consists of for it to appear in
\r
372 # the documentation. If the initializer consists of more lines than specified
\r
373 # here it will be hidden. Use a value of 0 to hide initializers completely.
\r
374 # The appearance of the initializer of individual variables and defines in the
\r
375 # documentation can be controlled using \showinitializer or \hideinitializer
\r
376 # command in the documentation regardless of this setting.
\r
378 MAX_INITIALIZER_LINES = 30
\r
380 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
\r
381 # at the bottom of the documentation of classes and structs. If set to YES the
\r
382 # list will mention the files that were used to generate the documentation.
\r
384 SHOW_USED_FILES = NO
\r
386 # If the sources in your project are distributed over multiple directories
\r
387 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
\r
388 # in the documentation. The default is YES.
\r
390 SHOW_DIRECTORIES = NO
\r
392 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
\r
393 # doxygen should invoke to get the current version for each file (typically from the
\r
394 # version control system). Doxygen will invoke the program by executing (via
\r
395 # popen()) the command <command> <input-file>, where <command> is the value of
\r
396 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
\r
397 # provided by doxygen. Whatever the program writes to standard output
\r
398 # is used as the file version. See the manual for examples.
\r
400 FILE_VERSION_FILTER =
\r
402 #---------------------------------------------------------------------------
\r
403 # configuration options related to warning and progress messages
\r
404 #---------------------------------------------------------------------------
\r
406 # The QUIET tag can be used to turn on/off the messages that are generated
\r
407 # by doxygen. Possible values are YES and NO. If left blank NO is used.
\r
411 # The WARNINGS tag can be used to turn on/off the warning messages that are
\r
412 # generated by doxygen. Possible values are YES and NO. If left blank
\r
417 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
\r
418 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
\r
419 # automatically be disabled.
\r
421 WARN_IF_UNDOCUMENTED = YES
\r
423 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
\r
424 # potential errors in the documentation, such as not documenting some
\r
425 # parameters in a documented function, or documenting parameters that
\r
426 # don't exist or using markup commands wrongly.
\r
428 WARN_IF_DOC_ERROR = YES
\r
430 # This WARN_NO_PARAMDOC option can be abled to get warnings for
\r
431 # functions that are documented, but have no documentation for their parameters
\r
432 # or return value. If set to NO (the default) doxygen will only warn about
\r
433 # wrong or incomplete parameter documentation, but not about the absence of
\r
436 WARN_NO_PARAMDOC = NO
\r
438 # The WARN_FORMAT tag determines the format of the warning messages that
\r
439 # doxygen can produce. The string should contain the $file, $line, and $text
\r
440 # tags, which will be replaced by the file and line number from which the
\r
441 # warning originated and the warning text. Optionally the format may contain
\r
442 # $version, which will be replaced by the version of the file (if it could
\r
443 # be obtained via FILE_VERSION_FILTER)
\r
445 WARN_FORMAT = "$file:$line: $text"
\r
447 # The WARN_LOGFILE tag can be used to specify a file to which warning
\r
448 # and error messages should be written. If left blank the output is written
\r
453 #---------------------------------------------------------------------------
\r
454 # configuration options related to the input files
\r
455 #---------------------------------------------------------------------------
\r
457 # The INPUT tag can be used to specify the files and/or directories that contain
\r
458 # documented source files. You may enter file names like "myfile.cpp" or
\r
459 # directories like "/usr/src/myproject". Separate the files or directories
\r
462 INPUT = ../bindings/csharp/axTLS.cs ../bindings/java/SSL.java ../bindings/java/SSLUtil.java ../bindings/java/SSLCTX.java ../bindings/java/SSLServer.java ../bindings/java/SSLClient.java ../bindings/java/SSLReadHolder.java ../ssl/ssl.h ../crypto/bigint.c ../crypto/bigint.h
\r
464 # If the value of the INPUT tag contains directories, you can use the
\r
465 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
\r
466 # and *.h) to filter out the source-files in the directories. If left
\r
467 # blank the following patterns are tested:
\r
468 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
\r
469 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
\r
473 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
\r
474 # should be searched for input files as well. Possible values are YES and NO.
\r
475 # If left blank NO is used.
\r
479 # The EXCLUDE tag can be used to specify files and/or directories that should
\r
480 # excluded from the INPUT source files. This way you can easily exclude a
\r
481 # subdirectory from a directory tree whose root is specified with the INPUT tag.
\r
485 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
\r
486 # directories that are symbolic links (a Unix filesystem feature) are excluded
\r
489 EXCLUDE_SYMLINKS = NO
\r
491 # If the value of the INPUT tag contains directories, you can use the
\r
492 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
\r
493 # certain files from those directories. Note that the wildcards are matched
\r
494 # against the file with absolute path, so to exclude all test directories
\r
495 # for example use the pattern */test/*
\r
497 EXCLUDE_PATTERNS =
\r
499 # The EXAMPLE_PATH tag can be used to specify one or more files or
\r
500 # directories that contain example code fragments that are included (see
\r
501 # the \include command).
\r
505 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
\r
506 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
\r
507 # and *.h) to filter out the source-files in the directories. If left
\r
508 # blank all files are included.
\r
510 EXAMPLE_PATTERNS =
\r
512 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
\r
513 # searched for input files to be used with the \include or \dontinclude
\r
514 # commands irrespective of the value of the RECURSIVE tag.
\r
515 # Possible values are YES and NO. If left blank NO is used.
\r
517 EXAMPLE_RECURSIVE = NO
\r
519 # The IMAGE_PATH tag can be used to specify one or more files or
\r
520 # directories that contain image that are included in the documentation (see
\r
521 # the \image command).
\r
523 IMAGE_PATH = images
\r
525 # The INPUT_FILTER tag can be used to specify a program that doxygen should
\r
526 # invoke to filter for each input file. Doxygen will invoke the filter program
\r
527 # by executing (via popen()) the command <filter> <input-file>, where <filter>
\r
528 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
\r
529 # input file. Doxygen will then use the output that the filter program writes
\r
530 # to standard output. If FILTER_PATTERNS is specified, this tag will be
\r
535 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
\r
536 # basis. Doxygen will compare the file name with each pattern and apply the
\r
537 # filter if there is a match. The filters are a list of the form:
\r
538 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
\r
539 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
\r
540 # is applied to all files.
\r
544 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
\r
545 # INPUT_FILTER) will be used to filter the input files when producing source
\r
546 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
\r
548 FILTER_SOURCE_FILES = NO
\r
550 #---------------------------------------------------------------------------
\r
551 # configuration options related to source browsing
\r
552 #---------------------------------------------------------------------------
\r
554 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
\r
555 # be generated. Documented entities will be cross-referenced with these sources.
\r
556 # Note: To get rid of all source code in the generated output, make sure also
\r
557 # VERBATIM_HEADERS is set to NO.
\r
559 SOURCE_BROWSER = NO
\r
561 # Setting the INLINE_SOURCES tag to YES will include the body
\r
562 # of functions and classes directly in the documentation.
\r
564 INLINE_SOURCES = NO
\r
566 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
\r
567 # doxygen to hide any special comment blocks from generated source code
\r
568 # fragments. Normal C and C++ comments will always remain visible.
\r
570 STRIP_CODE_COMMENTS = YES
\r
572 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
\r
573 # then for each documented function all documented
\r
574 # functions referencing it will be listed.
\r
576 REFERENCED_BY_RELATION = YES
\r
578 # If the REFERENCES_RELATION tag is set to YES (the default)
\r
579 # then for each documented function all documented entities
\r
580 # called/used by that function will be listed.
\r
582 REFERENCES_RELATION = YES
\r
584 # If the USE_HTAGS tag is set to YES then the references to source code
\r
585 # will point to the HTML generated by the htags(1) tool instead of doxygen
\r
586 # built-in source browser. The htags tool is part of GNU's global source
\r
587 # tagging system (see http://www.gnu.org/software/global/global.html). You
\r
588 # will need version 4.8.6 or higher.
\r
592 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
\r
593 # will generate a verbatim copy of the header file for each class for
\r
594 # which an include is specified. Set to NO to disable this.
\r
596 VERBATIM_HEADERS = NO
\r
598 #---------------------------------------------------------------------------
\r
599 # configuration options related to the alphabetical class index
\r
600 #---------------------------------------------------------------------------
\r
602 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
\r
603 # of all compounds will be generated. Enable this if the project
\r
604 # contains a lot of classes, structs, unions or interfaces.
\r
606 ALPHABETICAL_INDEX = NO
\r
608 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
\r
609 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
\r
610 # in which this list will be split (can be a number in the range [1..20])
\r
612 COLS_IN_ALPHA_INDEX = 5
\r
614 # In case all classes in a project start with a common prefix, all
\r
615 # classes will be put under the same header in the alphabetical index.
\r
616 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
\r
617 # should be ignored while generating the index headers.
\r
621 #---------------------------------------------------------------------------
\r
622 # configuration options related to the HTML output
\r
623 #---------------------------------------------------------------------------
\r
625 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
\r
626 # generate HTML output.
\r
628 GENERATE_HTML = YES
\r
630 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
\r
631 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
\r
632 # put in front of it. If left blank `html' will be used as the default path.
\r
636 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
\r
637 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
\r
638 # doxygen will generate files with .html extension.
\r
640 HTML_FILE_EXTENSION = .html
\r
642 # The HTML_HEADER tag can be used to specify a personal HTML header for
\r
643 # each generated HTML page. If it is left blank doxygen will generate a
\r
648 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
\r
649 # each generated HTML page. If it is left blank doxygen will generate a
\r
652 HTML_FOOTER = doco_footer.html
\r
654 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
\r
655 # style sheet that is used by each HTML page. It can be used to
\r
656 # fine-tune the look of the HTML output. If the tag is left blank doxygen
\r
657 # will generate a default style sheet. Note that doxygen will try to copy
\r
658 # the style sheet file to the HTML output directory, so don't put your own
\r
659 # stylesheet in the HTML output directory as well, or it will be erased!
\r
663 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
\r
664 # files or namespaces will be aligned in HTML using tables. If set to
\r
665 # NO a bullet list will be used.
\r
667 HTML_ALIGN_MEMBERS = YES
\r
669 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
\r
670 # will be generated that can be used as input for tools like the
\r
671 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
\r
672 # of the generated HTML documentation.
\r
674 GENERATE_HTMLHELP = NO
\r
676 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
\r
677 # be used to specify the file name of the resulting .chm file. You
\r
678 # can add a path in front of the file if the result should not be
\r
679 # written to the html output directory.
\r
683 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
\r
684 # be used to specify the location (absolute path including file name) of
\r
685 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
\r
686 # the HTML help compiler on the generated index.hhp.
\r
690 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
\r
691 # controls if a separate .chi index file is generated (YES) or that
\r
692 # it should be included in the master .chm file (NO).
\r
696 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
\r
697 # controls whether a binary table of contents is generated (YES) or a
\r
698 # normal table of contents (NO) in the .chm file.
\r
702 # The TOC_EXPAND flag can be set to YES to add extra items for group members
\r
703 # to the contents of the HTML help documentation and to the tree view.
\r
707 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
\r
708 # top of each HTML page. The value NO (the default) enables the index and
\r
709 # the value YES disables it.
\r
711 DISABLE_INDEX = YES
\r
713 # This tag can be used to set the number of enum values (range [1..20])
\r
714 # that doxygen will group on one line in the generated HTML documentation.
\r
716 ENUM_VALUES_PER_LINE = 4
\r
718 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
\r
719 # generated containing a tree-like index structure (just like the one that
\r
720 # is generated for HTML Help). For this to work a browser that supports
\r
721 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
\r
722 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
\r
723 # probably better off using the HTML help feature.
\r
725 GENERATE_TREEVIEW = YES
\r
727 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
\r
728 # used to set the initial width (in pixels) of the frame in which the tree
\r
731 TREEVIEW_WIDTH = 250
\r
733 #---------------------------------------------------------------------------
\r
734 # configuration options related to the LaTeX output
\r
735 #---------------------------------------------------------------------------
\r
737 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
\r
738 # generate Latex output.
\r
740 GENERATE_LATEX = NO
\r
742 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
\r
743 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
\r
744 # put in front of it. If left blank `latex' will be used as the default path.
\r
746 LATEX_OUTPUT = latex
\r
748 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
\r
749 # invoked. If left blank `latex' will be used as the default command name.
\r
751 LATEX_CMD_NAME = latex
\r
753 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
\r
754 # generate index for LaTeX. If left blank `makeindex' will be used as the
\r
755 # default command name.
\r
757 MAKEINDEX_CMD_NAME = makeindex
\r
759 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
\r
760 # LaTeX documents. This may be useful for small projects and may help to
\r
761 # save some trees in general.
\r
765 # The PAPER_TYPE tag can be used to set the paper type that is used
\r
766 # by the printer. Possible values are: a4, a4wide, letter, legal and
\r
767 # executive. If left blank a4wide will be used.
\r
769 PAPER_TYPE = a4wide
\r
771 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
\r
772 # packages that should be included in the LaTeX output.
\r
776 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
\r
777 # the generated latex document. The header should contain everything until
\r
778 # the first chapter. If it is left blank doxygen will generate a
\r
779 # standard header. Notice: only use this tag if you know what you are doing!
\r
783 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
\r
784 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
\r
785 # contain links (just like the HTML output) instead of page references
\r
786 # This makes the output suitable for online browsing using a pdf viewer.
\r
788 PDF_HYPERLINKS = NO
\r
790 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
\r
791 # plain latex in the generated Makefile. Set this option to YES to get a
\r
792 # higher quality PDF documentation.
\r
796 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
\r
797 # command to the generated LaTeX files. This will instruct LaTeX to keep
\r
798 # running if errors occur, instead of asking the user for help.
\r
799 # This option is also used when generating formulas in HTML.
\r
801 LATEX_BATCHMODE = NO
\r
803 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
\r
804 # include the index chapters (such as File Index, Compound Index, etc.)
\r
807 LATEX_HIDE_INDICES = NO
\r
809 #---------------------------------------------------------------------------
\r
810 # configuration options related to the RTF output
\r
811 #---------------------------------------------------------------------------
\r
813 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
\r
814 # The RTF output is optimized for Word 97 and may not look very pretty with
\r
815 # other RTF readers or editors.
\r
819 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
\r
820 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
\r
821 # put in front of it. If left blank `rtf' will be used as the default path.
\r
825 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
\r
826 # RTF documents. This may be useful for small projects and may help to
\r
827 # save some trees in general.
\r
831 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
\r
832 # will contain hyperlink fields. The RTF file will
\r
833 # contain links (just like the HTML output) instead of page references.
\r
834 # This makes the output suitable for online browsing using WORD or other
\r
835 # programs which support those fields.
\r
836 # Note: wordpad (write) and others do not support links.
\r
838 RTF_HYPERLINKS = NO
\r
840 # Load stylesheet definitions from file. Syntax is similar to doxygen's
\r
841 # config file, i.e. a series of assignments. You only have to provide
\r
842 # replacements, missing definitions are set to their default value.
\r
844 RTF_STYLESHEET_FILE =
\r
846 # Set optional variables used in the generation of an rtf document.
\r
847 # Syntax is similar to doxygen's config file.
\r
849 RTF_EXTENSIONS_FILE =
\r
851 #---------------------------------------------------------------------------
\r
852 # configuration options related to the man page output
\r
853 #---------------------------------------------------------------------------
\r
855 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
\r
856 # generate man pages
\r
860 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
\r
861 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
\r
862 # put in front of it. If left blank `man' will be used as the default path.
\r
866 # The MAN_EXTENSION tag determines the extension that is added to
\r
867 # the generated man pages (default is the subroutine's section .3)
\r
871 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
\r
872 # then it will generate one additional man file for each entity
\r
873 # documented in the real man page(s). These additional files
\r
874 # only source the real man page, but without them the man command
\r
875 # would be unable to find the correct page. The default is NO.
\r
879 #---------------------------------------------------------------------------
\r
880 # configuration options related to the XML output
\r
881 #---------------------------------------------------------------------------
\r
883 # If the GENERATE_XML tag is set to YES Doxygen will
\r
884 # generate an XML file that captures the structure of
\r
885 # the code including all documentation.
\r
889 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
\r
890 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
\r
891 # put in front of it. If left blank `xml' will be used as the default path.
\r
895 # The XML_SCHEMA tag can be used to specify an XML schema,
\r
896 # which can be used by a validating XML parser to check the
\r
897 # syntax of the XML files.
\r
901 # The XML_DTD tag can be used to specify an XML DTD,
\r
902 # which can be used by a validating XML parser to check the
\r
903 # syntax of the XML files.
\r
907 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
\r
908 # dump the program listings (including syntax highlighting
\r
909 # and cross-referencing information) to the XML output. Note that
\r
910 # enabling this will significantly increase the size of the XML output.
\r
912 XML_PROGRAMLISTING = YES
\r
914 #---------------------------------------------------------------------------
\r
915 # configuration options for the AutoGen Definitions output
\r
916 #---------------------------------------------------------------------------
\r
918 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
\r
919 # generate an AutoGen Definitions (see autogen.sf.net) file
\r
920 # that captures the structure of the code including all
\r
921 # documentation. Note that this feature is still experimental
\r
922 # and incomplete at the moment.
\r
924 GENERATE_AUTOGEN_DEF = NO
\r
926 #---------------------------------------------------------------------------
\r
927 # configuration options related to the Perl module output
\r
928 #---------------------------------------------------------------------------
\r
930 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
\r
931 # generate a Perl module file that captures the structure of
\r
932 # the code including all documentation. Note that this
\r
933 # feature is still experimental and incomplete at the
\r
936 GENERATE_PERLMOD = NO
\r
938 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
\r
939 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
\r
940 # to generate PDF and DVI output from the Perl module output.
\r
944 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
\r
945 # nicely formatted so it can be parsed by a human reader. This is useful
\r
946 # if you want to understand what is going on. On the other hand, if this
\r
947 # tag is set to NO the size of the Perl module output will be much smaller
\r
948 # and Perl will parse it just the same.
\r
950 PERLMOD_PRETTY = YES
\r
952 # The names of the make variables in the generated doxyrules.make file
\r
953 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
\r
954 # This is useful so different doxyrules.make files included by the same
\r
955 # Makefile don't overwrite each other's variables.
\r
957 PERLMOD_MAKEVAR_PREFIX =
\r
959 #---------------------------------------------------------------------------
\r
960 # Configuration options related to the preprocessor
\r
961 #---------------------------------------------------------------------------
\r
963 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
\r
964 # evaluate all C-preprocessor directives found in the sources and include
\r
967 ENABLE_PREPROCESSING = YES
\r
969 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
\r
970 # names in the source code. If set to NO (the default) only conditional
\r
971 # compilation will be performed. Macro expansion can be done in a controlled
\r
972 # way by setting EXPAND_ONLY_PREDEF to YES.
\r
974 MACRO_EXPANSION = YES
\r
976 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
\r
977 # then the macro expansion is limited to the macros specified with the
\r
978 # PREDEFINED and EXPAND_AS_DEFINED tags.
\r
980 EXPAND_ONLY_PREDEF = YES
\r
982 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
\r
983 # in the INCLUDE_PATH (see below) will be search if a #include is found.
\r
985 SEARCH_INCLUDES = YES
\r
987 # The INCLUDE_PATH tag can be used to specify one or more directories that
\r
988 # contain include files that are not input files but should be processed by
\r
989 # the preprocessor.
\r
993 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
\r
994 # patterns (like *.h and *.hpp) to filter out the header-files in the
\r
995 # directories. If left blank, the patterns specified with FILE_PATTERNS will
\r
998 INCLUDE_FILE_PATTERNS =
\r
1000 # The PREDEFINED tag can be used to specify one or more macro names that
\r
1001 # are defined before the preprocessor is started (similar to the -D option of
\r
1002 # gcc). The argument of the tag is a list of macros of the form: name
\r
1003 # or name=definition (no spaces). If the definition and the = are
\r
1004 # omitted =1 is assumed. To prevent a macro definition from being
\r
1005 # undefined via #undef or recursively expanded use the := operator
\r
1006 # instead of the = operator.
\r
1008 PREDEFINED = CONFIG_SSL_CERT_VERIFICATION CONFIG_SSL_ENABLE_CLIENT CONFIG_SSL_GENERATE_X509_CERT CONFIG_BIGINT_MONTGOMERY CONFIG_BIGINT_BARRETT CONFIG_BIGINT_CRT EXP_FUNC="" STDCALL=""
\r
1010 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
\r
1011 # this tag can be used to specify a list of macro names that should be expanded.
\r
1012 # The macro definition that is found in the sources will be used.
\r
1013 # Use the PREDEFINED tag if you want to use a different macro definition.
\r
1015 EXPAND_AS_DEFINED =
\r
1017 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
\r
1018 # doxygen's preprocessor will remove all function-like macros that are alone
\r
1019 # on a line, have an all uppercase name, and do not end with a semicolon. Such
\r
1020 # function macros are typically used for boiler-plate code, and will confuse
\r
1021 # the parser if not removed.
\r
1023 SKIP_FUNCTION_MACROS = YES
\r
1025 #---------------------------------------------------------------------------
\r
1026 # Configuration::additions related to external references
\r
1027 #---------------------------------------------------------------------------
\r
1029 # The TAGFILES option can be used to specify one or more tagfiles.
\r
1030 # Optionally an initial location of the external documentation
\r
1031 # can be added for each tagfile. The format of a tag file without
\r
1032 # this location is as follows:
\r
1033 # TAGFILES = file1 file2 ...
\r
1034 # Adding location for the tag files is done as follows:
\r
1035 # TAGFILES = file1=loc1 "file2 = loc2" ...
\r
1036 # where "loc1" and "loc2" can be relative or absolute paths or
\r
1037 # URLs. If a location is present for each tag, the installdox tool
\r
1038 # does not have to be run to correct the links.
\r
1039 # Note that each tag file must have a unique name
\r
1040 # (where the name does NOT include the path)
\r
1041 # If a tag file is not located in the directory in which doxygen
\r
1042 # is run, you must also specify the path to the tagfile here.
\r
1046 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
\r
1047 # a tag file that is based on the input files it reads.
\r
1049 GENERATE_TAGFILE =
\r
1051 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
\r
1052 # in the class index. If set to NO only the inherited external classes
\r
1057 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
\r
1058 # in the modules index. If set to NO, only the current project's groups will
\r
1061 EXTERNAL_GROUPS = NO
\r
1063 # The PERL_PATH should be the absolute path and name of the perl script
\r
1064 # interpreter (i.e. the result of `which perl').
\r
1066 PERL_PATH = /usr/bin/perl
\r
1068 #---------------------------------------------------------------------------
\r
1069 # Configuration options related to the dot tool
\r
1070 #---------------------------------------------------------------------------
\r
1072 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
\r
1073 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
\r
1074 # or super classes. Setting the tag to NO turns the diagrams off. Note that
\r
1075 # this option is superseded by the HAVE_DOT option below. This is only a
\r
1076 # fallback. It is recommended to install and use dot, since it yields more
\r
1077 # powerful graphs.
\r
1079 CLASS_DIAGRAMS = YES
\r
1081 # If set to YES, the inheritance and collaboration graphs will hide
\r
1082 # inheritance and usage relations if the target is undocumented
\r
1083 # or is not a class.
\r
1085 HIDE_UNDOC_RELATIONS = YES
\r
1087 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
\r
1088 # available from the path. This tool is part of Graphviz, a graph visualization
\r
1089 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
\r
1090 # have no effect if this option is set to NO (the default)
\r
1094 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
\r
1095 # will generate a graph for each documented class showing the direct and
\r
1096 # indirect inheritance relations. Setting this tag to YES will force the
\r
1097 # the CLASS_DIAGRAMS tag to NO.
\r
1101 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
\r
1102 # will generate a graph for each documented class showing the direct and
\r
1103 # indirect implementation dependencies (inheritance, containment, and
\r
1104 # class references variables) of the class with other documented classes.
\r
1106 COLLABORATION_GRAPH = NO
\r
1108 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
\r
1109 # will generate a graph for groups, showing the direct groups dependencies
\r
1113 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
\r
1114 # collaboration diagrams in a style similar to the OMG's Unified Modeling
\r
1119 # If set to YES, the inheritance and collaboration graphs will show the
\r
1120 # relations between templates and their instances.
\r
1122 TEMPLATE_RELATIONS = NO
\r
1124 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
\r
1125 # tags are set to YES then doxygen will generate a graph for each documented
\r
1126 # file showing the direct and indirect include dependencies of the file with
\r
1127 # other documented files.
\r
1129 INCLUDE_GRAPH = NO
\r
1131 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
\r
1132 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
\r
1133 # documented header file showing the documented files that directly or
\r
1134 # indirectly include this file.
\r
1136 INCLUDED_BY_GRAPH = NO
\r
1138 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
\r
1139 # generate a call dependency graph for every global function or class method.
\r
1140 # Note that enabling this option will significantly increase the time of a run.
\r
1141 # So in most cases it will be better to enable call graphs for selected
\r
1142 # functions only using the \callgraph command.
\r
1146 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
\r
1147 # will graphical hierarchy of all classes instead of a textual one.
\r
1149 GRAPHICAL_HIERARCHY = NO
\r
1151 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
\r
1152 # then doxygen will show the dependencies a directory has on other directories
\r
1153 # in a graphical way. The dependency relations are determined by the #include
\r
1154 # relations between the files in the directories.
\r
1156 DIRECTORY_GRAPH = NO
\r
1158 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
\r
1159 # generated by dot. Possible values are png, jpg, or gif
\r
1160 # If left blank png will be used.
\r
1162 DOT_IMAGE_FORMAT = png
\r
1164 # The tag DOT_PATH can be used to specify the path where the dot tool can be
\r
1165 # found. If left blank, it is assumed the dot tool can be found in the path.
\r
1169 # The DOTFILE_DIRS tag can be used to specify one or more directories that
\r
1170 # contain dot files that are included in the documentation (see the
\r
1171 # \dotfile command).
\r
1175 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
\r
1176 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
\r
1177 # this value, doxygen will try to truncate the graph, so that it fits within
\r
1178 # the specified constraint. Beware that most browsers cannot cope with very
\r
1181 MAX_DOT_GRAPH_WIDTH = 1024
\r
1183 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
\r
1184 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
\r
1185 # this value, doxygen will try to truncate the graph, so that it fits within
\r
1186 # the specified constraint. Beware that most browsers cannot cope with very
\r
1189 MAX_DOT_GRAPH_HEIGHT = 1024
\r
1191 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
\r
1192 # graphs generated by dot. A depth value of 3 means that only nodes reachable
\r
1193 # from the root by following a path via at most 3 edges will be shown. Nodes
\r
1194 # that lay further from the root node will be omitted. Note that setting this
\r
1195 # option to 1 or 2 may greatly reduce the computation time needed for large
\r
1196 # code bases. Also note that a graph may be further truncated if the graph's
\r
1197 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
\r
1198 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
\r
1199 # the graph is not depth-constrained.
\r
1201 MAX_DOT_GRAPH_DEPTH = 0
\r
1203 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
\r
1204 # background. This is disabled by default, which results in a white background.
\r
1205 # Warning: Depending on the platform used, enabling this option may lead to
\r
1206 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
\r
1209 DOT_TRANSPARENT = NO
\r
1211 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
\r
1212 # files in one run (i.e. multiple -o and -T options on the command line). This
\r
1213 # makes dot run faster, but since only newer versions of dot (>1.8.10)
\r
1214 # support this, this feature is disabled by default.
\r
1216 DOT_MULTI_TARGETS = NO
\r
1218 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
\r
1219 # generate a legend page explaining the meaning of the various boxes and
\r
1220 # arrows in the dot generated graphs.
\r
1222 GENERATE_LEGEND = YES
\r
1224 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
\r
1225 # remove the intermediate dot files that are used to generate
\r
1226 # the various graphs.
\r
1230 #---------------------------------------------------------------------------
\r
1231 # Configuration::additions related to the search engine
\r
1232 #---------------------------------------------------------------------------
\r
1234 # The SEARCHENGINE tag specifies whether or not a search engine should be
\r
1235 # used. If set to NO the values of all tags below this one will be ignored.
\r