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