]> git.ipfire.org Git - thirdparty/gcc.git/blob - libcilkrts/runtime/doxygen.cfg
[Patch AArch64] Fixup floating point division with -march=armv8-a+nosimd
[thirdparty/gcc.git] / libcilkrts / runtime / doxygen.cfg
1 # Doxyfile 1.7.4
2
3 # Copyright (C) 2011-2016, Intel Corporation
4 # All rights reserved.
5 #
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions
8 # are met:
9 #
10 # * Redistributions of source code must retain the above copyright
11 # notice, this list of conditions and the following disclaimer.
12 # * Redistributions in binary form must reproduce the above copyright
13 # notice, this list of conditions and the following disclaimer in
14 # the documentation and/or other materials provided with the
15 # distribution.
16 # * Neither the name of Intel Corporation nor the names of its
17 # contributors may be used to endorse or promote products derived
18 # from this software without specific prior written permission.
19 #
20 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 # HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25 # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26 # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27 # OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28 # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
30 # WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 # POSSIBILITY OF SUCH DAMAGE.
32 #
33 # *********************************************************************
34 #
35 # PLEASE NOTE: This file is a downstream copy of a file mainitained in
36 # a repository at cilkplus.org. Changes made to this file that are not
37 # submitted through the contribution process detailed at
38 # http://www.cilkplus.org/submit-cilk-contribution will be lost the next
39 # time that a new version is released. Changes only submitted to the
40 # GNU compiler collection or posted to the git repository at
41 # https://bitbucket.org/intelcilkruntime/intel-cilk-runtime.git are
42 # not tracked.
43 #
44 # We welcome your contributions to this open source project. Thank you
45 # for your assistance in helping us improve Cilk Plus.
46
47 # This file describes the settings to be used by the documentation system
48 # doxygen (www.doxygen.org) for a project.
49 #
50 # All text after a hash (#) is considered a comment and will be ignored.
51 # The format is:
52 # TAG = value [value, ...]
53 # For lists items can also be appended using:
54 # TAG += value [value, ...]
55 # Values that contain spaces should be placed between quotes (" ").
56
57 #---------------------------------------------------------------------------
58 # Project related configuration options
59 #---------------------------------------------------------------------------
60
61 # This tag specifies the encoding used for all characters in the config file
62 # that follow. The default is UTF-8 which is also the encoding used for all
63 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
64 # iconv built into libc) for the transcoding. See
65 # http://www.gnu.org/software/libiconv for the list of possible encodings.
66
67 DOXYFILE_ENCODING = UTF-8
68
69 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
70 # by quotes) that should identify the project.
71
72 PROJECT_NAME = "Intel Cilk Plus Runtime"
73
74 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
75 # This could be handy for archiving the generated documentation or
76 # if some version control system is used.
77
78 PROJECT_NUMBER =
79
80 # Using the PROJECT_BRIEF tag one can provide an optional one line description
81 # for a project that appears at the top of each page and should give viewer
82 # a quick idea about the purpose of the project. Keep the description short.
83
84 PROJECT_BRIEF =
85
86 # With the PROJECT_LOGO tag one can specify an logo or icon that is
87 # included in the documentation. The maximum height of the logo should not
88 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
89 # Doxygen will copy the logo to the output directory.
90
91 PROJECT_LOGO =
92
93 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
94 # base path where the generated documentation will be put.
95 # If a relative path is entered, it will be relative to the location
96 # where doxygen was started. If left blank the current directory will be used.
97
98 OUTPUT_DIRECTORY =
99
100 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
101 # 4096 sub-directories (in 2 levels) under the output directory of each output
102 # format and will distribute the generated files over these directories.
103 # Enabling this option can be useful when feeding doxygen a huge amount of
104 # source files, where putting all generated files in the same directory would
105 # otherwise cause performance problems for the file system.
106
107 CREATE_SUBDIRS = NO
108
109 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
110 # documentation generated by doxygen is written. Doxygen will use this
111 # information to generate all constant output in the proper language.
112 # The default language is English, other supported languages are:
113 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
114 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
115 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
116 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
117 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
118 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
119
120 OUTPUT_LANGUAGE = English
121
122 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
123 # include brief member descriptions after the members that are listed in
124 # the file and class documentation (similar to JavaDoc).
125 # Set to NO to disable this.
126
127 BRIEF_MEMBER_DESC = YES
128
129 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
130 # the brief description of a member or function before the detailed description.
131 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
132 # brief descriptions will be completely suppressed.
133
134 REPEAT_BRIEF = YES
135
136 # This tag implements a quasi-intelligent brief description abbreviator
137 # that is used to form the text in various listings. Each string
138 # in this list, if found as the leading text of the brief description, will be
139 # stripped from the text and the result after processing the whole list, is
140 # used as the annotated text. Otherwise, the brief description is used as-is.
141 # If left blank, the following values are used ("$name" is automatically
142 # replaced with the name of the entity): "The $name class" "The $name widget"
143 # "The $name file" "is" "provides" "specifies" "contains"
144 # "represents" "a" "an" "the"
145
146 ABBREVIATE_BRIEF =
147
148 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
149 # Doxygen will generate a detailed section even if there is only a brief
150 # description.
151
152 ALWAYS_DETAILED_SEC = NO
153
154 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
155 # inherited members of a class in the documentation of that class as if those
156 # members were ordinary class members. Constructors, destructors and assignment
157 # operators of the base classes will not be shown.
158
159 INLINE_INHERITED_MEMB = NO
160
161 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
162 # path before files name in the file list and in the header files. If set
163 # to NO the shortest path that makes the file name unique will be used.
164
165 FULL_PATH_NAMES = NO
166
167 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
168 # can be used to strip a user-defined part of the path. Stripping is
169 # only done if one of the specified strings matches the left-hand part of
170 # the path. The tag can be used to show relative paths in the file list.
171 # If left blank the directory from which doxygen is run is used as the
172 # path to strip.
173
174 STRIP_FROM_PATH =
175
176 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
177 # the path mentioned in the documentation of a class, which tells
178 # the reader which header file to include in order to use a class.
179 # If left blank only the name of the header file containing the class
180 # definition is used. Otherwise one should specify the include paths that
181 # are normally passed to the compiler using the -I flag.
182
183 STRIP_FROM_INC_PATH =
184
185 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
186 # (but less readable) file names. This can be useful if your file system
187 # doesn't support long names like on DOS, Mac, or CD-ROM.
188
189 SHORT_NAMES = NO
190
191 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
192 # will interpret the first line (until the first dot) of a JavaDoc-style
193 # comment as the brief description. If set to NO, the JavaDoc
194 # comments will behave just like regular Qt-style comments
195 # (thus requiring an explicit @brief command for a brief description.)
196
197 JAVADOC_AUTOBRIEF = NO
198
199 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
200 # interpret the first line (until the first dot) of a Qt-style
201 # comment as the brief description. If set to NO, the comments
202 # will behave just like regular Qt-style comments (thus requiring
203 # an explicit \brief command for a brief description.)
204
205 QT_AUTOBRIEF = NO
206
207 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
208 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
209 # comments) as a brief description. This used to be the default behaviour.
210 # The new default is to treat a multi-line C++ comment block as a detailed
211 # description. Set this tag to YES if you prefer the old behaviour instead.
212
213 MULTILINE_CPP_IS_BRIEF = NO
214
215 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
216 # member inherits the documentation from any documented member that it
217 # re-implements.
218
219 INHERIT_DOCS = YES
220
221 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
222 # a new page for each member. If set to NO, the documentation of a member will
223 # be part of the file/class/namespace that contains it.
224
225 SEPARATE_MEMBER_PAGES = NO
226
227 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
228 # Doxygen uses this value to replace tabs by spaces in code fragments.
229
230 TAB_SIZE = 8
231
232 # This tag can be used to specify a number of aliases that acts
233 # as commands in the documentation. An alias has the form "name=value".
234 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
235 # put the command \sideeffect (or @sideeffect) in the documentation, which
236 # will result in a user-defined paragraph with heading "Side Effects:".
237 # You can put \n's in the value part of an alias to insert newlines.
238
239 ALIASES =
240
241 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
242 # sources only. Doxygen will then generate output that is more tailored for C.
243 # For instance, some of the names that are used will be different. The list
244 # of all members will be omitted, etc.
245
246 OPTIMIZE_OUTPUT_FOR_C = NO
247
248 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
249 # sources only. Doxygen will then generate output that is more tailored for
250 # Java. For instance, namespaces will be presented as packages, qualified
251 # scopes will look different, etc.
252
253 OPTIMIZE_OUTPUT_JAVA = NO
254
255 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
256 # sources only. Doxygen will then generate output that is more tailored for
257 # Fortran.
258
259 OPTIMIZE_FOR_FORTRAN = NO
260
261 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
262 # sources. Doxygen will then generate output that is tailored for
263 # VHDL.
264
265 OPTIMIZE_OUTPUT_VHDL = NO
266
267 # Doxygen selects the parser to use depending on the extension of the files it
268 # parses. With this tag you can assign which parser to use for a given extension.
269 # Doxygen has a built-in mapping, but you can override or extend it using this
270 # tag. The format is ext=language, where ext is a file extension, and language
271 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
272 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
273 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
274 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
275 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
276
277 EXTENSION_MAPPING =
278
279 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
280 # to include (a tag file for) the STL sources as input, then you should
281 # set this tag to YES in order to let doxygen match functions declarations and
282 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
283 # func(std::string) {}). This also makes the inheritance and collaboration
284 # diagrams that involve STL classes more complete and accurate.
285
286 BUILTIN_STL_SUPPORT = NO
287
288 # If you use Microsoft's C++/CLI language, you should set this option to YES to
289 # enable parsing support.
290
291 CPP_CLI_SUPPORT = NO
292
293 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
294 # Doxygen will parse them like normal C++ but will assume all classes use public
295 # instead of private inheritance when no explicit protection keyword is present.
296
297 SIP_SUPPORT = NO
298
299 # For Microsoft's IDL there are propget and propput attributes to indicate getter
300 # and setter methods for a property. Setting this option to YES (the default)
301 # will make doxygen replace the get and set methods by a property in the
302 # documentation. This will only work if the methods are indeed getting or
303 # setting a simple type. If this is not the case, or you want to show the
304 # methods anyway, you should set this option to NO.
305
306 IDL_PROPERTY_SUPPORT = YES
307
308 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
309 # tag is set to YES, then doxygen will reuse the documentation of the first
310 # member in the group (if any) for the other members of the group. By default
311 # all members of a group must be documented explicitly.
312
313 DISTRIBUTE_GROUP_DOC = NO
314
315 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
316 # the same type (for instance a group of public functions) to be put as a
317 # subgroup of that type (e.g. under the Public Functions section). Set it to
318 # NO to prevent subgrouping. Alternatively, this can be done per class using
319 # the \nosubgrouping command.
320
321 SUBGROUPING = YES
322
323 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
324 # unions are shown inside the group in which they are included (e.g. using
325 # @ingroup) instead of on a separate page (for HTML and Man pages) or
326 # section (for LaTeX and RTF).
327
328 INLINE_GROUPED_CLASSES = NO
329
330 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
331 # is documented as struct, union, or enum with the name of the typedef. So
332 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
333 # with name TypeT. When disabled the typedef will appear as a member of a file,
334 # namespace, or class. And the struct will be named TypeS. This can typically
335 # be useful for C code in case the coding convention dictates that all compound
336 # types are typedef'ed and only the typedef is referenced, never the tag name.
337
338 TYPEDEF_HIDES_STRUCT = NO
339
340 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
341 # determine which symbols to keep in memory and which to flush to disk.
342 # When the cache is full, less often used symbols will be written to disk.
343 # For small to medium size projects (<1000 input files) the default value is
344 # probably good enough. For larger projects a too small cache size can cause
345 # doxygen to be busy swapping symbols to and from disk most of the time
346 # causing a significant performance penalty.
347 # If the system has enough physical memory increasing the cache will improve the
348 # performance by keeping more symbols in memory. Note that the value works on
349 # a logarithmic scale so increasing the size by one will roughly double the
350 # memory usage. The cache size is given by this formula:
351 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
352 # corresponding to a cache size of 2^16 = 65536 symbols
353
354 SYMBOL_CACHE_SIZE = 0
355
356 #---------------------------------------------------------------------------
357 # Build related configuration options
358 #---------------------------------------------------------------------------
359
360 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
361 # documentation are documented, even if no documentation was available.
362 # Private class members and static file members will be hidden unless
363 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
364
365 EXTRACT_ALL = NO
366
367 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
368 # will be included in the documentation.
369
370 EXTRACT_PRIVATE = NO
371
372 # If the EXTRACT_STATIC tag is set to YES all static members of a file
373 # will be included in the documentation.
374
375 EXTRACT_STATIC = NO
376
377 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
378 # defined locally in source files will be included in the documentation.
379 # If set to NO only classes defined in header files are included.
380
381 EXTRACT_LOCAL_CLASSES = YES
382
383 # This flag is only useful for Objective-C code. When set to YES local
384 # methods, which are defined in the implementation section but not in
385 # the interface are included in the documentation.
386 # If set to NO (the default) only methods in the interface are included.
387
388 EXTRACT_LOCAL_METHODS = NO
389
390 # If this flag is set to YES, the members of anonymous namespaces will be
391 # extracted and appear in the documentation as a namespace called
392 # 'anonymous_namespace{file}', where file will be replaced with the base
393 # name of the file that contains the anonymous namespace. By default
394 # anonymous namespaces are hidden.
395
396 EXTRACT_ANON_NSPACES = NO
397
398 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
399 # undocumented members of documented classes, files or namespaces.
400 # If set to NO (the default) these members will be included in the
401 # various overviews, but no documentation section is generated.
402 # This option has no effect if EXTRACT_ALL is enabled.
403
404 HIDE_UNDOC_MEMBERS = NO
405
406 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
407 # undocumented classes that are normally visible in the class hierarchy.
408 # If set to NO (the default) these classes will be included in the various
409 # overviews. This option has no effect if EXTRACT_ALL is enabled.
410
411 HIDE_UNDOC_CLASSES = NO
412
413 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
414 # friend (class|struct|union) declarations.
415 # If set to NO (the default) these declarations will be included in the
416 # documentation.
417
418 HIDE_FRIEND_COMPOUNDS = NO
419
420 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
421 # documentation blocks found inside the body of a function.
422 # If set to NO (the default) these blocks will be appended to the
423 # function's detailed documentation block.
424
425 HIDE_IN_BODY_DOCS = NO
426
427 # The INTERNAL_DOCS tag determines if documentation
428 # that is typed after a \internal command is included. If the tag is set
429 # to NO (the default) then the documentation will be excluded.
430 # Set it to YES to include the internal documentation.
431
432 INTERNAL_DOCS = NO
433
434 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
435 # file names in lower-case letters. If set to YES upper-case letters are also
436 # allowed. This is useful if you have classes or files whose names only differ
437 # in case and if your file system supports case sensitive file names. Windows
438 # and Mac users are advised to set this option to NO.
439
440 CASE_SENSE_NAMES = NO
441
442 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
443 # will show members with their full class and namespace scopes in the
444 # documentation. If set to YES the scope will be hidden.
445
446 HIDE_SCOPE_NAMES = NO
447
448 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
449 # will put a list of the files that are included by a file in the documentation
450 # of that file.
451
452 SHOW_INCLUDE_FILES = YES
453
454 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
455 # will list include files with double quotes in the documentation
456 # rather than with sharp brackets.
457
458 FORCE_LOCAL_INCLUDES = NO
459
460 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
461 # is inserted in the documentation for inline members.
462
463 INLINE_INFO = YES
464
465 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
466 # will sort the (detailed) documentation of file and class members
467 # alphabetically by member name. If set to NO the members will appear in
468 # declaration order.
469
470 SORT_MEMBER_DOCS = YES
471
472 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
473 # brief documentation of file, namespace and class members alphabetically
474 # by member name. If set to NO (the default) the members will appear in
475 # declaration order.
476
477 SORT_BRIEF_DOCS = NO
478
479 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
480 # will sort the (brief and detailed) documentation of class members so that
481 # constructors and destructors are listed first. If set to NO (the default)
482 # the constructors will appear in the respective orders defined by
483 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
484 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
485 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
486
487 SORT_MEMBERS_CTORS_1ST = NO
488
489 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
490 # hierarchy of group names into alphabetical order. If set to NO (the default)
491 # the group names will appear in their defined order.
492
493 SORT_GROUP_NAMES = YES
494
495 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
496 # sorted by fully-qualified names, including namespaces. If set to
497 # NO (the default), the class list will be sorted only by class name,
498 # not including the namespace part.
499 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
500 # Note: This option applies only to the class list, not to the
501 # alphabetical list.
502
503 SORT_BY_SCOPE_NAME = NO
504
505 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
506 # do proper type resolution of all parameters of a function it will reject a
507 # match between the prototype and the implementation of a member function even
508 # if there is only one candidate or it is obvious which candidate to choose
509 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
510 # will still accept a match between prototype and implementation in such cases.
511
512 STRICT_PROTO_MATCHING = NO
513
514 # The GENERATE_TODOLIST tag can be used to enable (YES) or
515 # disable (NO) the todo list. This list is created by putting \todo
516 # commands in the documentation.
517
518 GENERATE_TODOLIST = YES
519
520 # The GENERATE_TESTLIST tag can be used to enable (YES) or
521 # disable (NO) the test list. This list is created by putting \test
522 # commands in the documentation.
523
524 GENERATE_TESTLIST = YES
525
526 # The GENERATE_BUGLIST tag can be used to enable (YES) or
527 # disable (NO) the bug list. This list is created by putting \bug
528 # commands in the documentation.
529
530 GENERATE_BUGLIST = YES
531
532 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
533 # disable (NO) the deprecated list. This list is created by putting
534 # \deprecated commands in the documentation.
535
536 GENERATE_DEPRECATEDLIST= YES
537
538 # The ENABLED_SECTIONS tag can be used to enable conditional
539 # documentation sections, marked by \if sectionname ... \endif.
540
541 ENABLED_SECTIONS =
542
543 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
544 # the initial value of a variable or macro consists of for it to appear in
545 # the documentation. If the initializer consists of more lines than specified
546 # here it will be hidden. Use a value of 0 to hide initializers completely.
547 # The appearance of the initializer of individual variables and macros in the
548 # documentation can be controlled using \showinitializer or \hideinitializer
549 # command in the documentation regardless of this setting.
550
551 MAX_INITIALIZER_LINES = 30
552
553 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
554 # at the bottom of the documentation of classes and structs. If set to YES the
555 # list will mention the files that were used to generate the documentation.
556
557 SHOW_USED_FILES = YES
558
559 # If the sources in your project are distributed over multiple directories
560 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
561 # in the documentation. The default is NO.
562
563 SHOW_DIRECTORIES = NO
564
565 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
566 # This will remove the Files entry from the Quick Index and from the
567 # Folder Tree View (if specified). The default is YES.
568
569 SHOW_FILES = YES
570
571 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
572 # Namespaces page.
573 # This will remove the Namespaces entry from the Quick Index
574 # and from the Folder Tree View (if specified). The default is YES.
575
576 SHOW_NAMESPACES = YES
577
578 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
579 # doxygen should invoke to get the current version for each file (typically from
580 # the version control system). Doxygen will invoke the program by executing (via
581 # popen()) the command <command> <input-file>, where <command> is the value of
582 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
583 # provided by doxygen. Whatever the program writes to standard output
584 # is used as the file version. See the manual for examples.
585
586 FILE_VERSION_FILTER =
587
588 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
589 # by doxygen. The layout file controls the global structure of the generated
590 # output files in an output format independent way. The create the layout file
591 # that represents doxygen's defaults, run doxygen with the -l option.
592 # You can optionally specify a file name after the option, if omitted
593 # DoxygenLayout.xml will be used as the name of the layout file.
594
595 LAYOUT_FILE = doxygen-layout.xml
596
597 #---------------------------------------------------------------------------
598 # configuration options related to warning and progress messages
599 #---------------------------------------------------------------------------
600
601 # The QUIET tag can be used to turn on/off the messages that are generated
602 # by doxygen. Possible values are YES and NO. If left blank NO is used.
603
604 QUIET = NO
605
606 # The WARNINGS tag can be used to turn on/off the warning messages that are
607 # generated by doxygen. Possible values are YES and NO. If left blank
608 # NO is used.
609
610 WARNINGS = YES
611
612 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
613 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
614 # automatically be disabled.
615
616 WARN_IF_UNDOCUMENTED = YES
617
618 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
619 # potential errors in the documentation, such as not documenting some
620 # parameters in a documented function, or documenting parameters that
621 # don't exist or using markup commands wrongly.
622
623 WARN_IF_DOC_ERROR = YES
624
625 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
626 # functions that are documented, but have no documentation for their parameters
627 # or return value. If set to NO (the default) doxygen will only warn about
628 # wrong or incomplete parameter documentation, but not about the absence of
629 # documentation.
630
631 WARN_NO_PARAMDOC = NO
632
633 # The WARN_FORMAT tag determines the format of the warning messages that
634 # doxygen can produce. The string should contain the $file, $line, and $text
635 # tags, which will be replaced by the file and line number from which the
636 # warning originated and the warning text. Optionally the format may contain
637 # $version, which will be replaced by the version of the file (if it could
638 # be obtained via FILE_VERSION_FILTER)
639
640 WARN_FORMAT = "$file:$line: $text"
641
642 # The WARN_LOGFILE tag can be used to specify a file to which warning
643 # and error messages should be written. If left blank the output is written
644 # to stderr.
645
646 WARN_LOGFILE =
647
648 #---------------------------------------------------------------------------
649 # configuration options related to the input files
650 #---------------------------------------------------------------------------
651
652 # The INPUT tag can be used to specify the files and/or directories that contain
653 # documented source files. You may enter file names like "myfile.cpp" or
654 # directories like "/usr/src/myproject". Separate the files or directories
655 # with spaces.
656
657 INPUT = ./ \
658 ../include/internal/abi.h \
659 ../include/cilk/cilk_api.h \
660 ../include/cilk/common.h \
661 ./readme.dox
662
663
664 # This tag can be used to specify the character encoding of the source files
665 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
666 # also the default input encoding. Doxygen uses libiconv (or the iconv built
667 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
668 # the list of possible encodings.
669
670 INPUT_ENCODING = UTF-8
671
672 # If the value of the INPUT tag contains directories, you can use the
673 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
674 # and *.h) to filter out the source-files in the directories. If left
675 # blank the following patterns are tested:
676 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
677 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
678 # *.f90 *.f *.for *.vhd *.vhdl
679
680 FILE_PATTERNS =
681
682 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
683 # should be searched for input files as well. Possible values are YES and NO.
684 # If left blank NO is used.
685
686 RECURSIVE = NO
687
688 # The EXCLUDE tag can be used to specify files and/or directories that should
689 # excluded from the INPUT source files. This way you can easily exclude a
690 # subdirectory from a directory tree whose root is specified with the INPUT tag.
691
692 EXCLUDE = attributes.h \
693 cilk-ittnotify.h \
694 component.h \
695 rts-common.h \
696 windows-clean.h
697
698 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
699 # directories that are symbolic links (a Unix file system feature) are excluded
700 # from the input.
701
702 EXCLUDE_SYMLINKS = NO
703
704 # If the value of the INPUT tag contains directories, you can use the
705 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
706 # certain files from those directories. Note that the wildcards are matched
707 # against the file with absolute path, so to exclude all test directories
708 # for example use the pattern */test/*
709
710 EXCLUDE_PATTERNS =
711
712 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
713 # (namespaces, classes, functions, etc.) that should be excluded from the
714 # output. The symbol name can be a fully qualified name, a word, or if the
715 # wildcard * is used, a substring. Examples: ANamespace, AClass,
716 # AClass::ANamespace, ANamespace::*Test
717
718 EXCLUDE_SYMBOLS = _UNWIND_INFO \
719 _UNWIND_CODE \
720 _DISPATCHER_CONTEXT \
721 __cilkrts_stack \
722 pending_exception_info
723
724 # The EXAMPLE_PATH tag can be used to specify one or more files or
725 # directories that contain example code fragments that are included (see
726 # the \include command).
727
728 EXAMPLE_PATH =
729
730 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
731 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
732 # and *.h) to filter out the source-files in the directories. If left
733 # blank all files are included.
734
735 EXAMPLE_PATTERNS =
736
737 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
738 # searched for input files to be used with the \include or \dontinclude
739 # commands irrespective of the value of the RECURSIVE tag.
740 # Possible values are YES and NO. If left blank NO is used.
741
742 EXAMPLE_RECURSIVE = NO
743
744 # The IMAGE_PATH tag can be used to specify one or more files or
745 # directories that contain image that are included in the documentation (see
746 # the \image command).
747
748 IMAGE_PATH =
749
750 # The INPUT_FILTER tag can be used to specify a program that doxygen should
751 # invoke to filter for each input file. Doxygen will invoke the filter program
752 # by executing (via popen()) the command <filter> <input-file>, where <filter>
753 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
754 # input file. Doxygen will then use the output that the filter program writes
755 # to standard output.
756 # If FILTER_PATTERNS is specified, this tag will be
757 # ignored.
758
759 INPUT_FILTER =
760
761 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
762 # basis.
763 # Doxygen will compare the file name with each pattern and apply the
764 # filter if there is a match.
765 # The filters are a list of the form:
766 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
767 # info on how filters are used. If FILTER_PATTERNS is empty or if
768 # non of the patterns match the file name, INPUT_FILTER is applied.
769
770 FILTER_PATTERNS =
771
772 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
773 # INPUT_FILTER) will be used to filter the input files when producing source
774 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
775
776 FILTER_SOURCE_FILES = NO
777
778 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
779 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
780 # and it is also possible to disable source filtering for a specific pattern
781 # using *.ext= (so without naming a filter). This option only has effect when
782 # FILTER_SOURCE_FILES is enabled.
783
784 FILTER_SOURCE_PATTERNS =
785
786 #---------------------------------------------------------------------------
787 # configuration options related to source browsing
788 #---------------------------------------------------------------------------
789
790 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
791 # be generated. Documented entities will be cross-referenced with these sources.
792 # Note: To get rid of all source code in the generated output, make sure also
793 # VERBATIM_HEADERS is set to NO.
794
795 SOURCE_BROWSER = NO
796
797 # Setting the INLINE_SOURCES tag to YES will include the body
798 # of functions and classes directly in the documentation.
799
800 INLINE_SOURCES = NO
801
802 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
803 # doxygen to hide any special comment blocks from generated source code
804 # fragments. Normal C and C++ comments will always remain visible.
805
806 STRIP_CODE_COMMENTS = YES
807
808 # If the REFERENCED_BY_RELATION tag is set to YES
809 # then for each documented function all documented
810 # functions referencing it will be listed.
811
812 REFERENCED_BY_RELATION = NO
813
814 # If the REFERENCES_RELATION tag is set to YES
815 # then for each documented function all documented entities
816 # called/used by that function will be listed.
817
818 REFERENCES_RELATION = NO
819
820 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
821 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
822 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
823 # link to the source code.
824 # Otherwise they will link to the documentation.
825
826 REFERENCES_LINK_SOURCE = YES
827
828 # If the USE_HTAGS tag is set to YES then the references to source code
829 # will point to the HTML generated by the htags(1) tool instead of doxygen
830 # built-in source browser. The htags tool is part of GNU's global source
831 # tagging system (see http://www.gnu.org/software/global/global.html). You
832 # will need version 4.8.6 or higher.
833
834 USE_HTAGS = NO
835
836 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
837 # will generate a verbatim copy of the header file for each class for
838 # which an include is specified. Set to NO to disable this.
839
840 VERBATIM_HEADERS = YES
841
842 #---------------------------------------------------------------------------
843 # configuration options related to the alphabetical class index
844 #---------------------------------------------------------------------------
845
846 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
847 # of all compounds will be generated. Enable this if the project
848 # contains a lot of classes, structs, unions or interfaces.
849
850 ALPHABETICAL_INDEX = YES
851
852 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
853 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
854 # in which this list will be split (can be a number in the range [1..20])
855
856 COLS_IN_ALPHA_INDEX = 5
857
858 # In case all classes in a project start with a common prefix, all
859 # classes will be put under the same header in the alphabetical index.
860 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
861 # should be ignored while generating the index headers.
862
863 IGNORE_PREFIX =
864
865 #---------------------------------------------------------------------------
866 # configuration options related to the HTML output
867 #---------------------------------------------------------------------------
868
869 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
870 # generate HTML output.
871
872 GENERATE_HTML = YES
873
874 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
875 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
876 # put in front of it. If left blank `html' will be used as the default path.
877
878 HTML_OUTPUT = html
879
880 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
881 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
882 # doxygen will generate files with .html extension.
883
884 HTML_FILE_EXTENSION = .html
885
886 # The HTML_HEADER tag can be used to specify a personal HTML header for
887 # each generated HTML page. If it is left blank doxygen will generate a
888 # standard header. Note that when using a custom header you are responsible
889 # for the proper inclusion of any scripts and style sheets that doxygen
890 # needs, which is dependent on the configuration options used.
891 # It is adviced to generate a default header using "doxygen -w html
892 # header.html footer.html stylesheet.css YourConfigFile" and then modify
893 # that header. Note that the header is subject to change so you typically
894 # have to redo this when upgrading to a newer version of doxygen or when changing the value of configuration settings such as GENERATE_TREEVIEW!
895
896 HTML_HEADER =
897
898 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
899 # each generated HTML page. If it is left blank doxygen will generate a
900 # standard footer.
901
902 HTML_FOOTER =
903
904 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
905 # style sheet that is used by each HTML page. It can be used to
906 # fine-tune the look of the HTML output. If the tag is left blank doxygen
907 # will generate a default style sheet. Note that doxygen will try to copy
908 # the style sheet file to the HTML output directory, so don't put your own
909 # stylesheet in the HTML output directory as well, or it will be erased!
910
911 HTML_STYLESHEET =
912
913 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
914 # other source files which should be copied to the HTML output directory. Note
915 # that these files will be copied to the base HTML output directory. Use the
916 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
917 # files. In the HTML_STYLESHEET file, use the file name only. Also note that
918 # the files will be copied as-is; there are no commands or markers available.
919
920 HTML_EXTRA_FILES =
921
922 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
923 # Doxygen will adjust the colors in the stylesheet and background images
924 # according to this color. Hue is specified as an angle on a colorwheel,
925 # see http://en.wikipedia.org/wiki/Hue for more information.
926 # For instance the value 0 represents red, 60 is yellow, 120 is green,
927 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
928 # The allowed range is 0 to 359.
929
930 HTML_COLORSTYLE_HUE = 220
931
932 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
933 # the colors in the HTML output. For a value of 0 the output will use
934 # grayscales only. A value of 255 will produce the most vivid colors.
935
936 HTML_COLORSTYLE_SAT = 100
937
938 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
939 # the luminance component of the colors in the HTML output. Values below
940 # 100 gradually make the output lighter, whereas values above 100 make
941 # the output darker. The value divided by 100 is the actual gamma applied,
942 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
943 # and 100 does not change the gamma.
944
945 HTML_COLORSTYLE_GAMMA = 80
946
947 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
948 # page will contain the date and time when the page was generated. Setting
949 # this to NO can help when comparing the output of multiple runs.
950
951 HTML_TIMESTAMP = YES
952
953 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
954 # files or namespaces will be aligned in HTML using tables. If set to
955 # NO a bullet list will be used.
956
957 HTML_ALIGN_MEMBERS = YES
958
959 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
960 # documentation will contain sections that can be hidden and shown after the
961 # page has loaded. For this to work a browser that supports
962 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
963 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
964
965 HTML_DYNAMIC_SECTIONS = NO
966
967 # If the GENERATE_DOCSET tag is set to YES, additional index files
968 # will be generated that can be used as input for Apple's Xcode 3
969 # integrated development environment, introduced with OSX 10.5 (Leopard).
970 # To create a documentation set, doxygen will generate a Makefile in the
971 # HTML output directory. Running make will produce the docset in that
972 # directory and running "make install" will install the docset in
973 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
974 # it at startup.
975 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
976 # for more information.
977
978 GENERATE_DOCSET = NO
979
980 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
981 # feed. A documentation feed provides an umbrella under which multiple
982 # documentation sets from a single provider (such as a company or product suite)
983 # can be grouped.
984
985 DOCSET_FEEDNAME = "Doxygen generated docs"
986
987 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
988 # should uniquely identify the documentation set bundle. This should be a
989 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
990 # will append .docset to the name.
991
992 DOCSET_BUNDLE_ID = com.Intel.CilkPlusRuntime
993
994 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
995 # the documentation publisher. This should be a reverse domain-name style
996 # string, e.g. com.mycompany.MyDocSet.documentation.
997
998 DOCSET_PUBLISHER_ID = com.Intel.CilkPlusRuntime
999
1000 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1001
1002 DOCSET_PUBLISHER_NAME = "Intel Corporation"
1003
1004 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
1005 # will be generated that can be used as input for tools like the
1006 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1007 # of the generated HTML documentation.
1008
1009 GENERATE_HTMLHELP = NO
1010
1011 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1012 # be used to specify the file name of the resulting .chm file. You
1013 # can add a path in front of the file if the result should not be
1014 # written to the html output directory.
1015
1016 CHM_FILE =
1017
1018 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1019 # be used to specify the location (absolute path including file name) of
1020 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1021 # the HTML help compiler on the generated index.hhp.
1022
1023 HHC_LOCATION =
1024
1025 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1026 # controls if a separate .chi index file is generated (YES) or that
1027 # it should be included in the master .chm file (NO).
1028
1029 GENERATE_CHI = NO
1030
1031 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1032 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
1033 # content.
1034
1035 CHM_INDEX_ENCODING =
1036
1037 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1038 # controls whether a binary table of contents is generated (YES) or a
1039 # normal table of contents (NO) in the .chm file.
1040
1041 BINARY_TOC = NO
1042
1043 # The TOC_EXPAND flag can be set to YES to add extra items for group members
1044 # to the contents of the HTML help documentation and to the tree view.
1045
1046 TOC_EXPAND = NO
1047
1048 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1049 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1050 # that can be used as input for Qt's qhelpgenerator to generate a
1051 # Qt Compressed Help (.qch) of the generated HTML documentation.
1052
1053 GENERATE_QHP = NO
1054
1055 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1056 # be used to specify the file name of the resulting .qch file.
1057 # The path specified is relative to the HTML output folder.
1058
1059 QCH_FILE =
1060
1061 # The QHP_NAMESPACE tag specifies the namespace to use when generating
1062 # Qt Help Project output. For more information please see
1063 # http://doc.trolltech.com/qthelpproject.html#namespace
1064
1065 QHP_NAMESPACE = org.doxygen.Project
1066
1067 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1068 # Qt Help Project output. For more information please see
1069 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1070
1071 QHP_VIRTUAL_FOLDER = doc
1072
1073 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1074 # add. For more information please see
1075 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1076
1077 QHP_CUST_FILTER_NAME =
1078
1079 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1080 # custom filter to add. For more information please see
1081 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1082 # Qt Help Project / Custom Filters</a>.
1083
1084 QHP_CUST_FILTER_ATTRS =
1085
1086 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1087 # project's
1088 # filter section matches.
1089 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1090 # Qt Help Project / Filter Attributes</a>.
1091
1092 QHP_SECT_FILTER_ATTRS =
1093
1094 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1095 # be used to specify the location of Qt's qhelpgenerator.
1096 # If non-empty doxygen will try to run qhelpgenerator on the generated
1097 # .qhp file.
1098
1099 QHG_LOCATION =
1100
1101 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1102 # will be generated, which together with the HTML files, form an Eclipse help
1103 # plugin. To install this plugin and make it available under the help contents
1104 # menu in Eclipse, the contents of the directory containing the HTML and XML
1105 # files needs to be copied into the plugins directory of eclipse. The name of
1106 # the directory within the plugins directory should be the same as
1107 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1108 # the help appears.
1109
1110 GENERATE_ECLIPSEHELP = NO
1111
1112 # A unique identifier for the eclipse help plugin. When installing the plugin
1113 # the directory name containing the HTML and XML files should also have
1114 # this name.
1115
1116 ECLIPSE_DOC_ID = org.doxygen.Project
1117
1118 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1119 # top of each HTML page. The value NO (the default) enables the index and
1120 # the value YES disables it.
1121
1122 DISABLE_INDEX = NO
1123
1124 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1125 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
1126 # documentation. Note that a value of 0 will completely suppress the enum
1127 # values from appearing in the overview section.
1128
1129 ENUM_VALUES_PER_LINE = 4
1130
1131 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1132 # structure should be generated to display hierarchical information.
1133 # If the tag value is set to YES, a side panel will be generated
1134 # containing a tree-like index structure (just like the one that
1135 # is generated for HTML Help). For this to work a browser that supports
1136 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1137 # Windows users are probably better off using the HTML help feature.
1138
1139 GENERATE_TREEVIEW = NO
1140
1141 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1142 # and Class Hierarchy pages using a tree view instead of an ordered list.
1143
1144 USE_INLINE_TREES = NO
1145
1146 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1147 # used to set the initial width (in pixels) of the frame in which the tree
1148 # is shown.
1149
1150 TREEVIEW_WIDTH = 250
1151
1152 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1153 # links to external symbols imported via tag files in a separate window.
1154
1155 EXT_LINKS_IN_WINDOW = NO
1156
1157 # Use this tag to change the font size of Latex formulas included
1158 # as images in the HTML documentation. The default is 10. Note that
1159 # when you change the font size after a successful doxygen run you need
1160 # to manually remove any form_*.png images from the HTML output directory
1161 # to force them to be regenerated.
1162
1163 FORMULA_FONTSIZE = 10
1164
1165 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1166 # generated for formulas are transparent PNGs. Transparent PNGs are
1167 # not supported properly for IE 6.0, but are supported on all modern browsers.
1168 # Note that when changing this option you need to delete any form_*.png files
1169 # in the HTML output before the changes have effect.
1170
1171 FORMULA_TRANSPARENT = YES
1172
1173 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1174 # (see http://www.mathjax.org) which uses client side Javascript for the
1175 # rendering instead of using prerendered bitmaps. Use this if you do not
1176 # have LaTeX installed or if you want to formulas look prettier in the HTML
1177 # output. When enabled you also need to install MathJax separately and
1178 # configure the path to it using the MATHJAX_RELPATH option.
1179
1180 USE_MATHJAX = NO
1181
1182 # When MathJax is enabled you need to specify the location relative to the
1183 # HTML output directory using the MATHJAX_RELPATH option. The destination
1184 # directory should contain the MathJax.js script. For instance, if the mathjax
1185 # directory is located at the same level as the HTML output directory, then
1186 # MATHJAX_RELPATH should be ../mathjax. The default value points to the
1187 # mathjax.org site, so you can quickly see the result without installing
1188 # MathJax, but it is strongly recommended to install a local copy of MathJax
1189 # before deployment.
1190
1191 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
1192
1193 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1194 # for the HTML output. The underlying search engine uses javascript
1195 # and DHTML and should work on any modern browser. Note that when using
1196 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1197 # (GENERATE_DOCSET) there is already a search function so this one should
1198 # typically be disabled. For large projects the javascript based search engine
1199 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1200
1201 SEARCHENGINE = YES
1202
1203 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1204 # implemented using a PHP enabled web server instead of at the web client
1205 # using Javascript. Doxygen will generate the search PHP script and index
1206 # file to put on the web server. The advantage of the server
1207 # based approach is that it scales better to large projects and allows
1208 # full text search. The disadvantages are that it is more difficult to setup
1209 # and does not have live searching capabilities.
1210
1211 SERVER_BASED_SEARCH = NO
1212
1213 #---------------------------------------------------------------------------
1214 # configuration options related to the LaTeX output
1215 #---------------------------------------------------------------------------
1216
1217 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1218 # generate Latex output.
1219
1220 GENERATE_LATEX = NO
1221
1222 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1223 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1224 # put in front of it. If left blank `latex' will be used as the default path.
1225
1226 LATEX_OUTPUT = latex
1227
1228 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1229 # invoked. If left blank `latex' will be used as the default command name.
1230 # Note that when enabling USE_PDFLATEX this option is only used for
1231 # generating bitmaps for formulas in the HTML output, but not in the
1232 # Makefile that is written to the output directory.
1233
1234 LATEX_CMD_NAME = latex
1235
1236 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1237 # generate index for LaTeX. If left blank `makeindex' will be used as the
1238 # default command name.
1239
1240 MAKEINDEX_CMD_NAME = makeindex
1241
1242 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1243 # LaTeX documents. This may be useful for small projects and may help to
1244 # save some trees in general.
1245
1246 COMPACT_LATEX = NO
1247
1248 # The PAPER_TYPE tag can be used to set the paper type that is used
1249 # by the printer. Possible values are: a4, letter, legal and
1250 # executive. If left blank a4wide will be used.
1251
1252 PAPER_TYPE = a4
1253
1254 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1255 # packages that should be included in the LaTeX output.
1256
1257 EXTRA_PACKAGES =
1258
1259 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1260 # the generated latex document. The header should contain everything until
1261 # the first chapter. If it is left blank doxygen will generate a
1262 # standard header. Notice: only use this tag if you know what you are doing!
1263
1264 LATEX_HEADER =
1265
1266 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1267 # the generated latex document. The footer should contain everything after
1268 # the last chapter. If it is left blank doxygen will generate a
1269 # standard footer. Notice: only use this tag if you know what you are doing!
1270
1271 LATEX_FOOTER =
1272
1273 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1274 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1275 # contain links (just like the HTML output) instead of page references
1276 # This makes the output suitable for online browsing using a pdf viewer.
1277
1278 PDF_HYPERLINKS = YES
1279
1280 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1281 # plain latex in the generated Makefile. Set this option to YES to get a
1282 # higher quality PDF documentation.
1283
1284 USE_PDFLATEX = YES
1285
1286 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1287 # command to the generated LaTeX files. This will instruct LaTeX to keep
1288 # running if errors occur, instead of asking the user for help.
1289 # This option is also used when generating formulas in HTML.
1290
1291 LATEX_BATCHMODE = NO
1292
1293 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1294 # include the index chapters (such as File Index, Compound Index, etc.)
1295 # in the output.
1296
1297 LATEX_HIDE_INDICES = NO
1298
1299 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1300 # source code with syntax highlighting in the LaTeX output.
1301 # Note that which sources are shown also depends on other settings
1302 # such as SOURCE_BROWSER.
1303
1304 LATEX_SOURCE_CODE = NO
1305
1306 #---------------------------------------------------------------------------
1307 # configuration options related to the RTF output
1308 #---------------------------------------------------------------------------
1309
1310 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1311 # The RTF output is optimized for Word 97 and may not look very pretty with
1312 # other RTF readers or editors.
1313
1314 GENERATE_RTF = NO
1315
1316 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1317 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1318 # put in front of it. If left blank `rtf' will be used as the default path.
1319
1320 RTF_OUTPUT = rtf
1321
1322 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1323 # RTF documents. This may be useful for small projects and may help to
1324 # save some trees in general.
1325
1326 COMPACT_RTF = NO
1327
1328 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1329 # will contain hyperlink fields. The RTF file will
1330 # contain links (just like the HTML output) instead of page references.
1331 # This makes the output suitable for online browsing using WORD or other
1332 # programs which support those fields.
1333 # Note: wordpad (write) and others do not support links.
1334
1335 RTF_HYPERLINKS = NO
1336
1337 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1338 # config file, i.e. a series of assignments. You only have to provide
1339 # replacements, missing definitions are set to their default value.
1340
1341 RTF_STYLESHEET_FILE =
1342
1343 # Set optional variables used in the generation of an rtf document.
1344 # Syntax is similar to doxygen's config file.
1345
1346 RTF_EXTENSIONS_FILE =
1347
1348 #---------------------------------------------------------------------------
1349 # configuration options related to the man page output
1350 #---------------------------------------------------------------------------
1351
1352 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1353 # generate man pages
1354
1355 GENERATE_MAN = NO
1356
1357 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1358 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1359 # put in front of it. If left blank `man' will be used as the default path.
1360
1361 MAN_OUTPUT = man
1362
1363 # The MAN_EXTENSION tag determines the extension that is added to
1364 # the generated man pages (default is the subroutine's section .3)
1365
1366 MAN_EXTENSION = .3
1367
1368 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1369 # then it will generate one additional man file for each entity
1370 # documented in the real man page(s). These additional files
1371 # only source the real man page, but without them the man command
1372 # would be unable to find the correct page. The default is NO.
1373
1374 MAN_LINKS = NO
1375
1376 #---------------------------------------------------------------------------
1377 # configuration options related to the XML output
1378 #---------------------------------------------------------------------------
1379
1380 # If the GENERATE_XML tag is set to YES Doxygen will
1381 # generate an XML file that captures the structure of
1382 # the code including all documentation.
1383
1384 GENERATE_XML = NO
1385
1386 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1387 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1388 # put in front of it. If left blank `xml' will be used as the default path.
1389
1390 XML_OUTPUT = xml
1391
1392 # The XML_SCHEMA tag can be used to specify an XML schema,
1393 # which can be used by a validating XML parser to check the
1394 # syntax of the XML files.
1395
1396 XML_SCHEMA =
1397
1398 # The XML_DTD tag can be used to specify an XML DTD,
1399 # which can be used by a validating XML parser to check the
1400 # syntax of the XML files.
1401
1402 XML_DTD =
1403
1404 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1405 # dump the program listings (including syntax highlighting
1406 # and cross-referencing information) to the XML output. Note that
1407 # enabling this will significantly increase the size of the XML output.
1408
1409 XML_PROGRAMLISTING = YES
1410
1411 #---------------------------------------------------------------------------
1412 # configuration options for the AutoGen Definitions output
1413 #---------------------------------------------------------------------------
1414
1415 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1416 # generate an AutoGen Definitions (see autogen.sf.net) file
1417 # that captures the structure of the code including all
1418 # documentation. Note that this feature is still experimental
1419 # and incomplete at the moment.
1420
1421 GENERATE_AUTOGEN_DEF = NO
1422
1423 #---------------------------------------------------------------------------
1424 # configuration options related to the Perl module output
1425 #---------------------------------------------------------------------------
1426
1427 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1428 # generate a Perl module file that captures the structure of
1429 # the code including all documentation. Note that this
1430 # feature is still experimental and incomplete at the
1431 # moment.
1432
1433 GENERATE_PERLMOD = NO
1434
1435 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1436 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1437 # to generate PDF and DVI output from the Perl module output.
1438
1439 PERLMOD_LATEX = NO
1440
1441 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1442 # nicely formatted so it can be parsed by a human reader.
1443 # This is useful
1444 # if you want to understand what is going on.
1445 # On the other hand, if this
1446 # tag is set to NO the size of the Perl module output will be much smaller
1447 # and Perl will parse it just the same.
1448
1449 PERLMOD_PRETTY = YES
1450
1451 # The names of the make variables in the generated doxyrules.make file
1452 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1453 # This is useful so different doxyrules.make files included by the same
1454 # Makefile don't overwrite each other's variables.
1455
1456 PERLMOD_MAKEVAR_PREFIX =
1457
1458 #---------------------------------------------------------------------------
1459 # Configuration options related to the preprocessor
1460 #---------------------------------------------------------------------------
1461
1462 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1463 # evaluate all C-preprocessor directives found in the sources and include
1464 # files.
1465
1466 ENABLE_PREPROCESSING = YES
1467
1468 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1469 # names in the source code. If set to NO (the default) only conditional
1470 # compilation will be performed. Macro expansion can be done in a controlled
1471 # way by setting EXPAND_ONLY_PREDEF to YES.
1472
1473 MACRO_EXPANSION = YES
1474
1475 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1476 # then the macro expansion is limited to the macros specified with the
1477 # PREDEFINED and EXPAND_AS_DEFINED tags.
1478
1479 EXPAND_ONLY_PREDEF = YES
1480
1481 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1482 # pointed to by INCLUDE_PATH will be searched when a #include is found.
1483
1484 SEARCH_INCLUDES = YES
1485
1486 # The INCLUDE_PATH tag can be used to specify one or more directories that
1487 # contain include files that are not input files but should be processed by
1488 # the preprocessor.
1489
1490 INCLUDE_PATH =
1491
1492 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1493 # patterns (like *.h and *.hpp) to filter out the header-files in the
1494 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1495 # be used.
1496
1497 INCLUDE_FILE_PATTERNS =
1498
1499 # The PREDEFINED tag can be used to specify one or more macro names that
1500 # are defined before the preprocessor is started (similar to the -D option of
1501 # gcc). The argument of the tag is a list of macros of the form: name
1502 # or name=definition (no spaces). If the definition and the = are
1503 # omitted =1 is assumed. To prevent a macro definition from being
1504 # undefined via #undef or recursively expanded use the := operator
1505 # instead of the = operator.
1506
1507 PREDEFINED = _WIN32 \
1508 COMMON_SYSDEP= \
1509 COMMON_PORTABLE= \
1510 NON_COMMON= \
1511 __CILKRTS_BEGIN_EXTERN_C= \
1512 __CILKRTS_END_EXTERN_C= \
1513 CILK_API(t)=t \
1514 CILK_ABI(t)=t \
1515 CILK_ABI_THROWS(t)=t \
1516 CALLBACK= \
1517 __CILKRTS_INLINE=inline \
1518 __CILKRTS_ABI_VERSION=1 \
1519 __cplusplus \
1520
1521 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1522 # this tag can be used to specify a list of macro names that should be expanded.
1523 # The macro definition that is found in the sources will be used.
1524 # Use the PREDEFINED tag if you want to use a different macro definition that
1525 # overrules the definition found in the source code.
1526
1527 EXPAND_AS_DEFINED =
1528
1529 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1530 # doxygen's preprocessor will remove all references to function-like macros
1531 # that are alone on a line, have an all uppercase name, and do not end with a
1532 # semicolon, because these will confuse the parser if not removed.
1533
1534 SKIP_FUNCTION_MACROS = YES
1535
1536 #---------------------------------------------------------------------------
1537 # Configuration::additions related to external references
1538 #---------------------------------------------------------------------------
1539
1540 # The TAGFILES option can be used to specify one or more tagfiles.
1541 # Optionally an initial location of the external documentation
1542 # can be added for each tagfile. The format of a tag file without
1543 # this location is as follows:
1544 #
1545 # TAGFILES = file1 file2 ...
1546 # Adding location for the tag files is done as follows:
1547 #
1548 # TAGFILES = file1=loc1 "file2 = loc2" ...
1549 # where "loc1" and "loc2" can be relative or absolute paths or
1550 # URLs. If a location is present for each tag, the installdox tool
1551 # does not have to be run to correct the links.
1552 # Note that each tag file must have a unique name
1553 # (where the name does NOT include the path)
1554 # If a tag file is not located in the directory in which doxygen
1555 # is run, you must also specify the path to the tagfile here.
1556
1557 TAGFILES =
1558
1559 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1560 # a tag file that is based on the input files it reads.
1561
1562 GENERATE_TAGFILE =
1563
1564 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1565 # in the class index. If set to NO only the inherited external classes
1566 # will be listed.
1567
1568 ALLEXTERNALS = NO
1569
1570 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1571 # in the modules index. If set to NO, only the current project's groups will
1572 # be listed.
1573
1574 EXTERNAL_GROUPS = YES
1575
1576 # The PERL_PATH should be the absolute path and name of the perl script
1577 # interpreter (i.e. the result of `which perl').
1578
1579 PERL_PATH = /usr/bin/perl
1580
1581 #---------------------------------------------------------------------------
1582 # Configuration options related to the dot tool
1583 #---------------------------------------------------------------------------
1584
1585 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1586 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1587 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1588 # this option also works with HAVE_DOT disabled, but it is recommended to
1589 # install and use dot, since it yields more powerful graphs.
1590
1591 CLASS_DIAGRAMS = YES
1592
1593 # You can define message sequence charts within doxygen comments using the \msc
1594 # command. Doxygen will then run the mscgen tool (see
1595 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1596 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1597 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1598 # default search path.
1599
1600 MSCGEN_PATH =
1601
1602 # If set to YES, the inheritance and collaboration graphs will hide
1603 # inheritance and usage relations if the target is undocumented
1604 # or is not a class.
1605
1606 HIDE_UNDOC_RELATIONS = YES
1607
1608 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1609 # available from the path. This tool is part of Graphviz, a graph visualization
1610 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1611 # have no effect if this option is set to NO (the default)
1612
1613 HAVE_DOT = NO
1614
1615 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1616 # allowed to run in parallel. When set to 0 (the default) doxygen will
1617 # base this on the number of processors available in the system. You can set it
1618 # explicitly to a value larger than 0 to get control over the balance
1619 # between CPU load and processing speed.
1620
1621 DOT_NUM_THREADS = 0
1622
1623 # By default doxygen will write a font called Helvetica to the output
1624 # directory and reference it in all dot files that doxygen generates.
1625 # When you want a differently looking font you can specify the font name
1626 # using DOT_FONTNAME. You need to make sure dot is able to find the font,
1627 # which can be done by putting it in a standard location or by setting the
1628 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1629 # containing the font.
1630
1631 DOT_FONTNAME = Helvetica
1632
1633 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1634 # The default size is 10pt.
1635
1636 DOT_FONTSIZE = 10
1637
1638 # By default doxygen will tell dot to use the output directory to look for the
1639 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1640 # different font using DOT_FONTNAME you can set the path where dot
1641 # can find it using this tag.
1642
1643 DOT_FONTPATH =
1644
1645 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1646 # will generate a graph for each documented class showing the direct and
1647 # indirect inheritance relations. Setting this tag to YES will force the
1648 # the CLASS_DIAGRAMS tag to NO.
1649
1650 CLASS_GRAPH = YES
1651
1652 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1653 # will generate a graph for each documented class showing the direct and
1654 # indirect implementation dependencies (inheritance, containment, and
1655 # class references variables) of the class with other documented classes.
1656
1657 COLLABORATION_GRAPH = YES
1658
1659 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1660 # will generate a graph for groups, showing the direct groups dependencies
1661
1662 GROUP_GRAPHS = YES
1663
1664 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1665 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1666 # Language.
1667
1668 UML_LOOK = NO
1669
1670 # If set to YES, the inheritance and collaboration graphs will show the
1671 # relations between templates and their instances.
1672
1673 TEMPLATE_RELATIONS = NO
1674
1675 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1676 # tags are set to YES then doxygen will generate a graph for each documented
1677 # file showing the direct and indirect include dependencies of the file with
1678 # other documented files.
1679
1680 INCLUDE_GRAPH = YES
1681
1682 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1683 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1684 # documented header file showing the documented files that directly or
1685 # indirectly include this file.
1686
1687 INCLUDED_BY_GRAPH = YES
1688
1689 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1690 # doxygen will generate a call dependency graph for every global function
1691 # or class method. Note that enabling this option will significantly increase
1692 # the time of a run. So in most cases it will be better to enable call graphs
1693 # for selected functions only using the \callgraph command.
1694
1695 CALL_GRAPH = NO
1696
1697 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1698 # doxygen will generate a caller dependency graph for every global function
1699 # or class method. Note that enabling this option will significantly increase
1700 # the time of a run. So in most cases it will be better to enable caller
1701 # graphs for selected functions only using the \callergraph command.
1702
1703 CALLER_GRAPH = NO
1704
1705 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1706 # will generate a graphical hierarchy of all classes instead of a textual one.
1707
1708 GRAPHICAL_HIERARCHY = YES
1709
1710 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1711 # then doxygen will show the dependencies a directory has on other directories
1712 # in a graphical way. The dependency relations are determined by the #include
1713 # relations between the files in the directories.
1714
1715 DIRECTORY_GRAPH = YES
1716
1717 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1718 # generated by dot. Possible values are svg, png, jpg, or gif.
1719 # If left blank png will be used.
1720
1721 DOT_IMAGE_FORMAT = png
1722
1723 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1724 # found. If left blank, it is assumed the dot tool can be found in the path.
1725
1726 DOT_PATH =
1727
1728 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1729 # contain dot files that are included in the documentation (see the
1730 # \dotfile command).
1731
1732 DOTFILE_DIRS =
1733
1734 # The MSCFILE_DIRS tag can be used to specify one or more directories that
1735 # contain msc files that are included in the documentation (see the
1736 # \mscfile command).
1737
1738 MSCFILE_DIRS =
1739
1740 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1741 # nodes that will be shown in the graph. If the number of nodes in a graph
1742 # becomes larger than this value, doxygen will truncate the graph, which is
1743 # visualized by representing a node as a red box. Note that doxygen if the
1744 # number of direct children of the root node in a graph is already larger than
1745 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1746 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1747
1748 DOT_GRAPH_MAX_NODES = 50
1749
1750 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1751 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1752 # from the root by following a path via at most 3 edges will be shown. Nodes
1753 # that lay further from the root node will be omitted. Note that setting this
1754 # option to 1 or 2 may greatly reduce the computation time needed for large
1755 # code bases. Also note that the size of a graph can be further restricted by
1756 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1757
1758 MAX_DOT_GRAPH_DEPTH = 0
1759
1760 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1761 # background. This is disabled by default, because dot on Windows does not
1762 # seem to support this out of the box. Warning: Depending on the platform used,
1763 # enabling this option may lead to badly anti-aliased labels on the edges of
1764 # a graph (i.e. they become hard to read).
1765
1766 DOT_TRANSPARENT = NO
1767
1768 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1769 # files in one run (i.e. multiple -o and -T options on the command line). This
1770 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1771 # support this, this feature is disabled by default.
1772
1773 DOT_MULTI_TARGETS = NO
1774
1775 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1776 # generate a legend page explaining the meaning of the various boxes and
1777 # arrows in the dot generated graphs.
1778
1779 GENERATE_LEGEND = YES
1780
1781 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1782 # remove the intermediate dot files that are used to generate
1783 # the various graphs.
1784
1785 DOT_CLEANUP = YES