Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Tesh sort wanted output
[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  = YES
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        = @srcdir@
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      = NO
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  = YES
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 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
326 # determine which symbols to keep in memory and which to flush to disk.
327 # When the cache is full, less often used symbols will be written to disk.
328 # For small to medium size projects (<1000 input files) the default value is
329 # probably good enough. For larger projects a too small cache size can cause
330 # doxygen to be busy swapping symbols to and from disk most of the time
331 # causing a significant performance penalty.
332 # If the system has enough physical memory increasing the cache will improve the
333 # performance by keeping more symbols in memory. Note that the value works on
334 # a logarithmic scale so increasing the size by one will roughly double the
335 # memory usage. The cache size is given by this formula:
336 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
337 # corresponding to a cache size of 2^16 = 65536 symbols.
338
339 SYMBOL_CACHE_SIZE      = 0
340
341 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
342 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
343 # their name and scope. Since this can be an expensive process and often the
344 # same symbol appear multiple times in the code, doxygen keeps a cache of
345 # pre-resolved symbols. If the cache is too small doxygen will become slower.
346 # If the cache is too large, memory is wasted. The cache size is given by this
347 # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
348 # corresponding to a cache size of 2^16 = 65536 symbols.
349
350 LOOKUP_CACHE_SIZE      = 0
351
352 #---------------------------------------------------------------------------
353 # Build related configuration options
354 #---------------------------------------------------------------------------
355
356 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
357 # documentation are documented, even if no documentation was available.
358 # Private class members and static file members will be hidden unless
359 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
360
361 EXTRACT_ALL            = NO
362
363 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
364 # will be included in the documentation.
365
366 EXTRACT_PRIVATE        = NO
367
368 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation.
369
370 EXTRACT_PACKAGE        = NO
371
372 # If the EXTRACT_STATIC tag is set to YES all static members of a file
373 # will be included in the documentation.
374
375 EXTRACT_STATIC         = YES
376
377 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
378 # defined locally in source files will be included in the documentation.
379 # If set to NO only classes defined in header files are included.
380
381 EXTRACT_LOCAL_CLASSES  = YES
382
383 # This flag is only useful for Objective-C code. When set to YES local
384 # methods, which are defined in the implementation section but not in
385 # the interface are included in the documentation.
386 # If set to NO (the default) only methods in the interface are included.
387
388 EXTRACT_LOCAL_METHODS  = NO
389
390 # If this flag is set to YES, the members of anonymous namespaces will be
391 # extracted and appear in the documentation as a namespace called
392 # 'anonymous_namespace{file}', where file will be replaced with the base
393 # name of the file that contains the anonymous namespace. By default
394 # anonymous namespaces are hidden.
395
396 EXTRACT_ANON_NSPACES   = NO
397
398 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
399 # undocumented members of documented classes, files or namespaces.
400 # If set to NO (the default) these members will be included in the
401 # various overviews, but no documentation section is generated.
402 # This option has no effect if EXTRACT_ALL is enabled.
403
404 HIDE_UNDOC_MEMBERS     = YES
405
406 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
407 # undocumented classes that are normally visible in the class hierarchy.
408 # If set to NO (the default) these classes will be included in the various
409 # overviews. This option has no effect if EXTRACT_ALL is enabled.
410
411 HIDE_UNDOC_CLASSES     = YES
412
413 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
414 # friend (class|struct|union) declarations.
415 # If set to NO (the default) these declarations will be included in the
416 # documentation.
417
418 HIDE_FRIEND_COMPOUNDS  = NO
419
420 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
421 # documentation blocks found inside the body of a function.
422 # If set to NO (the default) these blocks will be appended to the
423 # function's detailed documentation block.
424
425 HIDE_IN_BODY_DOCS      = NO
426
427 # The INTERNAL_DOCS tag determines if documentation
428 # that is typed after a \internal command is included. If the tag is set
429 # to NO (the default) then the documentation will be excluded.
430 # Set it to YES to include the internal documentation.
431
432 INTERNAL_DOCS          = NO
433
434 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
435 # file names in lower-case letters. If set to YES upper-case letters are also
436 # allowed. This is useful if you have classes or files whose names only differ
437 # in case and if your file system supports case sensitive file names. Windows
438 # and Mac users are advised to set this option to NO.
439
440 CASE_SENSE_NAMES       = YES
441
442 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
443 # will show members with their full class and namespace scopes in the
444 # documentation. If set to YES the scope will be hidden.
445
446 HIDE_SCOPE_NAMES       = NO
447
448 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
449 # will put a list of the files that are included by a file in the documentation
450 # of that file.
451
452 SHOW_INCLUDE_FILES     = YES
453
454 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
455 # will list include files with double quotes in the documentation
456 # rather than with sharp brackets.
457
458 FORCE_LOCAL_INCLUDES   = NO
459
460 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
461 # is inserted in the documentation for inline members.
462
463 INLINE_INFO            = YES
464
465 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
466 # will sort the (detailed) documentation of file and class members
467 # alphabetically by member name. If set to NO the members will appear in
468 # declaration order.
469
470 SORT_MEMBER_DOCS       = NO
471
472 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
473 # brief documentation of file, namespace and class members alphabetically
474 # by member name. If set to NO (the default) the members will appear in
475 # declaration order.
476
477 SORT_BRIEF_DOCS        = NO
478
479 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
480 # will sort the (brief and detailed) documentation of class members so that
481 # constructors and destructors are listed first. If set to NO (the default)
482 # the constructors will appear in the respective orders defined by
483 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
484 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
485 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
486
487 SORT_MEMBERS_CTORS_1ST = NO
488
489 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
490 # hierarchy of group names into alphabetical order. If set to NO (the default)
491 # the group names will appear in their defined order.
492
493 SORT_GROUP_NAMES       = NO
494
495 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
496 # sorted by fully-qualified names, including namespaces. If set to
497 # NO (the default), the class list will be sorted only by class name,
498 # not including the namespace part.
499 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
500 # Note: This option applies only to the class list, not to the
501 # alphabetical list.
502
503 SORT_BY_SCOPE_NAME     = NO
504
505 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
506 # do proper type resolution of all parameters of a function it will reject a
507 # match between the prototype and the implementation of a member function even
508 # if there is only one candidate or it is obvious which candidate to choose
509 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
510 # will still accept a match between prototype and implementation in such cases.
511
512 STRICT_PROTO_MATCHING  = NO
513
514 # The GENERATE_TODOLIST tag can be used to enable (YES) or
515 # disable (NO) the todo list. This list is created by putting \todo
516 # commands in the documentation.
517
518 GENERATE_TODOLIST      = NO
519
520 # The GENERATE_TESTLIST tag can be used to enable (YES) or
521 # disable (NO) the test list. This list is created by putting \test
522 # commands in the documentation.
523
524 GENERATE_TESTLIST      = YES
525
526 # The GENERATE_BUGLIST tag can be used to enable (YES) or
527 # disable (NO) the bug list. This list is created by putting \bug
528 # commands in the documentation.
529
530 GENERATE_BUGLIST       = NO
531
532 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
533 # disable (NO) the deprecated list. This list is created by putting
534 # \deprecated commands in the documentation.
535
536 GENERATE_DEPRECATEDLIST= YES
537
538 # The ENABLED_SECTIONS tag can be used to enable conditional
539 # documentation sections, marked by \if sectionname ... \endif.
540
541 ENABLED_SECTIONS       =
542
543 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
544 # the initial value of a variable or macro consists of for it to appear in
545 # the documentation. If the initializer consists of more lines than specified
546 # here it will be hidden. Use a value of 0 to hide initializers completely.
547 # The appearance of the initializer of individual variables and macros in the
548 # documentation can be controlled using \showinitializer or \hideinitializer
549 # command in the documentation regardless of this setting.
550
551 MAX_INITIALIZER_LINES  = 30
552
553 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
554 # at the bottom of the documentation of classes and structs. If set to YES the
555 # list will mention the files that were used to generate the documentation.
556
557 SHOW_USED_FILES        = YES
558
559 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
560 # This will remove the Files entry from the Quick Index and from the
561 # Folder Tree View (if specified). The default is YES.
562
563 SHOW_FILES             = YES
564
565 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
566 # Namespaces page.
567 # This will remove the Namespaces entry from the Quick Index
568 # and from the Folder Tree View (if specified). The default is YES.
569
570 SHOW_NAMESPACES        = YES
571
572 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
573 # doxygen should invoke to get the current version for each file (typically from
574 # the version control system). Doxygen will invoke the program by executing (via
575 # popen()) the command <command> <input-file>, where <command> is the value of
576 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
577 # provided by doxygen. Whatever the program writes to standard output
578 # is used as the file version. See the manual for examples.
579
580 FILE_VERSION_FILTER    =
581
582 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
583 # by doxygen. The layout file controls the global structure of the generated
584 # output files in an output format independent way. The create the layout file
585 # that represents doxygen's defaults, run doxygen with the -l option.
586 # You can optionally specify a file name after the option, if omitted
587 # DoxygenLayout.xml will be used as the name of the layout file.
588
589 LAYOUT_FILE            = Layout.xml
590
591 # The CITE_BIB_FILES tag can be used to specify one or more bib files
592 # containing the references data. This must be a list of .bib files. The
593 # .bib extension is automatically appended if omitted. Using this command
594 # requires the bibtex tool to be installed. See also
595 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
596 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
597 # feature you need bibtex and perl available in the search path.
598
599 CITE_BIB_FILES         =
600
601 #---------------------------------------------------------------------------
602 # configuration options related to warning and progress messages
603 #---------------------------------------------------------------------------
604
605 # The QUIET tag can be used to turn on/off the messages that are generated
606 # by doxygen. Possible values are YES and NO. If left blank NO is used.
607
608 QUIET                  = YES
609
610 # The WARNINGS tag can be used to turn on/off the warning messages that are
611 # generated by doxygen. Possible values are YES and NO. If left blank
612 # NO is used.
613
614 WARNINGS               = YES
615
616 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
617 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
618 # automatically be disabled.
619
620 WARN_IF_UNDOCUMENTED   = NO
621
622 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
623 # potential errors in the documentation, such as not documenting some
624 # parameters in a documented function, or documenting parameters that
625 # don't exist or using markup commands wrongly.
626
627 WARN_IF_DOC_ERROR      = YES
628
629 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
630 # functions that are documented, but have no documentation for their parameters
631 # or return value. If set to NO (the default) doxygen will only warn about
632 # wrong or incomplete parameter documentation, but not about the absence of
633 # documentation.
634
635 WARN_NO_PARAMDOC       = YES
636
637 # The WARN_FORMAT tag determines the format of the warning messages that
638 # doxygen can produce. The string should contain the $file, $line, and $text
639 # tags, which will be replaced by the file and line number from which the
640 # warning originated and the warning text. Optionally the format may contain
641 # $version, which will be replaced by the version of the file (if it could
642 # be obtained via FILE_VERSION_FILTER)
643
644 WARN_FORMAT            = "$file:$line: $text"
645
646 # The WARN_LOGFILE tag can be used to specify a file to which warning
647 # and error messages should be written. If left blank the output is written
648 # to stderr.
649
650 WARN_LOGFILE           =
651
652 #---------------------------------------------------------------------------
653 # configuration options related to the input files
654 #---------------------------------------------------------------------------
655
656 # The INPUT tag can be used to specify the files and/or directories that contain
657 # documented source files. You may enter file names like "myfile.cpp" or
658 # directories like "/usr/src/myproject". Separate the files or directories
659 # with spaces.
660
661 INPUT                  = doxygen/index.doc \
662                          doxygen/getting_started.doc \
663                          doxygen/introduction.doc \
664                          doxygen/install.doc \
665                          doxygen/use.doc \   
666                            doxygen/platform.doc \
667                            doxygen/deployment.doc \
668                            doxygen/options.doc \
669                            doxygen/help.doc \
670                          doxygen/advanced.doc \
671                            doxygen/pls.doc \
672                            doxygen/bindings.doc \
673                            doxygen/internals.doc \
674                              doxygen/inside_doxygen.doc \
675                              doxygen/inside_extending.doc \
676                              doxygen/inside_cmake.doc \
677                              doxygen/inside_autotests.doc \
678                              doxygen/inside_release.doc \
679                            doxygen/contributing.doc \
680                          doxygen/tracing.doc \
681                          doxygen/FAQ.doc \
682                          doxygen/modules.doc \
683                            doxygen/module-xbt.doc \
684                            doxygen/module-msg.doc \
685                            doxygen/module-sd.doc \
686                            doxygen/module-surf.doc \
687                            doxygen/module-simix.doc \
688                            doxygen/module-smpi.doc \
689                            doxygen/module-trace.doc \
690                            index-API.doc \
691                          @top_srcdir@/doc/doxygen/logcategories.doc \
692                          @top_srcdir@/src/instr/ \
693                          @top_srcdir@/include/ \
694                          @top_srcdir@/include/msg \
695                          @top_srcdir@/include/xbt \
696                          @top_srcdir@/include/simdag \
697                          @top_srcdir@/include/simgrid \
698                          @top_srcdir@/src/include/surf \
699                          @top_srcdir@/src/xbt/ \
700                          @top_srcdir@/src/surf/ \
701                          @top_srcdir@/src/msg/ \
702                          @top_srcdir@/src/simdag \
703                          @top_srcdir@/src/simix
704
705
706 ###################################################
707 ##  PLEASE DON'T MESS WITH THE ORDER OF EXAMPLES ## (unless you know what you are doing, of course)
708 ###################################################
709
710 INPUT +=                 @top_srcdir@/examples/msg/sendrecv/sendrecv.c \
711                          @top_srcdir@/examples/msg/masterslave/masterslave_forwarder.c \
712                          @top_srcdir@/examples/msg/migration \
713                          @top_srcdir@/examples/msg/suspend \
714                          @top_srcdir@/examples/msg/properties \
715                          @top_srcdir@/examples/msg/parallel_task \
716                          @top_srcdir@/examples/msg/priority \
717                          @top_srcdir@/examples/msg/icomms/peer.c \
718                          @top_srcdir@/examples/msg/icomms/peer2.c \
719                          @top_srcdir@/examples/msg/icomms/peer3.c \
720                          @top_srcdir@/examples/msg/tracing/simple.c \
721                          @top_srcdir@/examples/msg/tracing/ms.c \
722                          @top_srcdir@/examples/msg/tracing/categories.c \
723                          @top_srcdir@/examples/msg/tracing/procmig.c \
724                          @top_srcdir@/examples/msg/tracing/trace_platform.c \
725                          @top_srcdir@/examples/msg/tracing/user_variables.c \
726                          @top_srcdir@/examples/msg/tracing/link_user_variables.c \
727                          @top_srcdir@/examples/msg/tracing/link_srcdst_user_variables.c \
728                          @top_srcdir@/examples/msg/ns3 \
729                          @top_srcdir@/examples/msg/gtnets \
730                          @top_srcdir@/examples/msg/io \
731                          @top_srcdir@/examples/msg/gpu \
732                          @top_srcdir@/examples/msg/actions \
733                          @top_srcdir@/examples/msg/token_ring \
734                          @top_srcdir@/examples/msg/pmm \
735                          @top_srcdir@/examples/msg/chord
736
737 # This tag can be used to specify the character encoding of the source files
738 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
739 # also the default input encoding. Doxygen uses libiconv (or the iconv built
740 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
741 # the list of possible encodings.
742
743 INPUT_ENCODING         = UTF-8
744
745 # If the value of the INPUT tag contains directories, you can use the
746 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
747 # and *.h) to filter out the source-files in the directories. If left
748 # blank the following patterns are tested:
749 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
750 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
751 # *.f90 *.f *.for *.vhd *.vhdl
752
753 FILE_PATTERNS          =
754
755 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
756 # should be searched for input files as well. Possible values are YES and NO.
757 # If left blank NO is used.
758
759 RECURSIVE              = NO
760
761 # The EXCLUDE tag can be used to specify files and/or directories that should be
762 # excluded from the INPUT source files. This way you can easily exclude a
763 # subdirectory from a directory tree whose root is specified with the INPUT tag.
764 # Note that relative paths are relative to the directory from which doxygen is
765 # run.
766
767 EXCLUDE                =
768
769 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
770 # directories that are symbolic links (a Unix file system feature) are excluded
771 # from the input.
772
773 EXCLUDE_SYMLINKS       = NO
774
775 # If the value of the INPUT tag contains directories, you can use the
776 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
777 # certain files from those directories. Note that the wildcards are matched
778 # against the file with absolute path, so to exclude all test directories
779 # for example use the pattern */test/*
780
781 EXCLUDE_PATTERNS       =
782
783 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
784 # (namespaces, classes, functions, etc.) that should be excluded from the
785 # output. The symbol name can be a fully qualified name, a word, or if the
786 # wildcard * is used, a substring. Examples: ANamespace, AClass,
787 # AClass::ANamespace, ANamespace::*Test
788
789 EXCLUDE_SYMBOLS        =
790
791 # The EXAMPLE_PATH tag can be used to specify one or more files or
792 # directories that contain example code fragments that are included (see
793 # the \include command).
794
795 EXAMPLE_PATH           = ./ \
796                          @top_srcdir@/src/surf/ \
797                          @top_srcdir@/src/xbt/ \
798                          @top_srcdir@/examples \
799                          @top_srcdir@/testsuite
800
801 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
802 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
803 # and *.h) to filter out the source-files in the directories. If left
804 # blank all files are included.
805
806 EXAMPLE_PATTERNS       =
807
808 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
809 # searched for input files to be used with the \include or \dontinclude
810 # commands irrespective of the value of the RECURSIVE tag.
811 # Possible values are YES and NO. If left blank NO is used.
812
813 EXAMPLE_RECURSIVE      = YES
814
815 # The IMAGE_PATH tag can be used to specify one or more files or
816 # directories that contain image that are included in the documentation (see
817 # the \image command).
818
819 IMAGE_PATH             = @top_srcdir@/doc \
820                          @top_srcdir@/doc/webcruft
821
822 # The INPUT_FILTER tag can be used to specify a program that doxygen should
823 # invoke to filter for each input file. Doxygen will invoke the filter program
824 # by executing (via popen()) the command <filter> <input-file>, where <filter>
825 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
826 # input file. Doxygen will then use the output that the filter program writes
827 # to standard output.
828 # If FILTER_PATTERNS is specified, this tag will be
829 # ignored.
830
831 INPUT_FILTER           =
832
833 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
834 # basis.
835 # Doxygen will compare the file name with each pattern and apply the
836 # filter if there is a match.
837 # The filters are a list of the form:
838 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
839 # info on how filters are used. If FILTER_PATTERNS is empty or if
840 # non of the patterns match the file name, INPUT_FILTER is applied.
841
842 FILTER_PATTERNS        =
843
844 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
845 # INPUT_FILTER) will be used to filter the input files when producing source
846 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
847
848 FILTER_SOURCE_FILES    = NO
849
850 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
851 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
852 # and it is also possible to disable source filtering for a specific pattern
853 # using *.ext= (so without naming a filter). This option only has effect when
854 # FILTER_SOURCE_FILES is enabled.
855
856 FILTER_SOURCE_PATTERNS =
857
858 #---------------------------------------------------------------------------
859 # configuration options related to source browsing
860 #---------------------------------------------------------------------------
861
862 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
863 # be generated. Documented entities will be cross-referenced with these sources.
864 # Note: To get rid of all source code in the generated output, make sure also
865 # VERBATIM_HEADERS is set to NO.
866
867 SOURCE_BROWSER         = NO
868
869 # Setting the INLINE_SOURCES tag to YES will include the body
870 # of functions and classes directly in the documentation.
871
872 INLINE_SOURCES         = NO
873
874 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
875 # doxygen to hide any special comment blocks from generated source code
876 # fragments. Normal C and C++ comments will always remain visible.
877
878 STRIP_CODE_COMMENTS    = YES
879
880 # If the REFERENCED_BY_RELATION tag is set to YES
881 # then for each documented function all documented
882 # functions referencing it will be listed.
883
884 REFERENCED_BY_RELATION = NO
885
886 # If the REFERENCES_RELATION tag is set to YES
887 # then for each documented function all documented entities
888 # called/used by that function will be listed.
889
890 REFERENCES_RELATION    = NO
891
892 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
893 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
894 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
895 # link to the source code.
896 # Otherwise they will link to the documentation.
897
898 REFERENCES_LINK_SOURCE = YES
899
900 # If the USE_HTAGS tag is set to YES then the references to source code
901 # will point to the HTML generated by the htags(1) tool instead of doxygen
902 # built-in source browser. The htags tool is part of GNU's global source
903 # tagging system (see http://www.gnu.org/software/global/global.html). You
904 # will need version 4.8.6 or higher.
905
906 USE_HTAGS              = NO
907
908 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
909 # will generate a verbatim copy of the header file for each class for
910 # which an include is specified. Set to NO to disable this.
911
912 VERBATIM_HEADERS       = NO
913
914 #---------------------------------------------------------------------------
915 # configuration options related to the alphabetical class index
916 #---------------------------------------------------------------------------
917
918 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
919 # of all compounds will be generated. Enable this if the project
920 # contains a lot of classes, structs, unions or interfaces.
921
922 ALPHABETICAL_INDEX     = NO
923
924 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
925 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
926 # in which this list will be split (can be a number in the range [1..20])
927
928 COLS_IN_ALPHA_INDEX    = 5
929
930 # In case all classes in a project start with a common prefix, all
931 # classes will be put under the same header in the alphabetical index.
932 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
933 # should be ignored while generating the index headers.
934
935 IGNORE_PREFIX          =
936
937 #---------------------------------------------------------------------------
938 # configuration options related to the HTML output
939 #---------------------------------------------------------------------------
940
941 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
942 # generate HTML output.
943
944 GENERATE_HTML          = YES
945
946 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
947 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
948 # put in front of it. If left blank `html' will be used as the default path.
949
950 HTML_OUTPUT            = html
951
952 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
953 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
954 # doxygen will generate files with .html extension.
955
956 HTML_FILE_EXTENSION    = .html
957
958 # The HTML_HEADER tag can be used to specify a personal HTML header for
959 # each generated HTML page. If it is left blank doxygen will generate a
960 # standard header. Note that when using a custom header you are responsible
961 #  for the proper inclusion of any scripts and style sheets that doxygen
962 # needs, which is dependent on the configuration options used.
963 # It is advised to generate a default header using "doxygen -w html
964 # header.html footer.html stylesheet.css YourConfigFile" and then modify
965 # that header. Note that the header is subject to change so you typically
966 # have to redo this when upgrading to a newer version of doxygen or when
967 # changing the value of configuration settings such as GENERATE_TREEVIEW!
968
969 HTML_HEADER            = doxygen/header.html 
970
971 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
972 # each generated HTML page. If it is left blank doxygen will generate a
973 # standard footer.
974
975 HTML_FOOTER            = doxygen/footer.html
976
977 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
978 # style sheet that is used by each HTML page. It can be used to
979 # fine-tune the look of the HTML output. If the tag is left blank doxygen
980 # will generate a default style sheet. Note that doxygen will try to copy
981 # the style sheet file to the HTML output directory, so don't put your own
982 # style sheet in the HTML output directory as well, or it will be erased!
983
984 HTML_STYLESHEET        = doxygen/stylesheet.css
985
986 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
987 # other source files which should be copied to the HTML output directory. Note
988 # that these files will be copied to the base HTML output directory. Use the
989 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
990 # files. In the HTML_STYLESHEET file, use the file name only. Also note that
991 # the files will be copied as-is; there are no commands or markers available.
992
993 HTML_EXTRA_FILES       =
994
995 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
996 # Doxygen will adjust the colors in the style sheet and background images
997 # according to this color. Hue is specified as an angle on a colorwheel,
998 # see http://en.wikipedia.org/wiki/Hue for more information.
999 # For instance the value 0 represents red, 60 is yellow, 120 is green,
1000 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
1001 # The allowed range is 0 to 359.
1002
1003 HTML_COLORSTYLE_HUE    = 220
1004
1005 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
1006 # the colors in the HTML output. For a value of 0 the output will use
1007 # grayscales only. A value of 255 will produce the most vivid colors.
1008
1009 HTML_COLORSTYLE_SAT    = 100
1010
1011 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
1012 # the luminance component of the colors in the HTML output. Values below
1013 # 100 gradually make the output lighter, whereas values above 100 make
1014 # the output darker. The value divided by 100 is the actual gamma applied,
1015 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
1016 # and 100 does not change the gamma.
1017
1018 HTML_COLORSTYLE_GAMMA  = 80
1019
1020 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1021 # page will contain the date and time when the page was generated. Setting
1022 # this to NO can help when comparing the output of multiple runs.
1023
1024 HTML_TIMESTAMP         = YES
1025
1026 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1027 # documentation will contain sections that can be hidden and shown after the
1028 # page has loaded.
1029
1030 HTML_DYNAMIC_SECTIONS  = NO
1031
1032 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
1033 # entries shown in the various tree structured indices initially; the user
1034 # can expand and collapse entries dynamically later on. Doxygen will expand
1035 # the tree to such a level that at most the specified number of entries are
1036 # visible (unless a fully collapsed tree already exceeds this amount).
1037 # So setting the number of entries 1 will produce a full collapsed tree by
1038 # default. 0 is a special value representing an infinite number of entries
1039 # and will result in a full expanded tree by default.
1040
1041 HTML_INDEX_NUM_ENTRIES = 100
1042
1043 # If the GENERATE_DOCSET tag is set to YES, additional index files
1044 # will be generated that can be used as input for Apple's Xcode 3
1045 # integrated development environment, introduced with OSX 10.5 (Leopard).
1046 # To create a documentation set, doxygen will generate a Makefile in the
1047 # HTML output directory. Running make will produce the docset in that
1048 # directory and running "make install" will install the docset in
1049 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1050 # it at startup.
1051 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1052 # for more information.
1053
1054 GENERATE_DOCSET        = NO
1055
1056 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1057 # feed. A documentation feed provides an umbrella under which multiple
1058 # documentation sets from a single provider (such as a company or product suite)
1059 # can be grouped.
1060
1061 DOCSET_FEEDNAME        = "Doxygen generated docs"
1062
1063 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1064 # should uniquely identify the documentation set bundle. This should be a
1065 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1066 # will append .docset to the name.
1067
1068 DOCSET_BUNDLE_ID       = org.doxygen.Project
1069
1070 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
1071 # the documentation publisher. This should be a reverse domain-name style
1072 # string, e.g. com.mycompany.MyDocSet.documentation.
1073
1074 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1075
1076 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1077
1078 DOCSET_PUBLISHER_NAME  = Publisher
1079
1080 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
1081 # will be generated that can be used as input for tools like the
1082 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1083 # of the generated HTML documentation.
1084
1085 GENERATE_HTMLHELP      = NO
1086
1087 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1088 # be used to specify the file name of the resulting .chm file. You
1089 # can add a path in front of the file if the result should not be
1090 # written to the html output directory.
1091
1092 CHM_FILE               =
1093
1094 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1095 # be used to specify the location (absolute path including file name) of
1096 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1097 # the HTML help compiler on the generated index.hhp.
1098
1099 HHC_LOCATION           =
1100
1101 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1102 # controls if a separate .chi index file is generated (YES) or that
1103 # it should be included in the master .chm file (NO).
1104
1105 GENERATE_CHI           = NO
1106
1107 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1108 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
1109 # content.
1110
1111 CHM_INDEX_ENCODING     =
1112
1113 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1114 # controls whether a binary table of contents is generated (YES) or a
1115 # normal table of contents (NO) in the .chm file.
1116
1117 BINARY_TOC             = NO
1118
1119 # The TOC_EXPAND flag can be set to YES to add extra items for group members
1120 # to the contents of the HTML help documentation and to the tree view.
1121
1122 TOC_EXPAND             = YES
1123
1124 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1125 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1126 # that can be used as input for Qt's qhelpgenerator to generate a
1127 # Qt Compressed Help (.qch) of the generated HTML documentation.
1128
1129 GENERATE_QHP           = NO
1130
1131 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1132 # be used to specify the file name of the resulting .qch file.
1133 # The path specified is relative to the HTML output folder.
1134
1135 QCH_FILE               =
1136
1137 # The QHP_NAMESPACE tag specifies the namespace to use when generating
1138 # Qt Help Project output. For more information please see
1139 # http://doc.trolltech.com/qthelpproject.html#namespace
1140
1141 QHP_NAMESPACE          = org.doxygen.Project
1142
1143 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1144 # Qt Help Project output. For more information please see
1145 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1146
1147 QHP_VIRTUAL_FOLDER     = doc
1148
1149 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1150 # add. For more information please see
1151 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1152
1153 QHP_CUST_FILTER_NAME   =
1154
1155 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1156 # custom filter to add. For more information please see
1157 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1158 # Qt Help Project / Custom Filters</a>.
1159
1160 QHP_CUST_FILTER_ATTRS  =
1161
1162 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1163 # project's
1164 # filter section matches.
1165 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1166 # Qt Help Project / Filter Attributes</a>.
1167
1168 QHP_SECT_FILTER_ATTRS  =
1169
1170 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1171 # be used to specify the location of Qt's qhelpgenerator.
1172 # If non-empty doxygen will try to run qhelpgenerator on the generated
1173 # .qhp file.
1174
1175 QHG_LOCATION           =
1176
1177 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1178 #  will be generated, which together with the HTML files, form an Eclipse help
1179 # plugin. To install this plugin and make it available under the help contents
1180 # menu in Eclipse, the contents of the directory containing the HTML and XML
1181 # files needs to be copied into the plugins directory of eclipse. The name of
1182 # the directory within the plugins directory should be the same as
1183 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1184 # the help appears.
1185
1186 GENERATE_ECLIPSEHELP   = NO
1187
1188 # A unique identifier for the eclipse help plugin. When installing the plugin
1189 # the directory name containing the HTML and XML files should also have
1190 # this name.
1191
1192 ECLIPSE_DOC_ID         = org.doxygen.Project
1193
1194 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1195 # at top of each HTML page. The value NO (the default) enables the index and
1196 # the value YES disables it. Since the tabs have the same information as the
1197 # navigation tree you can set this option to NO if you already set
1198 # GENERATE_TREEVIEW to YES.
1199
1200 DISABLE_INDEX          = YES
1201
1202 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1203 # structure should be generated to display hierarchical information.
1204 # If the tag value is set to YES, a side panel will be generated
1205 # containing a tree-like index structure (just like the one that
1206 # is generated for HTML Help). For this to work a browser that supports
1207 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1208 # Windows users are probably better off using the HTML help feature.
1209 # Since the tree basically has the same information as the tab index you
1210 # could consider to set DISABLE_INDEX to NO when enabling this option.
1211
1212 GENERATE_TREEVIEW      = YES
1213
1214 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1215 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
1216 # documentation. Note that a value of 0 will completely suppress the enum
1217 # values from appearing in the overview section.
1218
1219 ENUM_VALUES_PER_LINE   = 4
1220
1221 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1222 # used to set the initial width (in pixels) of the frame in which the tree
1223 # is shown.
1224
1225 TREEVIEW_WIDTH         = 250
1226
1227 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1228 # links to external symbols imported via tag files in a separate window.
1229
1230 EXT_LINKS_IN_WINDOW    = NO
1231
1232 # Use this tag to change the font size of Latex formulas included
1233 # as images in the HTML documentation. The default is 10. Note that
1234 # when you change the font size after a successful doxygen run you need
1235 # to manually remove any form_*.png images from the HTML output directory
1236 # to force them to be regenerated.
1237
1238 FORMULA_FONTSIZE       = 10
1239
1240 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1241 # generated for formulas are transparent PNGs. Transparent PNGs are
1242 # not supported properly for IE 6.0, but are supported on all modern browsers.
1243 # Note that when changing this option you need to delete any form_*.png files
1244 # in the HTML output before the changes have effect.
1245
1246 FORMULA_TRANSPARENT    = YES
1247
1248 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1249 # (see http://www.mathjax.org) which uses client side Javascript for the
1250 # rendering instead of using prerendered bitmaps. Use this if you do not
1251 # have LaTeX installed or if you want to formulas look prettier in the HTML
1252 # output. When enabled you may also need to install MathJax separately and
1253 # configure the path to it using the MATHJAX_RELPATH option.
1254
1255 USE_MATHJAX            = NO
1256
1257 # When MathJax is enabled you need to specify the location relative to the
1258 # HTML output directory using the MATHJAX_RELPATH option. The destination
1259 # directory should contain the MathJax.js script. For instance, if the mathjax
1260 # directory is located at the same level as the HTML output directory, then
1261 # MATHJAX_RELPATH should be ../mathjax. The default value points to
1262 # the MathJax Content Delivery Network so you can quickly see the result without
1263 # installing MathJax.
1264 # However, it is strongly recommended to install a local
1265 # copy of MathJax from http://www.mathjax.org before deployment.
1266
1267 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
1268
1269 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1270 # names that should be enabled during MathJax rendering.
1271
1272 MATHJAX_EXTENSIONS     =
1273
1274 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1275 # for the HTML output. The underlying search engine uses javascript
1276 # and DHTML and should work on any modern browser. Note that when using
1277 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1278 # (GENERATE_DOCSET) there is already a search function so this one should
1279 # typically be disabled. For large projects the javascript based search engine
1280 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1281
1282 SEARCHENGINE           = YES
1283
1284 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1285 # implemented using a PHP enabled web server instead of at the web client
1286 # using Javascript. Doxygen will generate the search PHP script and index
1287 # file to put on the web server. The advantage of the server
1288 # based approach is that it scales better to large projects and allows
1289 # full text search. The disadvantages are that it is more difficult to setup
1290 # and does not have live searching capabilities.
1291
1292 SERVER_BASED_SEARCH    = NO
1293
1294 #---------------------------------------------------------------------------
1295 # configuration options related to the LaTeX output
1296 #---------------------------------------------------------------------------
1297
1298 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1299 # generate Latex output.
1300
1301 GENERATE_LATEX         = YES
1302
1303 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1304 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1305 # put in front of it. If left blank `latex' will be used as the default path.
1306
1307 LATEX_OUTPUT           = latex
1308
1309 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1310 # invoked. If left blank `latex' will be used as the default command name.
1311 # Note that when enabling USE_PDFLATEX this option is only used for
1312 # generating bitmaps for formulas in the HTML output, but not in the
1313 # Makefile that is written to the output directory.
1314
1315 LATEX_CMD_NAME         = latex
1316
1317 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1318 # generate index for LaTeX. If left blank `makeindex' will be used as the
1319 # default command name.
1320
1321 MAKEINDEX_CMD_NAME     = makeindex
1322
1323 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1324 # LaTeX documents. This may be useful for small projects and may help to
1325 # save some trees in general.
1326
1327 COMPACT_LATEX          = YES
1328
1329 # The PAPER_TYPE tag can be used to set the paper type that is used
1330 # by the printer. Possible values are: a4, letter, legal and
1331 # executive. If left blank a4wide will be used.
1332
1333 PAPER_TYPE             = a4wide
1334
1335 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1336 # packages that should be included in the LaTeX output.
1337
1338 EXTRA_PACKAGES         = pdfpages
1339
1340 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1341 # the generated latex document. The header should contain everything until
1342 # the first chapter. If it is left blank doxygen will generate a
1343 # standard header. Notice: only use this tag if you know what you are doing!
1344
1345 LATEX_HEADER           =
1346
1347 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1348 # the generated latex document. The footer should contain everything after
1349 # the last chapter. If it is left blank doxygen will generate a
1350 # standard footer. Notice: only use this tag if you know what you are doing!
1351
1352 LATEX_FOOTER           =
1353
1354 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1355 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1356 # contain links (just like the HTML output) instead of page references
1357 # This makes the output suitable for online browsing using a pdf viewer.
1358
1359 PDF_HYPERLINKS         = YES
1360
1361 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1362 # plain latex in the generated Makefile. Set this option to YES to get a
1363 # higher quality PDF documentation.
1364
1365 USE_PDFLATEX           = YES
1366
1367 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1368 # command to the generated LaTeX files. This will instruct LaTeX to keep
1369 # running if errors occur, instead of asking the user for help.
1370 # This option is also used when generating formulas in HTML.
1371
1372 LATEX_BATCHMODE        = NO
1373
1374 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1375 # include the index chapters (such as File Index, Compound Index, etc.)
1376 # in the output.
1377
1378 LATEX_HIDE_INDICES     = YES
1379
1380 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1381 # source code with syntax highlighting in the LaTeX output.
1382 # Note that which sources are shown also depends on other settings
1383 # such as SOURCE_BROWSER.
1384
1385 LATEX_SOURCE_CODE      = NO
1386
1387 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1388 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1389 # http://en.wikipedia.org/wiki/BibTeX for more info.
1390
1391 LATEX_BIB_STYLE        = plain
1392
1393 #---------------------------------------------------------------------------
1394 # configuration options related to the RTF output
1395 #---------------------------------------------------------------------------
1396
1397 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1398 # The RTF output is optimized for Word 97 and may not look very pretty with
1399 # other RTF readers or editors.
1400
1401 GENERATE_RTF           = NO
1402
1403 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1404 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1405 # put in front of it. If left blank `rtf' will be used as the default path.
1406
1407 RTF_OUTPUT             = rtf
1408
1409 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1410 # RTF documents. This may be useful for small projects and may help to
1411 # save some trees in general.
1412
1413 COMPACT_RTF            = NO
1414
1415 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1416 # will contain hyperlink fields. The RTF file will
1417 # contain links (just like the HTML output) instead of page references.
1418 # This makes the output suitable for online browsing using WORD or other
1419 # programs which support those fields.
1420 # Note: wordpad (write) and others do not support links.
1421
1422 RTF_HYPERLINKS         = NO
1423
1424 # Load style sheet definitions from file. Syntax is similar to doxygen's
1425 # config file, i.e. a series of assignments. You only have to provide
1426 # replacements, missing definitions are set to their default value.
1427
1428 RTF_STYLESHEET_FILE    =
1429
1430 # Set optional variables used in the generation of an rtf document.
1431 # Syntax is similar to doxygen's config file.
1432
1433 RTF_EXTENSIONS_FILE    =
1434
1435 #---------------------------------------------------------------------------
1436 # configuration options related to the man page output
1437 #---------------------------------------------------------------------------
1438
1439 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1440 # generate man pages
1441
1442 GENERATE_MAN           = NO
1443
1444 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1445 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1446 # put in front of it. If left blank `man' will be used as the default path.
1447
1448 MAN_OUTPUT             = man
1449
1450 # The MAN_EXTENSION tag determines the extension that is added to
1451 # the generated man pages (default is the subroutine's section .3)
1452
1453 MAN_EXTENSION          = .3
1454
1455 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1456 # then it will generate one additional man file for each entity
1457 # documented in the real man page(s). These additional files
1458 # only source the real man page, but without them the man command
1459 # would be unable to find the correct page. The default is NO.
1460
1461 MAN_LINKS              = NO
1462
1463 #---------------------------------------------------------------------------
1464 # configuration options related to the XML output
1465 #---------------------------------------------------------------------------
1466
1467 # If the GENERATE_XML tag is set to YES Doxygen will
1468 # generate an XML file that captures the structure of
1469 # the code including all documentation.
1470
1471 GENERATE_XML           = NO
1472
1473 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1474 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1475 # put in front of it. If left blank `xml' will be used as the default path.
1476
1477 XML_OUTPUT             = xml
1478
1479 # The XML_SCHEMA tag can be used to specify an XML schema,
1480 # which can be used by a validating XML parser to check the
1481 # syntax of the XML files.
1482
1483 XML_SCHEMA             =
1484
1485 # The XML_DTD tag can be used to specify an XML DTD,
1486 # which can be used by a validating XML parser to check the
1487 # syntax of the XML files.
1488
1489 XML_DTD                =
1490
1491 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1492 # dump the program listings (including syntax highlighting
1493 # and cross-referencing information) to the XML output. Note that
1494 # enabling this will significantly increase the size of the XML output.
1495
1496 XML_PROGRAMLISTING     = YES
1497
1498 #---------------------------------------------------------------------------
1499 # configuration options for the AutoGen Definitions output
1500 #---------------------------------------------------------------------------
1501
1502 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1503 # generate an AutoGen Definitions (see autogen.sf.net) file
1504 # that captures the structure of the code including all
1505 # documentation. Note that this feature is still experimental
1506 # and incomplete at the moment.
1507
1508 GENERATE_AUTOGEN_DEF   = NO
1509
1510 #---------------------------------------------------------------------------
1511 # configuration options related to the Perl module output
1512 #---------------------------------------------------------------------------
1513
1514 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1515 # generate a Perl module file that captures the structure of
1516 # the code including all documentation. Note that this
1517 # feature is still experimental and incomplete at the
1518 # moment.
1519
1520 GENERATE_PERLMOD       = NO
1521
1522 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1523 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1524 # to generate PDF and DVI output from the Perl module output.
1525
1526 PERLMOD_LATEX          = NO
1527
1528 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1529 # nicely formatted so it can be parsed by a human reader.
1530 # This is useful
1531 # if you want to understand what is going on.
1532 # On the other hand, if this
1533 # tag is set to NO the size of the Perl module output will be much smaller
1534 # and Perl will parse it just the same.
1535
1536 PERLMOD_PRETTY         = YES
1537
1538 # The names of the make variables in the generated doxyrules.make file
1539 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1540 # This is useful so different doxyrules.make files included by the same
1541 # Makefile don't overwrite each other's variables.
1542
1543 PERLMOD_MAKEVAR_PREFIX =
1544
1545 #---------------------------------------------------------------------------
1546 # Configuration options related to the preprocessor
1547 #---------------------------------------------------------------------------
1548
1549 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1550 # evaluate all C-preprocessor directives found in the sources and include
1551 # files.
1552
1553 ENABLE_PREPROCESSING   = YES
1554
1555 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1556 # names in the source code. If set to NO (the default) only conditional
1557 # compilation will be performed. Macro expansion can be done in a controlled
1558 # way by setting EXPAND_ONLY_PREDEF to YES.
1559
1560 MACRO_EXPANSION        = YES
1561
1562 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1563 # then the macro expansion is limited to the macros specified with the
1564 # PREDEFINED and EXPAND_AS_DEFINED tags.
1565
1566 EXPAND_ONLY_PREDEF     = YES
1567
1568 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1569 # pointed to by INCLUDE_PATH will be searched when a #include is found.
1570
1571 SEARCH_INCLUDES        = YES
1572
1573 # The INCLUDE_PATH tag can be used to specify one or more directories that
1574 # contain include files that are not input files but should be processed by
1575 # the preprocessor.
1576
1577 INCLUDE_PATH           =
1578
1579 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1580 # patterns (like *.h and *.hpp) to filter out the header-files in the
1581 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1582 # be used.
1583
1584 INCLUDE_FILE_PATTERNS  =
1585
1586 # The PREDEFINED tag can be used to specify one or more macro names that
1587 # are defined before the preprocessor is started (similar to the -D option of
1588 # gcc). The argument of the tag is a list of macros of the form: name
1589 # or name=definition (no spaces). If the definition and the = are
1590 # omitted =1 is assumed. To prevent a macro definition from being
1591 # undefined via #undef or recursively expanded use the := operator
1592 # instead of the = operator.
1593
1594 PREDEFINED             = DOXYGEN \
1595                          DOXYGEN_SKIP_IT \
1596                          XBT_PUBLIC= \
1597                          XBT_INLINE= \
1598                          HAVE_TRACING \
1599                          MSG_USE_DEPRECATED
1600
1601 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1602 # this tag can be used to specify a list of macro names that should be expanded.
1603 # The macro definition that is found in the sources will be used.
1604 # Use the PREDEFINED tag if you want to use a different macro definition that
1605 # overrules the definition found in the source code.
1606
1607 EXPAND_AS_DEFINED      =
1608
1609 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1610 # doxygen's preprocessor will remove all references to function-like macros
1611 # that are alone on a line, have an all uppercase name, and do not end with a
1612 # semicolon, because these will confuse the parser if not removed.
1613
1614 SKIP_FUNCTION_MACROS   = YES
1615
1616 #---------------------------------------------------------------------------
1617 # Configuration::additions related to external references
1618 #---------------------------------------------------------------------------
1619
1620 # The TAGFILES option can be used to specify one or more tagfiles. For each
1621 # tag file the location of the external documentation should be added. The
1622 # format of a tag file without this location is as follows:
1623 #
1624 # TAGFILES = file1 file2 ...
1625 # Adding location for the tag files is done as follows:
1626 #
1627 # TAGFILES = file1=loc1 "file2 = loc2" ...
1628 # where "loc1" and "loc2" can be relative or absolute paths
1629 # or URLs. Note that each tag file must have a unique name (where the name does
1630 # NOT include the path). If a tag file is not located in the directory in which
1631 # doxygen is run, you must also specify the path to the tagfile here.
1632
1633 TAGFILES               = 
1634
1635 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1636 # a tag file that is based on the input files it reads.
1637
1638 GENERATE_TAGFILE       = simgrid.tag 
1639
1640 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1641 # in the class index. If set to NO only the inherited external classes
1642 # will be listed.
1643
1644 ALLEXTERNALS           = NO
1645
1646 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1647 # in the modules index. If set to NO, only the current project's groups will
1648 # be listed.
1649
1650 EXTERNAL_GROUPS        = NO
1651
1652 # The PERL_PATH should be the absolute path and name of the perl script
1653 # interpreter (i.e. the result of `which perl').
1654
1655 PERL_PATH              = /usr/bin/perl
1656
1657 #---------------------------------------------------------------------------
1658 # Configuration options related to the dot tool
1659 #---------------------------------------------------------------------------
1660
1661 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1662 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1663 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1664 # this option also works with HAVE_DOT disabled, but it is recommended to
1665 # install and use dot, since it yields more powerful graphs.
1666
1667 CLASS_DIAGRAMS         = YES
1668
1669 # You can define message sequence charts within doxygen comments using the \msc
1670 # command. Doxygen will then run the mscgen tool (see
1671 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1672 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1673 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1674 # default search path.
1675
1676 MSCGEN_PATH            =
1677
1678 # If set to YES, the inheritance and collaboration graphs will hide
1679 # inheritance and usage relations if the target is undocumented
1680 # or is not a class.
1681
1682 HIDE_UNDOC_RELATIONS   = YES
1683
1684 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1685 # available from the path. This tool is part of Graphviz, a graph visualization
1686 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1687 # have no effect if this option is set to NO (the default)
1688
1689 HAVE_DOT               = NO
1690
1691 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1692 # allowed to run in parallel. When set to 0 (the default) doxygen will
1693 # base this on the number of processors available in the system. You can set it
1694 # explicitly to a value larger than 0 to get control over the balance
1695 # between CPU load and processing speed.
1696
1697 DOT_NUM_THREADS        = 0
1698
1699 # By default doxygen will use the Helvetica font for all dot files that
1700 # doxygen generates. When you want a differently looking font you can specify
1701 # the font name using DOT_FONTNAME. You need to make sure dot is able to find
1702 # the font, which can be done by putting it in a standard location or by setting
1703 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1704 # directory containing the font.
1705
1706 DOT_FONTNAME           = Helvetica
1707
1708 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1709 # The default size is 10pt.
1710
1711 DOT_FONTSIZE           = 10
1712
1713 # By default doxygen will tell dot to use the Helvetica font.
1714 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1715 # set the path where dot can find it.
1716
1717 DOT_FONTPATH           =
1718
1719 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1720 # will generate a graph for each documented class showing the direct and
1721 # indirect inheritance relations. Setting this tag to YES will force the
1722 # CLASS_DIAGRAMS tag to NO.
1723
1724 CLASS_GRAPH            = YES
1725
1726 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1727 # will generate a graph for each documented class showing the direct and
1728 # indirect implementation dependencies (inheritance, containment, and
1729 # class references variables) of the class with other documented classes.
1730
1731 COLLABORATION_GRAPH    = YES
1732
1733 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1734 # will generate a graph for groups, showing the direct groups dependencies
1735
1736 GROUP_GRAPHS           = YES
1737
1738 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1739 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1740 # Language.
1741
1742 UML_LOOK               = NO
1743
1744 # If the UML_LOOK tag is enabled, the fields and methods are shown inside
1745 # the class node. If there are many fields or methods and many nodes the
1746 # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
1747 # threshold limits the number of items for each type to make the size more
1748 # managable. Set this to 0 for no limit. Note that the threshold may be
1749 # exceeded by 50% before the limit is enforced.
1750
1751 UML_LIMIT_NUM_FIELDS   = 10
1752
1753 # If set to YES, the inheritance and collaboration graphs will show the
1754 # relations between templates and their instances.
1755
1756 TEMPLATE_RELATIONS     = YES
1757
1758 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1759 # tags are set to YES then doxygen will generate a graph for each documented
1760 # file showing the direct and indirect include dependencies of the file with
1761 # other documented files.
1762
1763 INCLUDE_GRAPH          = YES
1764
1765 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1766 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1767 # documented header file showing the documented files that directly or
1768 # indirectly include this file.
1769
1770 INCLUDED_BY_GRAPH      = NO
1771
1772 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1773 # doxygen will generate a call dependency graph for every global function
1774 # or class method. Note that enabling this option will significantly increase
1775 # the time of a run. So in most cases it will be better to enable call graphs
1776 # for selected functions only using the \callgraph command.
1777
1778 CALL_GRAPH             = NO
1779
1780 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1781 # doxygen will generate a caller dependency graph for every global function
1782 # or class method. Note that enabling this option will significantly increase
1783 # the time of a run. So in most cases it will be better to enable caller
1784 # graphs for selected functions only using the \callergraph command.
1785
1786 CALLER_GRAPH           = YES
1787
1788 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1789 # will generate a graphical hierarchy of all classes instead of a textual one.
1790
1791 GRAPHICAL_HIERARCHY    = YES
1792
1793 # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
1794 # then doxygen will show the dependencies a directory has on other directories
1795 # in a graphical way. The dependency relations are determined by the #include
1796 # relations between the files in the directories.
1797
1798 DIRECTORY_GRAPH        = YES
1799
1800 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1801 # generated by dot. Possible values are svg, png, jpg, or gif.
1802 # If left blank png will be used. If you choose svg you need to set
1803 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1804 # visible in IE 9+ (other browsers do not have this requirement).
1805
1806 DOT_IMAGE_FORMAT       = png
1807
1808 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1809 # enable generation of interactive SVG images that allow zooming and panning.
1810 # Note that this requires a modern browser other than Internet Explorer.
1811 # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1812 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1813 # visible. Older versions of IE do not have SVG support.
1814
1815 INTERACTIVE_SVG        = NO
1816
1817 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1818 # found. If left blank, it is assumed the dot tool can be found in the path.
1819
1820 DOT_PATH               =
1821
1822 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1823 # contain dot files that are included in the documentation (see the
1824 # \dotfile command).
1825
1826 DOTFILE_DIRS           =
1827
1828 # The MSCFILE_DIRS tag can be used to specify one or more directories that
1829 # contain msc files that are included in the documentation (see the
1830 # \mscfile command).
1831
1832 MSCFILE_DIRS           =
1833
1834 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1835 # nodes that will be shown in the graph. If the number of nodes in a graph
1836 # becomes larger than this value, doxygen will truncate the graph, which is
1837 # visualized by representing a node as a red box. Note that doxygen if the
1838 # number of direct children of the root node in a graph is already larger than
1839 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1840 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1841
1842 DOT_GRAPH_MAX_NODES    = 50
1843
1844 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1845 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1846 # from the root by following a path via at most 3 edges will be shown. Nodes
1847 # that lay further from the root node will be omitted. Note that setting this
1848 # option to 1 or 2 may greatly reduce the computation time needed for large
1849 # code bases. Also note that the size of a graph can be further restricted by
1850 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1851
1852 MAX_DOT_GRAPH_DEPTH    = 0
1853
1854 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1855 # background. This is disabled by default, because dot on Windows does not
1856 # seem to support this out of the box. Warning: Depending on the platform used,
1857 # enabling this option may lead to badly anti-aliased labels on the edges of
1858 # a graph (i.e. they become hard to read).
1859
1860 DOT_TRANSPARENT        = NO
1861
1862 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1863 # files in one run (i.e. multiple -o and -T options on the command line). This
1864 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1865 # support this, this feature is disabled by default.
1866
1867 DOT_MULTI_TARGETS      = NO
1868
1869 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1870 # generate a legend page explaining the meaning of the various boxes and
1871 # arrows in the dot generated graphs.
1872
1873 GENERATE_LEGEND        = YES
1874
1875 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1876 # remove the intermediate dot files that are used to generate
1877 # the various graphs.
1878
1879 DOT_CLEANUP            = YES