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