Logo AND Algorithmique Numérique Distribuée

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