Logo AND Algorithmique Numérique Distribuée

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