ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/OpenMD/trunk/doc/Doxyfile.in
Revision: 2046
Committed: Tue Dec 2 22:11:04 2014 UTC (10 years, 7 months ago) by gezelter
File size: 102883 byte(s)
Log Message:
Fixed some broken comments for use with Doxygen.
Made changes to allow topology-based force-field overrides in include files.
Fixed a calculation of box quadrupole moments for molecules with point dipoles.

File Contents

# User Rev Content
1 gezelter 2046 # Doxyfile 1.8.7
2 tim 48
3 gezelter 1447 # This file describes the settings to be used by the documentation system
4 gezelter 1879 # doxygen (www.doxygen.org) for a project.
5 gezelter 1447 #
6 gezelter 2046 # All text after a double hash (##) is considered a comment and is placed in
7     # front of the TAG it is preceding.
8     #
9     # All text after a single hash (#) is considered a comment and will be ignored.
10 gezelter 1447 # The format is:
11 gezelter 2046 # 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 gezelter 1447
16 tim 48 #---------------------------------------------------------------------------
17     # Project related configuration options
18     #---------------------------------------------------------------------------
19 gezelter 1447
20     # This tag specifies the encoding used for all characters in the config file
21 gezelter 2046 # that follow. The default is UTF-8 which is also the encoding used for all text
22     # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23     # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24     # for the list of possible encodings.
25     # The default value is: UTF-8.
26 gezelter 1447
27     DOXYFILE_ENCODING = UTF-8
28    
29 gezelter 2046 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30     # double-quotes, unless you are using Doxywizard) that should identify the
31     # project for which the documentation is generated. This name is used in the
32     # title of most generated pages and in a few other places.
33     # The default value is: My Project.
34 gezelter 1447
35 gezelter 1390 PROJECT_NAME = OpenMD
36 gezelter 1447
37 gezelter 2046 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38     # could be handy for archiving the generated documentation or if some version
39     # control system is used.
40 gezelter 1447
41 gezelter 2046 PROJECT_NUMBER = 2.3
42 gezelter 1447
43 gezelter 1879 # Using the PROJECT_BRIEF tag one can provide an optional one line description
44 gezelter 2046 # for a project that appears at the top of each page and should give viewer a
45     # quick idea about the purpose of the project. Keep the description short.
46 gezelter 1879
47     PROJECT_BRIEF = "Molecular Dynamics in the Open"
48    
49 gezelter 2046 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
50     # the documentation. The maximum height of the logo should not exceed 55 pixels
51     # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
52     # to the output directory.
53 gezelter 1879
54     PROJECT_LOGO =
55    
56 gezelter 2046 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57     # into which the generated documentation will be written. If a relative path is
58     # entered, it will be relative to the location where doxygen was started. If
59     # left blank the current directory will be used.
60 gezelter 1447
61 gezelter 1651 OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@/doc/
62 gezelter 1447
63 gezelter 2046 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
64     # directories (in 2 levels) under the output directory of each output format and
65     # will distribute the generated files over these directories. Enabling this
66     # option can be useful when feeding doxygen a huge amount of source files, where
67     # putting all generated files in the same directory would otherwise causes
68     # performance problems for the file system.
69     # The default value is: NO.
70 gezelter 1447
71 tim 48 CREATE_SUBDIRS = NO
72 gezelter 1447
73 gezelter 2046 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74     # characters to appear in the names of generated files. If set to NO, non-ASCII
75     # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76     # U+3044.
77     # The default value is: NO.
78    
79     ALLOW_UNICODE_NAMES = NO
80    
81 gezelter 1447 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
82     # documentation generated by doxygen is written. Doxygen will use this
83     # information to generate all constant output in the proper language.
84 gezelter 2046 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85     # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86     # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87     # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88     # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89     # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90     # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91     # Ukrainian and Vietnamese.
92     # The default value is: English.
93 gezelter 1447
94 tim 48 OUTPUT_LANGUAGE = English
95 gezelter 1447
96 gezelter 2046 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
97     # descriptions after the members that are listed in the file and class
98     # documentation (similar to Javadoc). Set to NO to disable this.
99     # The default value is: YES.
100 gezelter 1447
101 tim 48 BRIEF_MEMBER_DESC = YES
102 gezelter 1447
103 gezelter 2046 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
104     # description of a member or function before the detailed description
105     #
106     # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
107 gezelter 1447 # brief descriptions will be completely suppressed.
108 gezelter 2046 # The default value is: YES.
109 gezelter 1447
110 tim 48 REPEAT_BRIEF = YES
111 gezelter 1447
112 gezelter 2046 # This tag implements a quasi-intelligent brief description abbreviator that is
113     # used to form the text in various listings. Each string in this list, if found
114     # as the leading text of the brief description, will be stripped from the text
115     # and the result, after processing the whole list, is used as the annotated
116     # text. Otherwise, the brief description is used as-is. If left blank, the
117     # following values are used ($name is automatically replaced with the name of
118     # the entity):The $name class, The $name widget, The $name file, is, provides,
119     # specifies, contains, represents, a, an and the.
120 gezelter 1447
121     ABBREVIATE_BRIEF =
122    
123     # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
124 gezelter 2046 # doxygen will generate a detailed section even if there is only a brief
125 gezelter 1447 # description.
126 gezelter 2046 # The default value is: NO.
127 gezelter 1447
128 tim 48 ALWAYS_DETAILED_SEC = NO
129 gezelter 1447
130     # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
131     # inherited members of a class in the documentation of that class as if those
132     # members were ordinary class members. Constructors, destructors and assignment
133     # operators of the base classes will not be shown.
134 gezelter 2046 # The default value is: NO.
135 gezelter 1447
136 tim 48 INLINE_INHERITED_MEMB = NO
137 gezelter 1447
138 gezelter 2046 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
139     # before files name in the file list and in the header files. If set to NO the
140     # shortest path that makes the file name unique will be used
141     # The default value is: YES.
142 gezelter 1447
143 tim 48 FULL_PATH_NAMES = YES
144 gezelter 1447
145 gezelter 2046 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
146     # Stripping is only done if one of the specified strings matches the left-hand
147     # part of the path. The tag can be used to show relative paths in the file list.
148     # If left blank the directory from which doxygen is run is used as the path to
149     # strip.
150     #
151     # Note that you can specify absolute paths here, but also relative paths, which
152     # will be relative from the directory where doxygen is started.
153     # This tag requires that the tag FULL_PATH_NAMES is set to YES.
154 gezelter 1447
155 gezelter 49 STRIP_FROM_PATH = src/
156 gezelter 1447
157 gezelter 2046 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158     # path mentioned in the documentation of a class, which tells the reader which
159     # header file to include in order to use a class. If left blank only the name of
160     # the header file containing the class definition is used. Otherwise one should
161     # specify the list of include paths that are normally passed to the compiler
162     # using the -I flag.
163 gezelter 1447
164     STRIP_FROM_INC_PATH =
165    
166 gezelter 2046 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
167     # less readable) file names. This can be useful is your file systems doesn't
168     # support long names like on DOS, Mac, or CD-ROM.
169     # The default value is: NO.
170 gezelter 1447
171 tim 48 SHORT_NAMES = NO
172 gezelter 1447
173 gezelter 2046 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
174     # first line (until the first dot) of a Javadoc-style comment as the brief
175     # description. If set to NO, the Javadoc-style will behave just like regular Qt-
176     # style comments (thus requiring an explicit @brief command for a brief
177     # description.)
178     # The default value is: NO.
179 gezelter 1447
180 tim 48 JAVADOC_AUTOBRIEF = NO
181 gezelter 1447
182 gezelter 2046 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
183     # line (until the first dot) of a Qt-style comment as the brief description. If
184     # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
185     # requiring an explicit \brief command for a brief description.)
186     # The default value is: NO.
187 gezelter 1447
188     QT_AUTOBRIEF = NO
189    
190 gezelter 2046 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
191     # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
192     # a brief description. This used to be the default behavior. The new default is
193     # to treat a multi-line C++ comment block as a detailed description. Set this
194     # tag to YES if you prefer the old behavior instead.
195     #
196     # Note that setting this tag to YES also means that rational rose comments are
197     # not recognized any more.
198     # The default value is: NO.
199 gezelter 1447
200 tim 48 MULTILINE_CPP_IS_BRIEF = NO
201 gezelter 1447
202 gezelter 2046 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
203     # documentation from any documented member that it re-implements.
204     # The default value is: YES.
205 gezelter 1447
206 tim 48 INHERIT_DOCS = YES
207 gezelter 1447
208 gezelter 2046 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
209     # new page for each member. If set to NO, the documentation of a member will be
210     # part of the file/class/namespace that contains it.
211     # The default value is: NO.
212 gezelter 1447
213     SEPARATE_MEMBER_PAGES = NO
214    
215 gezelter 2046 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
216     # uses this value to replace tabs by spaces in code fragments.
217     # Minimum value: 1, maximum value: 16, default value: 4.
218 gezelter 1447
219 tim 48 TAB_SIZE = 8
220 gezelter 1447
221 gezelter 2046 # This tag can be used to specify a number of aliases that act as commands in
222     # the documentation. An alias has the form:
223     # name=value
224     # For example adding
225     # "sideeffect=@par Side Effects:\n"
226     # will allow you to put the command \sideeffect (or @sideeffect) in the
227     # documentation, which will result in a user-defined paragraph with heading
228     # "Side Effects:". You can put \n's in the value part of an alias to insert
229     # newlines.
230 gezelter 1447
231     ALIASES =
232    
233 gezelter 1879 # This tag can be used to specify a number of word-keyword mappings (TCL only).
234 gezelter 2046 # A mapping has the form "name=value". For example adding "class=itcl::class"
235     # will allow you to use the command class in the itcl::class meaning.
236 gezelter 1879
237     TCL_SUBST =
238    
239 gezelter 2046 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
240     # only. Doxygen will then generate output that is more tailored for C. For
241     # instance, some of the names that are used will be different. The list of all
242     # members will be omitted, etc.
243     # The default value is: NO.
244 gezelter 1447
245 tim 48 OPTIMIZE_OUTPUT_FOR_C = NO
246 gezelter 1447
247 gezelter 2046 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
248     # Python sources only. Doxygen will then generate output that is more tailored
249     # for that language. For instance, namespaces will be presented as packages,
250     # qualified scopes will look different, etc.
251     # The default value is: NO.
252 gezelter 1447
253 tim 48 OPTIMIZE_OUTPUT_JAVA = NO
254 gezelter 1447
255     # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
256 gezelter 2046 # sources. Doxygen will then generate output that is tailored for Fortran.
257     # The default value is: NO.
258 gezelter 1447
259     OPTIMIZE_FOR_FORTRAN = NO
260    
261     # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
262 gezelter 2046 # sources. Doxygen will then generate output that is tailored for VHDL.
263     # The default value is: NO.
264 gezelter 1447
265     OPTIMIZE_OUTPUT_VHDL = NO
266    
267 gezelter 1879 # Doxygen selects the parser to use depending on the extension of the files it
268 gezelter 2046 # parses. With this tag you can assign which parser to use for a given
269     # extension. Doxygen has a built-in mapping, but you can override or extend it
270     # using this tag. The format is ext=language, where ext is a file extension, and
271     # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
272     # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
273     # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
274     # Fortran. In the later case the parser tries to guess whether the code is fixed
275     # or free formatted code, this is the default for Fortran type files), VHDL. For
276     # instance to make doxygen treat .inc files as Fortran files (default is PHP),
277     # and .f files as C (default is Fortran), use: inc=Fortran f=C.
278     #
279     # Note For files without extension you can use no_extension as a placeholder.
280     #
281     # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
282     # the files are not read by doxygen.
283 gezelter 1447
284 gezelter 1879 EXTENSION_MAPPING = F90=Fortran \
285     cpp=C++ \
286     hpp=C++ \
287     c=C \
288     h=C
289 gezelter 1447
290 gezelter 2046 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
291     # according to the Markdown format, which allows for more readable
292 gezelter 1879 # documentation. See http://daringfireball.net/projects/markdown/ for details.
293 gezelter 2046 # The output of markdown processing is further processed by doxygen, so you can
294     # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
295     # case of backward compatibilities issues.
296     # The default value is: YES.
297 gezelter 1879
298     MARKDOWN_SUPPORT = YES
299    
300 gezelter 2046 # When enabled doxygen tries to link words that correspond to documented
301     # classes, or namespaces to their corresponding documentation. Such a link can
302     # be prevented in individual cases by by putting a % sign in front of the word
303     # or globally by setting AUTOLINK_SUPPORT to NO.
304     # The default value is: YES.
305    
306     AUTOLINK_SUPPORT = YES
307    
308 gezelter 1447 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
309 gezelter 2046 # to include (a tag file for) the STL sources as input, then you should set this
310     # tag to YES in order to let doxygen match functions declarations and
311     # definitions whose arguments contain STL classes (e.g. func(std::string);
312     # versus func(std::string) {}). This also make the inheritance and collaboration
313 gezelter 1447 # diagrams that involve STL classes more complete and accurate.
314 gezelter 2046 # The default value is: NO.
315 gezelter 1447
316     BUILTIN_STL_SUPPORT = YES
317    
318     # If you use Microsoft's C++/CLI language, you should set this option to YES to
319     # enable parsing support.
320 gezelter 2046 # The default value is: NO.
321 gezelter 1447
322     CPP_CLI_SUPPORT = NO
323    
324 gezelter 2046 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
325     # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
326     # will parse them like normal C++ but will assume all classes use public instead
327     # of private inheritance when no explicit protection keyword is present.
328     # The default value is: NO.
329 gezelter 1447
330     SIP_SUPPORT = NO
331    
332 gezelter 2046 # For Microsoft's IDL there are propget and propput attributes to indicate
333     # getter and setter methods for a property. Setting this option to YES will make
334     # doxygen to replace the get and set methods by a property in the documentation.
335     # This will only work if the methods are indeed getting or setting a simple
336     # type. If this is not the case, or you want to show the methods anyway, you
337     # should set this option to NO.
338     # The default value is: YES.
339 gezelter 1447
340     IDL_PROPERTY_SUPPORT = YES
341    
342     # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
343     # tag is set to YES, then doxygen will reuse the documentation of the first
344     # member in the group (if any) for the other members of the group. By default
345     # all members of a group must be documented explicitly.
346 gezelter 2046 # The default value is: NO.
347 gezelter 1447
348     DISTRIBUTE_GROUP_DOC = NO
349    
350 gezelter 2046 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
351     # (for instance a group of public functions) to be put as a subgroup of that
352     # type (e.g. under the Public Functions section). Set it to NO to prevent
353     # subgrouping. Alternatively, this can be done per class using the
354     # \nosubgrouping command.
355     # The default value is: YES.
356 gezelter 1447
357 tim 48 SUBGROUPING = YES
358 gezelter 1447
359 gezelter 2046 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
360     # are shown inside the group in which they are included (e.g. using \ingroup)
361     # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
362     # and RTF).
363     #
364     # Note that this feature does not work in combination with
365     # SEPARATE_MEMBER_PAGES.
366     # The default value is: NO.
367 gezelter 1879
368     INLINE_GROUPED_CLASSES = NO
369    
370 gezelter 2046 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
371     # with only public data fields or simple typedef fields will be shown inline in
372     # the documentation of the scope in which they are defined (i.e. file,
373     # namespace, or group documentation), provided this scope is documented. If set
374     # to NO, structs, classes, and unions are shown on a separate page (for HTML and
375     # Man pages) or section (for LaTeX and RTF).
376     # The default value is: NO.
377 gezelter 1879
378     INLINE_SIMPLE_STRUCTS = NO
379    
380 gezelter 2046 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
381     # enum is documented as struct, union, or enum with the name of the typedef. So
382 gezelter 1447 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
383     # with name TypeT. When disabled the typedef will appear as a member of a file,
384 gezelter 2046 # namespace, or class. And the struct will be named TypeS. This can typically be
385     # useful for C code in case the coding convention dictates that all compound
386 gezelter 1447 # types are typedef'ed and only the typedef is referenced, never the tag name.
387 gezelter 2046 # The default value is: NO.
388 gezelter 1447
389     TYPEDEF_HIDES_STRUCT = NO
390    
391 gezelter 2046 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
392     # cache is used to resolve symbols given their name and scope. Since this can be
393     # an expensive process and often the same symbol appears multiple times in the
394     # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
395     # doxygen will become slower. If the cache is too large, memory is wasted. The
396     # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
397     # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
398     # symbols. At the end of a run doxygen will report the cache usage and suggest
399     # the optimal cache size from a speed point of view.
400     # Minimum value: 0, maximum value: 9, default value: 0.
401 gezelter 1447
402 gezelter 1879 LOOKUP_CACHE_SIZE = 0
403    
404 tim 48 #---------------------------------------------------------------------------
405     # Build related configuration options
406     #---------------------------------------------------------------------------
407 gezelter 1447
408     # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
409 gezelter 2046 # documentation are documented, even if no documentation was available. Private
410     # class members and static file members will be hidden unless the
411     # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
412     # Note: This will also disable the warnings about undocumented members that are
413     # normally produced when WARNINGS is set to YES.
414     # The default value is: NO.
415 gezelter 1447
416     EXTRACT_ALL = YES
417    
418 gezelter 2046 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
419     # be included in the documentation.
420     # The default value is: NO.
421 gezelter 1447
422     EXTRACT_PRIVATE = YES
423    
424 gezelter 2046 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
425     # scope will be included in the documentation.
426     # The default value is: NO.
427 gezelter 1879
428     EXTRACT_PACKAGE = NO
429    
430 gezelter 2046 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
431     # included in the documentation.
432     # The default value is: NO.
433 gezelter 1447
434     EXTRACT_STATIC = YES
435    
436 gezelter 2046 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
437     # locally in source files will be included in the documentation. If set to NO
438     # only classes defined in header files are included. Does not have any effect
439     # for Java sources.
440     # The default value is: YES.
441 gezelter 1447
442 tim 48 EXTRACT_LOCAL_CLASSES = YES
443 gezelter 1447
444 gezelter 2046 # This flag is only useful for Objective-C code. When set to YES local methods,
445     # which are defined in the implementation section but not in the interface are
446     # included in the documentation. If set to NO only methods in the interface are
447     # included.
448     # The default value is: NO.
449 gezelter 1447
450     EXTRACT_LOCAL_METHODS = YES
451    
452     # If this flag is set to YES, the members of anonymous namespaces will be
453     # extracted and appear in the documentation as a namespace called
454 gezelter 2046 # 'anonymous_namespace{file}', where file will be replaced with the base name of
455     # the file that contains the anonymous namespace. By default anonymous namespace
456     # are hidden.
457     # The default value is: NO.
458 gezelter 1447
459     EXTRACT_ANON_NSPACES = YES
460    
461 gezelter 2046 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
462     # undocumented members inside documented classes or files. If set to NO these
463     # members will be included in the various overviews, but no documentation
464     # section is generated. This option has no effect if EXTRACT_ALL is enabled.
465     # The default value is: NO.
466 gezelter 1447
467     HIDE_UNDOC_MEMBERS = NO
468    
469 gezelter 2046 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
470     # undocumented classes that are normally visible in the class hierarchy. If set
471     # to NO these classes will be included in the various overviews. This option has
472     # no effect if EXTRACT_ALL is enabled.
473     # The default value is: NO.
474 gezelter 1447
475     HIDE_UNDOC_CLASSES = NO
476    
477 gezelter 2046 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
478     # (class|struct|union) declarations. If set to NO these declarations will be
479     # included in the documentation.
480     # The default value is: NO.
481 gezelter 1447
482 tim 48 HIDE_FRIEND_COMPOUNDS = NO
483 gezelter 1447
484 gezelter 2046 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
485     # documentation blocks found inside the body of a function. If set to NO these
486     # blocks will be appended to the function's detailed documentation block.
487     # The default value is: NO.
488 gezelter 1447
489 tim 48 HIDE_IN_BODY_DOCS = NO
490 gezelter 1447
491 gezelter 2046 # The INTERNAL_DOCS tag determines if documentation that is typed after a
492     # \internal command is included. If the tag is set to NO then the documentation
493     # will be excluded. Set it to YES to include the internal documentation.
494     # The default value is: NO.
495 gezelter 1447
496 tim 48 INTERNAL_DOCS = NO
497 gezelter 1447
498 gezelter 2046 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
499     # names in lower-case letters. If set to YES upper-case letters are also
500 gezelter 1447 # allowed. This is useful if you have classes or files whose names only differ
501     # in case and if your file system supports case sensitive file names. Windows
502     # and Mac users are advised to set this option to NO.
503 gezelter 2046 # The default value is: system dependent.
504 gezelter 1447
505     CASE_SENSE_NAMES = NO
506    
507 gezelter 2046 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
508     # their full class and namespace scopes in the documentation. If set to YES the
509     # scope will be hidden.
510     # The default value is: NO.
511 gezelter 1447
512 tim 48 HIDE_SCOPE_NAMES = NO
513 gezelter 1447
514 gezelter 2046 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
515     # the files that are included by a file in the documentation of that file.
516     # The default value is: YES.
517 gezelter 1447
518 tim 48 SHOW_INCLUDE_FILES = YES
519 gezelter 1447
520 gezelter 2046 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
521     # grouped member an include statement to the documentation, telling the reader
522     # which file to include in order to use the member.
523     # The default value is: NO.
524 gezelter 1447
525 gezelter 2046 SHOW_GROUPED_MEMB_INC = NO
526    
527     # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
528     # files with double quotes in the documentation rather than with sharp brackets.
529     # The default value is: NO.
530    
531 gezelter 1447 FORCE_LOCAL_INCLUDES = NO
532    
533 gezelter 2046 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
534     # documentation for inline members.
535     # The default value is: YES.
536 gezelter 1447
537 tim 48 INLINE_INFO = YES
538 gezelter 1447
539 gezelter 2046 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
540     # (detailed) documentation of file and class members alphabetically by member
541     # name. If set to NO the members will appear in declaration order.
542     # The default value is: YES.
543 gezelter 1447
544 tim 48 SORT_MEMBER_DOCS = YES
545 gezelter 1447
546 gezelter 2046 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
547     # descriptions of file, namespace and class members alphabetically by member
548     # name. If set to NO the members will appear in declaration order. Note that
549     # this will also influence the order of the classes in the class list.
550     # The default value is: NO.
551 gezelter 1447
552 tim 48 SORT_BRIEF_DOCS = NO
553 gezelter 1447
554 gezelter 2046 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
555     # (brief and detailed) documentation of class members so that constructors and
556     # destructors are listed first. If set to NO the constructors will appear in the
557     # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
558     # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
559     # member documentation.
560     # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
561     # detailed member documentation.
562     # The default value is: NO.
563 gezelter 1447
564     SORT_MEMBERS_CTORS_1ST = NO
565    
566 gezelter 2046 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
567     # of group names into alphabetical order. If set to NO the group names will
568     # appear in their defined order.
569     # The default value is: NO.
570 gezelter 1447
571     SORT_GROUP_NAMES = NO
572    
573 gezelter 2046 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
574     # fully-qualified names, including namespaces. If set to NO, the class list will
575     # be sorted only by class name, not including the namespace part.
576 gezelter 1447 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
577 gezelter 2046 # Note: This option applies only to the class list, not to the alphabetical
578     # list.
579     # The default value is: NO.
580 gezelter 1447
581 tim 48 SORT_BY_SCOPE_NAME = NO
582 gezelter 1447
583 gezelter 2046 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
584     # type resolution of all parameters of a function it will reject a match between
585     # the prototype and the implementation of a member function even if there is
586     # only one candidate or it is obvious which candidate to choose by doing a
587     # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
588     # accept a match between prototype and implementation in such cases.
589     # The default value is: NO.
590 gezelter 1879
591     STRICT_PROTO_MATCHING = NO
592    
593 gezelter 2046 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
594     # todo list. This list is created by putting \todo commands in the
595     # documentation.
596     # The default value is: YES.
597 gezelter 1447
598 tim 48 GENERATE_TODOLIST = YES
599 gezelter 1447
600 gezelter 2046 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
601     # test list. This list is created by putting \test commands in the
602     # documentation.
603     # The default value is: YES.
604 gezelter 1447
605 tim 48 GENERATE_TESTLIST = YES
606 gezelter 1447
607 gezelter 2046 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
608     # list. This list is created by putting \bug commands in the documentation.
609     # The default value is: YES.
610 gezelter 1447
611 tim 48 GENERATE_BUGLIST = YES
612 gezelter 1447
613 gezelter 2046 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
614     # the deprecated list. This list is created by putting \deprecated commands in
615     # the documentation.
616     # The default value is: YES.
617 gezelter 1447
618 tim 48 GENERATE_DEPRECATEDLIST= YES
619 gezelter 1447
620 gezelter 2046 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
621     # sections, marked by \if <section_label> ... \endif and \cond <section_label>
622     # ... \endcond blocks.
623 gezelter 1447
624     ENABLED_SECTIONS =
625    
626 gezelter 2046 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
627     # initial value of a variable or macro / define can have for it to appear in the
628     # documentation. If the initializer consists of more lines than specified here
629     # it will be hidden. Use a value of 0 to hide initializers completely. The
630     # appearance of the value of individual variables and macros / defines can be
631     # controlled using \showinitializer or \hideinitializer command in the
632     # documentation regardless of this setting.
633     # Minimum value: 0, maximum value: 10000, default value: 30.
634 gezelter 1447
635 tim 48 MAX_INITIALIZER_LINES = 30
636 gezelter 1447
637 gezelter 2046 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
638     # the bottom of the documentation of classes and structs. If set to YES the list
639     # will mention the files that were used to generate the documentation.
640     # The default value is: YES.
641 gezelter 1447
642 tim 48 SHOW_USED_FILES = YES
643 gezelter 1447
644 gezelter 2046 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
645     # will remove the Files entry from the Quick Index and from the Folder Tree View
646     # (if specified).
647     # The default value is: YES.
648 gezelter 1447
649     SHOW_FILES = YES
650    
651 gezelter 2046 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
652     # page. This will remove the Namespaces entry from the Quick Index and from the
653     # Folder Tree View (if specified).
654     # The default value is: YES.
655 gezelter 1447
656     SHOW_NAMESPACES = YES
657    
658     # The FILE_VERSION_FILTER tag can be used to specify a program or script that
659     # doxygen should invoke to get the current version for each file (typically from
660     # the version control system). Doxygen will invoke the program by executing (via
661 gezelter 2046 # popen()) the command command input-file, where command is the value of the
662     # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
663     # by doxygen. Whatever the program writes to standard output is used as the file
664     # version. For an example see the documentation.
665 gezelter 1447
666     FILE_VERSION_FILTER =
667    
668 gezelter 1879 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
669     # by doxygen. The layout file controls the global structure of the generated
670     # output files in an output format independent way. To create the layout file
671 gezelter 2046 # that represents doxygen's defaults, run doxygen with the -l option. You can
672     # optionally specify a file name after the option, if omitted DoxygenLayout.xml
673     # will be used as the name of the layout file.
674     #
675     # Note that if you run doxygen from a directory containing a file called
676     # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
677     # tag is left empty.
678 gezelter 1447
679     LAYOUT_FILE =
680    
681 gezelter 2046 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
682     # the reference definitions. This must be a list of .bib files. The .bib
683     # extension is automatically appended if omitted. This requires the bibtex tool
684     # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
685     # For LaTeX the style of the bibliography can be controlled using
686     # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
687     # search path. Do not use file names with spaces, bibtex cannot handle them. See
688     # also \cite for info how to create references.
689 gezelter 1879
690     CITE_BIB_FILES =
691    
692 tim 48 #---------------------------------------------------------------------------
693 gezelter 2046 # Configuration options related to warning and progress messages
694 tim 48 #---------------------------------------------------------------------------
695 gezelter 1447
696 gezelter 2046 # The QUIET tag can be used to turn on/off the messages that are generated to
697     # standard output by doxygen. If QUIET is set to YES this implies that the
698     # messages are off.
699     # The default value is: NO.
700 gezelter 1447
701 tim 48 QUIET = NO
702 gezelter 1447
703     # The WARNINGS tag can be used to turn on/off the warning messages that are
704 gezelter 2046 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
705     # this implies that the warnings are on.
706     #
707     # Tip: Turn warnings on while writing the documentation.
708     # The default value is: YES.
709 gezelter 1447
710 tim 48 WARNINGS = YES
711 gezelter 1447
712 gezelter 2046 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
713     # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
714     # will automatically be disabled.
715     # The default value is: YES.
716 gezelter 1447
717 tim 48 WARN_IF_UNDOCUMENTED = YES
718 gezelter 1447
719 gezelter 2046 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
720     # potential errors in the documentation, such as not documenting some parameters
721     # in a documented function, or documenting parameters that don't exist or using
722     # markup commands wrongly.
723     # The default value is: YES.
724 gezelter 1447
725 tim 48 WARN_IF_DOC_ERROR = YES
726 gezelter 1447
727 gezelter 2046 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
728     # are documented, but have no documentation for their parameters or return
729     # value. If set to NO doxygen will only warn about wrong or incomplete parameter
730     # documentation, but not about the absence of documentation.
731     # The default value is: NO.
732 gezelter 1447
733     WARN_NO_PARAMDOC = NO
734    
735 gezelter 2046 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
736     # can produce. The string should contain the $file, $line, and $text tags, which
737     # will be replaced by the file and line number from which the warning originated
738     # and the warning text. Optionally the format may contain $version, which will
739     # be replaced by the version of the file (if it could be obtained via
740     # FILE_VERSION_FILTER)
741     # The default value is: $file:$line: $text.
742 gezelter 1447
743 tim 48 WARN_FORMAT = "$file:$line: $text"
744 gezelter 1447
745 gezelter 2046 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
746     # messages should be written. If left blank the output is written to standard
747     # error (stderr).
748 gezelter 1447
749     WARN_LOGFILE =
750    
751 tim 48 #---------------------------------------------------------------------------
752 gezelter 2046 # Configuration options related to the input files
753 tim 48 #---------------------------------------------------------------------------
754 gezelter 1447
755 gezelter 2046 # The INPUT tag is used to specify the files and/or directories that contain
756     # documented source files. You may enter file names like myfile.cpp or
757     # directories like /usr/src/myproject. Separate the files or directories with
758     # spaces.
759     # Note: If this tag is empty the current directory is searched.
760 gezelter 1447
761 gezelter 1651 INPUT = @CMAKE_CURRENT_SOURCE_DIR@/src/
762 gezelter 1447
763     # This tag can be used to specify the character encoding of the source files
764 gezelter 2046 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
765     # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
766     # documentation (see: http://www.gnu.org/software/libiconv) for the list of
767     # possible encodings.
768     # The default value is: UTF-8.
769 gezelter 1447
770     INPUT_ENCODING = UTF-8
771    
772     # If the value of the INPUT tag contains directories, you can use the
773 gezelter 2046 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
774     # *.h) to filter out the source-files in the directories. If left blank the
775     # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
776     # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
777     # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
778     # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
779     # *.qsf, *.as and *.js.
780 gezelter 1879
781 tim 48 FILE_PATTERNS = *.c \
782     *.cc \
783     *.cxx \
784     *.cpp \
785     *.c++ \
786     *.java \
787     *.ii \
788     *.ixx \
789     *.ipp \
790     *.i++ \
791     *.inl \
792     *.h \
793     *.hh \
794     *.hxx \
795     *.hpp \
796     *.h++ \
797     *.idl \
798     *.odl \
799     *.cs \
800     *.php \
801     *.php3 \
802     *.inc \
803     *.m \
804     *.mm \
805     *.dox \
806     *.C \
807     *.CC \
808     *.C++ \
809     *.II \
810     *.I++ \
811     *.H \
812     *.HH \
813     *.H++ \
814     *.CS \
815     *.PHP \
816     *.PHP3 \
817     *.M \
818 gezelter 1447 *.MM \
819 gezelter 1879 *.f90 \
820     *.f95 \
821     *.f77 \
822     *.ftn \
823     *.for \
824     *.F90 \
825     *.F95 \
826     *.F77 \
827     *.FTN \
828     *.FOR \
829     *.F
830 gezelter 1447
831 gezelter 2046 # The RECURSIVE tag can be used to specify whether or not subdirectories should
832     # be searched for input files as well.
833     # The default value is: NO.
834 gezelter 1447
835 tim 48 RECURSIVE = YES
836 gezelter 1447
837 gezelter 1879 # The EXCLUDE tag can be used to specify files and/or directories that should be
838 gezelter 1447 # excluded from the INPUT source files. This way you can easily exclude a
839     # subdirectory from a directory tree whose root is specified with the INPUT tag.
840 gezelter 2046 #
841 gezelter 1879 # Note that relative paths are relative to the directory from which doxygen is
842     # run.
843 gezelter 1447
844 gezelter 2046 EXCLUDE =
845 gezelter 1447
846 gezelter 1879 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
847     # directories that are symbolic links (a Unix file system feature) are excluded
848 gezelter 1447 # from the input.
849 gezelter 2046 # The default value is: NO.
850 gezelter 1447
851 tim 48 EXCLUDE_SYMLINKS = NO
852 gezelter 1447
853     # If the value of the INPUT tag contains directories, you can use the
854     # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
855 gezelter 2046 # certain files from those directories.
856     #
857     # Note that the wildcards are matched against the file with absolute path, so to
858     # exclude all test directories for example use the pattern */test/*
859 gezelter 1447
860     EXCLUDE_PATTERNS =
861    
862     # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
863     # (namespaces, classes, functions, etc.) that should be excluded from the
864     # output. The symbol name can be a fully qualified name, a word, or if the
865     # wildcard * is used, a substring. Examples: ANamespace, AClass,
866     # AClass::ANamespace, ANamespace::*Test
867 gezelter 2046 #
868     # Note that the wildcards are matched against the file with absolute path, so to
869     # exclude all test directories use the pattern */test/*
870 gezelter 1447
871     EXCLUDE_SYMBOLS =
872    
873 gezelter 2046 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
874     # that contain example code fragments that are included (see the \include
875     # command).
876 gezelter 1447
877     EXAMPLE_PATH =
878    
879     # If the value of the EXAMPLE_PATH tag contains directories, you can use the
880 gezelter 2046 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
881     # *.h) to filter out the source-files in the directories. If left blank all
882     # files are included.
883 gezelter 1447
884     EXAMPLE_PATTERNS =
885    
886     # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
887 gezelter 2046 # searched for input files to be used with the \include or \dontinclude commands
888     # irrespective of the value of the RECURSIVE tag.
889     # The default value is: NO.
890 gezelter 1447
891 tim 48 EXAMPLE_RECURSIVE = NO
892 gezelter 1447
893 gezelter 2046 # The IMAGE_PATH tag can be used to specify one or more files or directories
894     # that contain images that are to be included in the documentation (see the
895     # \image command).
896 gezelter 1447
897     IMAGE_PATH =
898    
899     # The INPUT_FILTER tag can be used to specify a program that doxygen should
900     # invoke to filter for each input file. Doxygen will invoke the filter program
901 gezelter 2046 # by executing (via popen()) the command:
902     #
903     # <filter> <input-file>
904     #
905     # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
906     # name of an input file. Doxygen will then use the output that the filter
907     # program writes to standard output. If FILTER_PATTERNS is specified, this tag
908     # will be ignored.
909     #
910     # Note that the filter must not add or remove lines; it is applied before the
911     # code is scanned, but not when the output code is generated. If lines are added
912     # or removed, the anchors will not be placed correctly.
913 gezelter 1447
914     INPUT_FILTER =
915    
916     # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
917 gezelter 2046 # basis. Doxygen will compare the file name with each pattern and apply the
918     # filter if there is a match. The filters are a list of the form: pattern=filter
919     # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
920     # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
921     # patterns match the file name, INPUT_FILTER is applied.
922 gezelter 1447
923 gezelter 1879 FILTER_PATTERNS =
924 gezelter 1447
925     # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
926 gezelter 2046 # INPUT_FILTER ) will also be used to filter the input files that are used for
927     # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
928     # The default value is: NO.
929 gezelter 1447
930 tim 48 FILTER_SOURCE_FILES = NO
931 gezelter 1447
932 gezelter 1879 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
933 gezelter 2046 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
934     # it is also possible to disable source filtering for a specific pattern using
935     # *.ext= (so without naming a filter).
936     # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
937 gezelter 1879
938     FILTER_SOURCE_PATTERNS =
939    
940 gezelter 2046 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
941     # is part of the input, its contents will be placed on the main page
942     # (index.html). This can be useful if you have a project on for instance GitHub
943     # and want to reuse the introduction page also for the doxygen output.
944    
945     USE_MDFILE_AS_MAINPAGE =
946    
947 tim 48 #---------------------------------------------------------------------------
948 gezelter 2046 # Configuration options related to source browsing
949 tim 48 #---------------------------------------------------------------------------
950 gezelter 1447
951 gezelter 2046 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
952     # generated. Documented entities will be cross-referenced with these sources.
953     #
954     # Note: To get rid of all source code in the generated output, make sure that
955     # also VERBATIM_HEADERS is set to NO.
956     # The default value is: NO.
957 gezelter 1447
958     SOURCE_BROWSER = YES
959    
960 gezelter 2046 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
961     # classes and enums directly into the documentation.
962     # The default value is: NO.
963 gezelter 1447
964     INLINE_SOURCES = NO
965    
966 gezelter 2046 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
967     # special comment blocks from generated source code fragments. Normal C, C++ and
968     # Fortran comments will always remain visible.
969     # The default value is: YES.
970 gezelter 1447
971 tim 48 STRIP_CODE_COMMENTS = YES
972 gezelter 1447
973 gezelter 2046 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
974     # function all documented functions referencing it will be listed.
975     # The default value is: NO.
976 gezelter 1447
977     REFERENCED_BY_RELATION = YES
978    
979 gezelter 2046 # If the REFERENCES_RELATION tag is set to YES then for each documented function
980     # all documented entities called/used by that function will be listed.
981     # The default value is: NO.
982 gezelter 1447
983     REFERENCES_RELATION = YES
984    
985 gezelter 2046 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
986     # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
987     # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
988     # link to the documentation.
989     # The default value is: YES.
990 gezelter 1447
991     REFERENCES_LINK_SOURCE = YES
992    
993 gezelter 2046 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
994     # source code will show a tooltip with additional information such as prototype,
995     # brief description and links to the definition and documentation. Since this
996     # will make the HTML file larger and loading of large files a bit slower, you
997     # can opt to disable this feature.
998     # The default value is: YES.
999     # This tag requires that the tag SOURCE_BROWSER is set to YES.
1000 gezelter 1447
1001 gezelter 2046 SOURCE_TOOLTIPS = YES
1002    
1003     # If the USE_HTAGS tag is set to YES then the references to source code will
1004     # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1005     # source browser. The htags tool is part of GNU's global source tagging system
1006     # (see http://www.gnu.org/software/global/global.html). You will need version
1007     # 4.8.6 or higher.
1008     #
1009     # To use it do the following:
1010     # - Install the latest version of global
1011     # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1012     # - Make sure the INPUT points to the root of the source tree
1013     # - Run doxygen as normal
1014     #
1015     # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1016     # tools must be available from the command line (i.e. in the search path).
1017     #
1018     # The result: instead of the source browser generated by doxygen, the links to
1019     # source code will now point to the output of htags.
1020     # The default value is: NO.
1021     # This tag requires that the tag SOURCE_BROWSER is set to YES.
1022    
1023 gezelter 1447 USE_HTAGS = NO
1024    
1025 gezelter 2046 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1026     # verbatim copy of the header file for each class for which an include is
1027     # specified. Set to NO to disable this.
1028     # See also: Section \class.
1029     # The default value is: YES.
1030 gezelter 1447
1031     VERBATIM_HEADERS = YES
1032    
1033 tim 48 #---------------------------------------------------------------------------
1034 gezelter 2046 # Configuration options related to the alphabetical class index
1035 tim 48 #---------------------------------------------------------------------------
1036 gezelter 1447
1037 gezelter 2046 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1038     # compounds will be generated. Enable this if the project contains a lot of
1039     # classes, structs, unions or interfaces.
1040     # The default value is: YES.
1041 gezelter 1447
1042     ALPHABETICAL_INDEX = YES
1043    
1044 gezelter 2046 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1045     # which the alphabetical index list will be split.
1046     # Minimum value: 1, maximum value: 20, default value: 5.
1047     # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1048 gezelter 1447
1049 tim 48 COLS_IN_ALPHA_INDEX = 5
1050 gezelter 1447
1051 gezelter 2046 # In case all classes in a project start with a common prefix, all classes will
1052     # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1053     # can be used to specify a prefix (or a list of prefixes) that should be ignored
1054     # while generating the index headers.
1055     # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1056 gezelter 1447
1057     IGNORE_PREFIX =
1058    
1059 tim 48 #---------------------------------------------------------------------------
1060 gezelter 2046 # Configuration options related to the HTML output
1061 tim 48 #---------------------------------------------------------------------------
1062 gezelter 1447
1063 gezelter 2046 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1064     # The default value is: YES.
1065 gezelter 1447
1066 tim 48 GENERATE_HTML = YES
1067 gezelter 1447
1068 gezelter 2046 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1069     # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1070     # it.
1071     # The default directory is: html.
1072     # This tag requires that the tag GENERATE_HTML is set to YES.
1073 gezelter 1447
1074 tim 48 HTML_OUTPUT = html
1075 gezelter 1447
1076 gezelter 2046 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1077     # generated HTML page (for example: .htm, .php, .asp).
1078     # The default value is: .html.
1079     # This tag requires that the tag GENERATE_HTML is set to YES.
1080 gezelter 1447
1081 tim 48 HTML_FILE_EXTENSION = .html
1082 gezelter 1447
1083 gezelter 2046 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1084     # each generated HTML page. If the tag is left blank doxygen will generate a
1085     # standard header.
1086     #
1087     # To get valid HTML the header file that includes any scripts and style sheets
1088     # that doxygen needs, which is dependent on the configuration options used (e.g.
1089     # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1090     # default header using
1091     # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1092     # YourConfigFile
1093     # and then modify the file new_header.html. See also section "Doxygen usage"
1094     # for information on how to generate the default header that doxygen normally
1095     # uses.
1096     # Note: The header is subject to change so you typically have to regenerate the
1097     # default header when upgrading to a newer version of doxygen. For a description
1098     # of the possible markers and block names see the documentation.
1099     # This tag requires that the tag GENERATE_HTML is set to YES.
1100 gezelter 1447
1101     HTML_HEADER =
1102    
1103 gezelter 2046 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1104     # generated HTML page. If the tag is left blank doxygen will generate a standard
1105     # footer. See HTML_HEADER for more information on how to generate a default
1106     # footer and what special commands can be used inside the footer. See also
1107     # section "Doxygen usage" for information on how to generate the default footer
1108     # that doxygen normally uses.
1109     # This tag requires that the tag GENERATE_HTML is set to YES.
1110 gezelter 1447
1111     HTML_FOOTER =
1112    
1113 gezelter 2046 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1114     # sheet that is used by each HTML page. It can be used to fine-tune the look of
1115     # the HTML output. If left blank doxygen will generate a default style sheet.
1116     # See also section "Doxygen usage" for information on how to generate the style
1117     # sheet that doxygen normally uses.
1118     # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1119     # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1120     # obsolete.
1121     # This tag requires that the tag GENERATE_HTML is set to YES.
1122 gezelter 1447
1123     HTML_STYLESHEET =
1124    
1125 gezelter 2046 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1126     # defined cascading style sheet that is included after the standard style sheets
1127     # created by doxygen. Using this option one can overrule certain style aspects.
1128     # This is preferred over using HTML_STYLESHEET since it does not replace the
1129     # standard style sheet and is therefor more robust against future updates.
1130     # Doxygen will copy the style sheet file to the output directory. For an example
1131     # see the documentation.
1132     # This tag requires that the tag GENERATE_HTML is set to YES.
1133    
1134     HTML_EXTRA_STYLESHEET =
1135    
1136 gezelter 1879 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1137     # other source files which should be copied to the HTML output directory. Note
1138     # that these files will be copied to the base HTML output directory. Use the
1139 gezelter 2046 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1140     # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1141     # files will be copied as-is; there are no commands or markers available.
1142     # This tag requires that the tag GENERATE_HTML is set to YES.
1143 gezelter 1879
1144     HTML_EXTRA_FILES =
1145    
1146 gezelter 2046 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1147     # will adjust the colors in the stylesheet and background images according to
1148     # this color. Hue is specified as an angle on a colorwheel, see
1149     # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1150     # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1151     # purple, and 360 is red again.
1152     # Minimum value: 0, maximum value: 359, default value: 220.
1153     # This tag requires that the tag GENERATE_HTML is set to YES.
1154 gezelter 1879
1155     HTML_COLORSTYLE_HUE = 220
1156    
1157 gezelter 2046 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1158     # in the HTML output. For a value of 0 the output will use grayscales only. A
1159     # value of 255 will produce the most vivid colors.
1160     # Minimum value: 0, maximum value: 255, default value: 100.
1161     # This tag requires that the tag GENERATE_HTML is set to YES.
1162 gezelter 1879
1163     HTML_COLORSTYLE_SAT = 100
1164    
1165 gezelter 2046 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1166     # luminance component of the colors in the HTML output. Values below 100
1167     # gradually make the output lighter, whereas values above 100 make the output
1168     # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1169     # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1170     # change the gamma.
1171     # Minimum value: 40, maximum value: 240, default value: 80.
1172     # This tag requires that the tag GENERATE_HTML is set to YES.
1173 gezelter 1879
1174     HTML_COLORSTYLE_GAMMA = 80
1175    
1176 gezelter 1447 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1177 gezelter 2046 # page will contain the date and time when the page was generated. Setting this
1178     # to NO can help when comparing the output of multiple runs.
1179     # The default value is: YES.
1180     # This tag requires that the tag GENERATE_HTML is set to YES.
1181 gezelter 1447
1182     HTML_TIMESTAMP = YES
1183    
1184     # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1185     # documentation will contain sections that can be hidden and shown after the
1186 gezelter 1879 # page has loaded.
1187 gezelter 2046 # The default value is: NO.
1188     # This tag requires that the tag GENERATE_HTML is set to YES.
1189 gezelter 1447
1190     HTML_DYNAMIC_SECTIONS = NO
1191    
1192 gezelter 2046 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1193     # shown in the various tree structured indices initially; the user can expand
1194     # and collapse entries dynamically later on. Doxygen will expand the tree to
1195     # such a level that at most the specified number of entries are visible (unless
1196     # a fully collapsed tree already exceeds this amount). So setting the number of
1197     # entries 1 will produce a full collapsed tree by default. 0 is a special value
1198     # representing an infinite number of entries and will result in a full expanded
1199     # tree by default.
1200     # Minimum value: 0, maximum value: 9999, default value: 100.
1201     # This tag requires that the tag GENERATE_HTML is set to YES.
1202 gezelter 1879
1203     HTML_INDEX_NUM_ENTRIES = 100
1204    
1205 gezelter 2046 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1206     # generated that can be used as input for Apple's Xcode 3 integrated development
1207     # environment (see: http://developer.apple.com/tools/xcode/), introduced with
1208     # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1209     # Makefile in the HTML output directory. Running make will produce the docset in
1210     # that directory and running make install will install the docset in
1211     # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1212     # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1213 gezelter 1879 # for more information.
1214 gezelter 2046 # The default value is: NO.
1215     # This tag requires that the tag GENERATE_HTML is set to YES.
1216 gezelter 1447
1217     GENERATE_DOCSET = NO
1218    
1219 gezelter 2046 # This tag determines the name of the docset feed. A documentation feed provides
1220     # an umbrella under which multiple documentation sets from a single provider
1221     # (such as a company or product suite) can be grouped.
1222     # The default value is: Doxygen generated docs.
1223     # This tag requires that the tag GENERATE_DOCSET is set to YES.
1224 gezelter 1447
1225     DOCSET_FEEDNAME = "Doxygen generated docs"
1226    
1227 gezelter 2046 # This tag specifies a string that should uniquely identify the documentation
1228     # set bundle. This should be a reverse domain-name style string, e.g.
1229     # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1230     # The default value is: org.doxygen.Project.
1231     # This tag requires that the tag GENERATE_DOCSET is set to YES.
1232 gezelter 1447
1233 gezelter 1879 DOCSET_BUNDLE_ID = org.openscience.OpenMD
1234 gezelter 1447
1235 gezelter 2046 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1236 gezelter 1879 # the documentation publisher. This should be a reverse domain-name style
1237     # string, e.g. com.mycompany.MyDocSet.documentation.
1238 gezelter 2046 # The default value is: org.doxygen.Publisher.
1239     # This tag requires that the tag GENERATE_DOCSET is set to YES.
1240 gezelter 1879
1241     DOCSET_PUBLISHER_ID = org.openscience.OpenMD.documentation
1242    
1243 gezelter 2046 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1244     # The default value is: Publisher.
1245     # This tag requires that the tag GENERATE_DOCSET is set to YES.
1246 gezelter 1879
1247     DOCSET_PUBLISHER_NAME = Publisher
1248    
1249 gezelter 2046 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1250     # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1251     # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1252     # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1253     # Windows.
1254     #
1255     # The HTML Help Workshop contains a compiler that can convert all HTML output
1256     # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1257     # files are now used as the Windows 98 help format, and will replace the old
1258     # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1259     # HTML files also contain an index, a table of contents, and you can search for
1260     # words in the documentation. The HTML workshop also contains a viewer for
1261     # compressed HTML files.
1262     # The default value is: NO.
1263     # This tag requires that the tag GENERATE_HTML is set to YES.
1264 gezelter 1447
1265 tim 48 GENERATE_HTMLHELP = NO
1266 gezelter 1447
1267 gezelter 2046 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1268     # file. You can add a path in front of the file if the result should not be
1269 gezelter 1447 # written to the html output directory.
1270 gezelter 2046 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1271 gezelter 1447
1272     CHM_FILE =
1273    
1274 gezelter 2046 # The HHC_LOCATION tag can be used to specify the location (absolute path
1275     # including file name) of the HTML help compiler ( hhc.exe). If non-empty
1276     # doxygen will try to run the HTML help compiler on the generated index.hhp.
1277     # The file has to be specified with full path.
1278     # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1279 gezelter 1447
1280     HHC_LOCATION =
1281    
1282 gezelter 2046 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
1283     # YES) or that it should be included in the master .chm file ( NO).
1284     # The default value is: NO.
1285     # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1286 gezelter 1447
1287 tim 48 GENERATE_CHI = NO
1288 gezelter 1447
1289 gezelter 2046 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1290     # and project file content.
1291     # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1292 gezelter 1447
1293     CHM_INDEX_ENCODING =
1294    
1295 gezelter 2046 # The BINARY_TOC flag controls whether a binary table of contents is generated (
1296     # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
1297     # enables the Previous and Next buttons.
1298     # The default value is: NO.
1299     # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1300 gezelter 1447
1301 tim 48 BINARY_TOC = NO
1302 gezelter 1447
1303 gezelter 2046 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1304     # the table of contents of the HTML help documentation and to the tree view.
1305     # The default value is: NO.
1306     # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1307 gezelter 1447
1308 tim 48 TOC_EXPAND = NO
1309 gezelter 1447
1310 gezelter 1879 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1311 gezelter 2046 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1312     # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1313     # (.qch) of the generated HTML documentation.
1314     # The default value is: NO.
1315     # This tag requires that the tag GENERATE_HTML is set to YES.
1316 gezelter 1447
1317     GENERATE_QHP = NO
1318    
1319 gezelter 2046 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1320     # the file name of the resulting .qch file. The path specified is relative to
1321     # the HTML output folder.
1322     # This tag requires that the tag GENERATE_QHP is set to YES.
1323 gezelter 1447
1324     QCH_FILE =
1325    
1326 gezelter 2046 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1327     # Project output. For more information please see Qt Help Project / Namespace
1328     # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1329     # The default value is: org.doxygen.Project.
1330     # This tag requires that the tag GENERATE_QHP is set to YES.
1331 gezelter 1447
1332 gezelter 1879 QHP_NAMESPACE = org.openscience.OpenMD
1333 gezelter 1447
1334 gezelter 2046 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1335     # Help Project output. For more information please see Qt Help Project / Virtual
1336     # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1337     # folders).
1338     # The default value is: doc.
1339     # This tag requires that the tag GENERATE_QHP is set to YES.
1340 gezelter 1447
1341     QHP_VIRTUAL_FOLDER = doc
1342    
1343 gezelter 2046 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1344     # filter to add. For more information please see Qt Help Project / Custom
1345     # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1346     # filters).
1347     # This tag requires that the tag GENERATE_QHP is set to YES.
1348 gezelter 1447
1349     QHP_CUST_FILTER_NAME =
1350    
1351 gezelter 2046 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1352     # custom filter to add. For more information please see Qt Help Project / Custom
1353     # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1354     # filters).
1355     # This tag requires that the tag GENERATE_QHP is set to YES.
1356 gezelter 1447
1357     QHP_CUST_FILTER_ATTRS =
1358    
1359 gezelter 1879 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1360 gezelter 2046 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1361     # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1362     # This tag requires that the tag GENERATE_QHP is set to YES.
1363 gezelter 1447
1364     QHP_SECT_FILTER_ATTRS =
1365    
1366 gezelter 2046 # The QHG_LOCATION tag can be used to specify the location of Qt's
1367     # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1368     # generated .qhp file.
1369     # This tag requires that the tag GENERATE_QHP is set to YES.
1370 gezelter 1447
1371     QHG_LOCATION =
1372    
1373 gezelter 2046 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1374     # generated, together with the HTML files, they form an Eclipse help plugin. To
1375     # install this plugin and make it available under the help contents menu in
1376     # Eclipse, the contents of the directory containing the HTML and XML files needs
1377     # to be copied into the plugins directory of eclipse. The name of the directory
1378     # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1379     # After copying Eclipse needs to be restarted before the help appears.
1380     # The default value is: NO.
1381     # This tag requires that the tag GENERATE_HTML is set to YES.
1382 gezelter 1447
1383     GENERATE_ECLIPSEHELP = NO
1384    
1385 gezelter 2046 # A unique identifier for the Eclipse help plugin. When installing the plugin
1386     # the directory name containing the HTML and XML files should also have this
1387     # name. Each documentation set should have its own identifier.
1388     # The default value is: org.doxygen.Project.
1389     # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1390 gezelter 1447
1391 gezelter 1879 ECLIPSE_DOC_ID = org.openscience.OpenMD
1392 gezelter 1447
1393 gezelter 2046 # If you want full control over the layout of the generated HTML pages it might
1394     # be necessary to disable the index and replace it with your own. The
1395     # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1396     # of each HTML page. A value of NO enables the index and the value YES disables
1397     # it. Since the tabs in the index contain the same information as the navigation
1398     # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1399     # The default value is: NO.
1400     # This tag requires that the tag GENERATE_HTML is set to YES.
1401 gezelter 1447
1402 tim 48 DISABLE_INDEX = NO
1403 gezelter 1447
1404     # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1405 gezelter 2046 # structure should be generated to display hierarchical information. If the tag
1406     # value is set to YES, a side panel will be generated containing a tree-like
1407     # index structure (just like the one that is generated for HTML Help). For this
1408     # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1409     # (i.e. any modern browser). Windows users are probably better off using the
1410     # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1411     # further fine-tune the look of the index. As an example, the default style
1412     # sheet generated by doxygen has an example that shows how to put an image at
1413     # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1414     # the same information as the tab index, you could consider setting
1415     # DISABLE_INDEX to YES when enabling this option.
1416     # The default value is: NO.
1417     # This tag requires that the tag GENERATE_HTML is set to YES.
1418 gezelter 1447
1419 gezelter 1879 GENERATE_TREEVIEW = YES
1420 gezelter 1447
1421 gezelter 2046 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1422     # doxygen will group on one line in the generated HTML documentation.
1423     #
1424     # Note that a value of 0 will completely suppress the enum values from appearing
1425     # in the overview section.
1426     # Minimum value: 0, maximum value: 20, default value: 4.
1427     # This tag requires that the tag GENERATE_HTML is set to YES.
1428 gezelter 1447
1429 gezelter 1879 ENUM_VALUES_PER_LINE = 4
1430 gezelter 1447
1431 gezelter 2046 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1432     # to set the initial width (in pixels) of the frame in which the tree is shown.
1433     # Minimum value: 0, maximum value: 1500, default value: 250.
1434     # This tag requires that the tag GENERATE_HTML is set to YES.
1435 gezelter 1447
1436 tim 48 TREEVIEW_WIDTH = 250
1437 gezelter 1447
1438 gezelter 2046 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1439     # external symbols imported via tag files in a separate window.
1440     # The default value is: NO.
1441     # This tag requires that the tag GENERATE_HTML is set to YES.
1442 gezelter 1879
1443     EXT_LINKS_IN_WINDOW = NO
1444    
1445 gezelter 2046 # Use this tag to change the font size of LaTeX formulas included as images in
1446     # the HTML documentation. When you change the font size after a successful
1447     # doxygen run you need to manually remove any form_*.png images from the HTML
1448     # output directory to force them to be regenerated.
1449     # Minimum value: 8, maximum value: 50, default value: 10.
1450     # This tag requires that the tag GENERATE_HTML is set to YES.
1451 gezelter 1447
1452     FORMULA_FONTSIZE = 10
1453    
1454 gezelter 1879 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1455 gezelter 2046 # generated for formulas are transparent PNGs. Transparent PNGs are not
1456     # supported properly for IE 6.0, but are supported on all modern browsers.
1457     #
1458     # Note that when changing this option you need to delete any form_*.png files in
1459     # the HTML output directory before the changes have effect.
1460     # The default value is: YES.
1461     # This tag requires that the tag GENERATE_HTML is set to YES.
1462 gezelter 1879
1463     FORMULA_TRANSPARENT = YES
1464    
1465 gezelter 2046 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1466     # http://www.mathjax.org) which uses client side Javascript for the rendering
1467     # instead of using prerendered bitmaps. Use this if you do not have LaTeX
1468     # installed or if you want to formulas look prettier in the HTML output. When
1469     # enabled you may also need to install MathJax separately and configure the path
1470     # to it using the MATHJAX_RELPATH option.
1471     # The default value is: NO.
1472     # This tag requires that the tag GENERATE_HTML is set to YES.
1473 gezelter 1879
1474     USE_MATHJAX = NO
1475    
1476 gezelter 2046 # When MathJax is enabled you can set the default output format to be used for
1477     # the MathJax output. See the MathJax site (see:
1478     # http://docs.mathjax.org/en/latest/output.html) for more details.
1479     # Possible values are: HTML-CSS (which is slower, but has the best
1480     # compatibility), NativeMML (i.e. MathML) and SVG.
1481     # The default value is: HTML-CSS.
1482     # This tag requires that the tag USE_MATHJAX is set to YES.
1483 gezelter 1879
1484 gezelter 2046 MATHJAX_FORMAT = HTML-CSS
1485    
1486     # When MathJax is enabled you need to specify the location relative to the HTML
1487     # output directory using the MATHJAX_RELPATH option. The destination directory
1488     # should contain the MathJax.js script. For instance, if the mathjax directory
1489     # is located at the same level as the HTML output directory, then
1490     # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1491     # Content Delivery Network so you can quickly see the result without installing
1492     # MathJax. However, it is strongly recommended to install a local copy of
1493     # MathJax from http://www.mathjax.org before deployment.
1494     # The default value is: http://cdn.mathjax.org/mathjax/latest.
1495     # This tag requires that the tag USE_MATHJAX is set to YES.
1496    
1497 gezelter 1879 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1498    
1499 gezelter 2046 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1500     # extension names that should be enabled during MathJax rendering. For example
1501     # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1502     # This tag requires that the tag USE_MATHJAX is set to YES.
1503 gezelter 1879
1504     MATHJAX_EXTENSIONS =
1505    
1506 gezelter 2046 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1507     # of code that will be used on startup of the MathJax code. See the MathJax site
1508     # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1509     # example see the documentation.
1510     # This tag requires that the tag USE_MATHJAX is set to YES.
1511 gezelter 1447
1512 gezelter 2046 MATHJAX_CODEFILE =
1513    
1514     # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1515     # the HTML output. The underlying search engine uses javascript and DHTML and
1516     # should work on any modern browser. Note that when using HTML help
1517     # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1518     # there is already a search function so this one should typically be disabled.
1519     # For large projects the javascript based search engine can be slow, then
1520     # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1521     # search using the keyboard; to jump to the search box use <access key> + S
1522     # (what the <access key> is depends on the OS and browser, but it is typically
1523     # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1524     # key> to jump into the search results window, the results can be navigated
1525     # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1526     # the search. The filter options can be selected when the cursor is inside the
1527     # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1528     # to select a filter and <Enter> or <escape> to activate or cancel the filter
1529     # option.
1530     # The default value is: YES.
1531     # This tag requires that the tag GENERATE_HTML is set to YES.
1532    
1533 gezelter 1447 SEARCHENGINE = YES
1534    
1535 gezelter 1879 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1536 gezelter 2046 # implemented using a web server instead of a web client using Javascript. There
1537     # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1538     # setting. When disabled, doxygen will generate a PHP script for searching and
1539     # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1540     # and searching needs to be provided by external tools. See the section
1541     # "External Indexing and Searching" for details.
1542     # The default value is: NO.
1543     # This tag requires that the tag SEARCHENGINE is set to YES.
1544 gezelter 1447
1545     SERVER_BASED_SEARCH = NO
1546    
1547 gezelter 2046 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1548     # script for searching. Instead the search results are written to an XML file
1549     # which needs to be processed by an external indexer. Doxygen will invoke an
1550     # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1551     # search results.
1552     #
1553     # Doxygen ships with an example indexer ( doxyindexer) and search engine
1554     # (doxysearch.cgi) which are based on the open source search engine library
1555     # Xapian (see: http://xapian.org/).
1556     #
1557     # See the section "External Indexing and Searching" for details.
1558     # The default value is: NO.
1559     # This tag requires that the tag SEARCHENGINE is set to YES.
1560    
1561     EXTERNAL_SEARCH = NO
1562    
1563     # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1564     # which will return the search results when EXTERNAL_SEARCH is enabled.
1565     #
1566     # Doxygen ships with an example indexer ( doxyindexer) and search engine
1567     # (doxysearch.cgi) which are based on the open source search engine library
1568     # Xapian (see: http://xapian.org/). See the section "External Indexing and
1569     # Searching" for details.
1570     # This tag requires that the tag SEARCHENGINE is set to YES.
1571    
1572     SEARCHENGINE_URL =
1573    
1574     # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1575     # search data is written to a file for indexing by an external tool. With the
1576     # SEARCHDATA_FILE tag the name of this file can be specified.
1577     # The default file is: searchdata.xml.
1578     # This tag requires that the tag SEARCHENGINE is set to YES.
1579    
1580     SEARCHDATA_FILE = searchdata.xml
1581    
1582     # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1583     # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1584     # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1585     # projects and redirect the results back to the right project.
1586     # This tag requires that the tag SEARCHENGINE is set to YES.
1587    
1588     EXTERNAL_SEARCH_ID =
1589    
1590     # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1591     # projects other than the one defined by this configuration file, but that are
1592     # all added to the same external search index. Each project needs to have a
1593     # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1594     # to a relative location where the documentation can be found. The format is:
1595     # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1596     # This tag requires that the tag SEARCHENGINE is set to YES.
1597    
1598     EXTRA_SEARCH_MAPPINGS =
1599    
1600 tim 48 #---------------------------------------------------------------------------
1601 gezelter 2046 # Configuration options related to the LaTeX output
1602 tim 48 #---------------------------------------------------------------------------
1603 gezelter 1447
1604 gezelter 2046 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1605     # The default value is: YES.
1606 gezelter 1447
1607     GENERATE_LATEX = NO
1608    
1609 gezelter 2046 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1610     # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1611     # it.
1612     # The default directory is: latex.
1613     # This tag requires that the tag GENERATE_LATEX is set to YES.
1614 gezelter 1447
1615 tim 48 LATEX_OUTPUT = latex
1616 gezelter 1447
1617     # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1618 gezelter 2046 # invoked.
1619     #
1620     # Note that when enabling USE_PDFLATEX this option is only used for generating
1621     # bitmaps for formulas in the HTML output, but not in the Makefile that is
1622     # written to the output directory.
1623     # The default file is: latex.
1624     # This tag requires that the tag GENERATE_LATEX is set to YES.
1625 gezelter 1447
1626 tim 48 LATEX_CMD_NAME = latex
1627 gezelter 1447
1628 gezelter 2046 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1629     # index for LaTeX.
1630     # The default file is: makeindex.
1631     # This tag requires that the tag GENERATE_LATEX is set to YES.
1632 gezelter 1447
1633 tim 48 MAKEINDEX_CMD_NAME = makeindex
1634 gezelter 1447
1635 gezelter 2046 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1636     # documents. This may be useful for small projects and may help to save some
1637     # trees in general.
1638     # The default value is: NO.
1639     # This tag requires that the tag GENERATE_LATEX is set to YES.
1640 gezelter 1447
1641 tim 48 COMPACT_LATEX = NO
1642 gezelter 1447
1643 gezelter 2046 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1644     # printer.
1645     # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1646     # 14 inches) and executive (7.25 x 10.5 inches).
1647     # The default value is: a4.
1648     # This tag requires that the tag GENERATE_LATEX is set to YES.
1649 gezelter 1447
1650 gezelter 1879 PAPER_TYPE = letter
1651 gezelter 1447
1652 gezelter 2046 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1653     # that should be included in the LaTeX output. To get the times font for
1654     # instance you can specify
1655     # EXTRA_PACKAGES=times
1656     # If left blank no extra packages will be included.
1657     # This tag requires that the tag GENERATE_LATEX is set to YES.
1658 gezelter 1447
1659     EXTRA_PACKAGES =
1660    
1661 gezelter 2046 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1662     # generated LaTeX document. The header should contain everything until the first
1663     # chapter. If it is left blank doxygen will generate a standard header. See
1664     # section "Doxygen usage" for information on how to let doxygen write the
1665     # default header to a separate file.
1666     #
1667     # Note: Only use a user-defined header if you know what you are doing! The
1668     # following commands have a special meaning inside the header: $title,
1669     # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1670     # replace them by respectively the title of the page, the current date and time,
1671     # only the current date, the version number of doxygen, the project name (see
1672     # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1673     # This tag requires that the tag GENERATE_LATEX is set to YES.
1674 gezelter 1447
1675     LATEX_HEADER =
1676    
1677 gezelter 2046 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1678     # generated LaTeX document. The footer should contain everything after the last
1679     # chapter. If it is left blank doxygen will generate a standard footer.
1680     #
1681     # Note: Only use a user-defined footer if you know what you are doing!
1682     # This tag requires that the tag GENERATE_LATEX is set to YES.
1683 gezelter 1879
1684     LATEX_FOOTER =
1685    
1686 gezelter 2046 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1687     # other source files which should be copied to the LATEX_OUTPUT output
1688     # directory. Note that the files will be copied as-is; there are no commands or
1689     # markers available.
1690     # This tag requires that the tag GENERATE_LATEX is set to YES.
1691 gezelter 1447
1692 gezelter 2046 LATEX_EXTRA_FILES =
1693    
1694     # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1695     # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1696     # contain links (just like the HTML output) instead of page references. This
1697     # makes the output suitable for online browsing using a PDF viewer.
1698     # The default value is: YES.
1699     # This tag requires that the tag GENERATE_LATEX is set to YES.
1700    
1701 gezelter 1447 PDF_HYPERLINKS = YES
1702    
1703 gezelter 2046 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1704     # the PDF file directly from the LaTeX files. Set this option to YES to get a
1705 gezelter 1447 # higher quality PDF documentation.
1706 gezelter 2046 # The default value is: YES.
1707     # This tag requires that the tag GENERATE_LATEX is set to YES.
1708 gezelter 1447
1709     USE_PDFLATEX = YES
1710    
1711 gezelter 2046 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1712     # command to the generated LaTeX files. This will instruct LaTeX to keep running
1713     # if errors occur, instead of asking the user for help. This option is also used
1714     # when generating formulas in HTML.
1715     # The default value is: NO.
1716     # This tag requires that the tag GENERATE_LATEX is set to YES.
1717 gezelter 1447
1718 tim 48 LATEX_BATCHMODE = NO
1719 gezelter 1447
1720 gezelter 2046 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1721     # index chapters (such as File Index, Compound Index, etc.) in the output.
1722     # The default value is: NO.
1723     # This tag requires that the tag GENERATE_LATEX is set to YES.
1724 gezelter 1447
1725 tim 48 LATEX_HIDE_INDICES = NO
1726 gezelter 1447
1727 gezelter 2046 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1728     # code with syntax highlighting in the LaTeX output.
1729     #
1730     # Note that which sources are shown also depends on other settings such as
1731     # SOURCE_BROWSER.
1732     # The default value is: NO.
1733     # This tag requires that the tag GENERATE_LATEX is set to YES.
1734 gezelter 1447
1735     LATEX_SOURCE_CODE = NO
1736    
1737 gezelter 1879 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1738 gezelter 2046 # bibliography, e.g. plainnat, or ieeetr. See
1739     # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1740     # The default value is: plain.
1741     # This tag requires that the tag GENERATE_LATEX is set to YES.
1742 gezelter 1879
1743     LATEX_BIB_STYLE = plain
1744    
1745 tim 48 #---------------------------------------------------------------------------
1746 gezelter 2046 # Configuration options related to the RTF output
1747 tim 48 #---------------------------------------------------------------------------
1748 gezelter 1447
1749 gezelter 2046 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1750     # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1751     # readers/editors.
1752     # The default value is: NO.
1753 gezelter 1447
1754 tim 48 GENERATE_RTF = NO
1755 gezelter 1447
1756 gezelter 2046 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1757     # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1758     # it.
1759     # The default directory is: rtf.
1760     # This tag requires that the tag GENERATE_RTF is set to YES.
1761 gezelter 1447
1762 tim 48 RTF_OUTPUT = rtf
1763 gezelter 1447
1764 gezelter 2046 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1765     # documents. This may be useful for small projects and may help to save some
1766     # trees in general.
1767     # The default value is: NO.
1768     # This tag requires that the tag GENERATE_RTF is set to YES.
1769 gezelter 1447
1770 tim 48 COMPACT_RTF = NO
1771 gezelter 1447
1772 gezelter 2046 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1773     # contain hyperlink fields. The RTF file will contain links (just like the HTML
1774     # output) instead of page references. This makes the output suitable for online
1775     # browsing using Word or some other Word compatible readers that support those
1776     # fields.
1777     #
1778     # Note: WordPad (write) and others do not support links.
1779     # The default value is: NO.
1780     # This tag requires that the tag GENERATE_RTF is set to YES.
1781 gezelter 1447
1782 tim 48 RTF_HYPERLINKS = NO
1783 gezelter 1447
1784 gezelter 2046 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1785     # file, i.e. a series of assignments. You only have to provide replacements,
1786     # missing definitions are set to their default value.
1787     #
1788     # See also section "Doxygen usage" for information on how to generate the
1789     # default style sheet that doxygen normally uses.
1790     # This tag requires that the tag GENERATE_RTF is set to YES.
1791 gezelter 1447
1792     RTF_STYLESHEET_FILE =
1793    
1794 gezelter 2046 # Set optional variables used in the generation of an RTF document. Syntax is
1795     # similar to doxygen's config file. A template extensions file can be generated
1796     # using doxygen -e rtf extensionFile.
1797     # This tag requires that the tag GENERATE_RTF is set to YES.
1798 gezelter 1447
1799     RTF_EXTENSIONS_FILE =
1800    
1801 tim 48 #---------------------------------------------------------------------------
1802 gezelter 2046 # Configuration options related to the man page output
1803 tim 48 #---------------------------------------------------------------------------
1804 gezelter 1447
1805 gezelter 2046 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1806     # classes and files.
1807     # The default value is: NO.
1808 gezelter 1447
1809 tim 48 GENERATE_MAN = NO
1810 gezelter 1447
1811 gezelter 2046 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1812     # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1813     # it. A directory man3 will be created inside the directory specified by
1814     # MAN_OUTPUT.
1815     # The default directory is: man.
1816     # This tag requires that the tag GENERATE_MAN is set to YES.
1817 gezelter 1447
1818 tim 48 MAN_OUTPUT = man
1819 gezelter 1447
1820 gezelter 2046 # The MAN_EXTENSION tag determines the extension that is added to the generated
1821     # man pages. In case the manual section does not start with a number, the number
1822     # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1823     # optional.
1824     # The default value is: .3.
1825     # This tag requires that the tag GENERATE_MAN is set to YES.
1826 gezelter 1447
1827 tim 48 MAN_EXTENSION = .3
1828 gezelter 1447
1829 gezelter 2046 # The MAN_SUBDIR tag determines the name of the directory created within
1830     # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1831     # MAN_EXTENSION with the initial . removed.
1832     # This tag requires that the tag GENERATE_MAN is set to YES.
1833 gezelter 1447
1834 gezelter 2046 MAN_SUBDIR =
1835    
1836     # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1837     # will generate one additional man file for each entity documented in the real
1838     # man page(s). These additional files only source the real man page, but without
1839     # them the man command would be unable to find the correct page.
1840     # The default value is: NO.
1841     # This tag requires that the tag GENERATE_MAN is set to YES.
1842    
1843 tim 48 MAN_LINKS = NO
1844 gezelter 1447
1845 tim 48 #---------------------------------------------------------------------------
1846 gezelter 2046 # Configuration options related to the XML output
1847 tim 48 #---------------------------------------------------------------------------
1848 gezelter 1447
1849 gezelter 2046 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1850     # captures the structure of the code including all documentation.
1851     # The default value is: NO.
1852 gezelter 1447
1853 tim 48 GENERATE_XML = NO
1854 gezelter 1447
1855 gezelter 2046 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1856     # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1857     # it.
1858     # The default directory is: xml.
1859     # This tag requires that the tag GENERATE_XML is set to YES.
1860 gezelter 1447
1861 tim 48 XML_OUTPUT = xml
1862 gezelter 1447
1863 gezelter 2046 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1864     # listings (including syntax highlighting and cross-referencing information) to
1865     # the XML output. Note that enabling this will significantly increase the size
1866     # of the XML output.
1867     # The default value is: YES.
1868     # This tag requires that the tag GENERATE_XML is set to YES.
1869 gezelter 1447
1870 gezelter 2046 XML_PROGRAMLISTING = YES
1871 gezelter 1447
1872 gezelter 2046 #---------------------------------------------------------------------------
1873     # Configuration options related to the DOCBOOK output
1874     #---------------------------------------------------------------------------
1875 gezelter 1447
1876 gezelter 2046 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1877     # that can be used to generate PDF.
1878     # The default value is: NO.
1879 gezelter 1447
1880 gezelter 2046 GENERATE_DOCBOOK = NO
1881 gezelter 1447
1882 gezelter 2046 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1883     # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1884     # front of it.
1885     # The default directory is: docbook.
1886     # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1887 gezelter 1447
1888 gezelter 2046 DOCBOOK_OUTPUT = docbook
1889    
1890 tim 48 #---------------------------------------------------------------------------
1891 gezelter 2046 # Configuration options for the AutoGen Definitions output
1892 tim 48 #---------------------------------------------------------------------------
1893 gezelter 1447
1894 gezelter 2046 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1895     # Definitions (see http://autogen.sf.net) file that captures the structure of
1896     # the code including all documentation. Note that this feature is still
1897     # experimental and incomplete at the moment.
1898     # The default value is: NO.
1899 gezelter 1447
1900 tim 48 GENERATE_AUTOGEN_DEF = NO
1901 gezelter 1447
1902 tim 48 #---------------------------------------------------------------------------
1903 gezelter 2046 # Configuration options related to the Perl module output
1904 tim 48 #---------------------------------------------------------------------------
1905 gezelter 1447
1906 gezelter 2046 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1907     # file that captures the structure of the code including all documentation.
1908     #
1909     # Note that this feature is still experimental and incomplete at the moment.
1910     # The default value is: NO.
1911 gezelter 1447
1912 tim 48 GENERATE_PERLMOD = NO
1913 gezelter 1447
1914 gezelter 2046 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1915     # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1916     # output from the Perl module output.
1917     # The default value is: NO.
1918     # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1919 gezelter 1447
1920 tim 48 PERLMOD_LATEX = NO
1921 gezelter 1447
1922 gezelter 2046 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1923     # formatted so it can be parsed by a human reader. This is useful if you want to
1924     # understand what is going on. On the other hand, if this tag is set to NO the
1925     # size of the Perl module output will be much smaller and Perl will parse it
1926     # just the same.
1927     # The default value is: YES.
1928     # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1929 gezelter 1447
1930 tim 48 PERLMOD_PRETTY = YES
1931 gezelter 1447
1932 gezelter 2046 # The names of the make variables in the generated doxyrules.make file are
1933     # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1934     # so different doxyrules.make files included by the same Makefile don't
1935     # overwrite each other's variables.
1936     # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1937 gezelter 1447
1938     PERLMOD_MAKEVAR_PREFIX =
1939    
1940 tim 48 #---------------------------------------------------------------------------
1941 gezelter 1447 # Configuration options related to the preprocessor
1942 tim 48 #---------------------------------------------------------------------------
1943 gezelter 1447
1944 gezelter 2046 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1945     # C-preprocessor directives found in the sources and include files.
1946     # The default value is: YES.
1947 gezelter 1447
1948 tim 48 ENABLE_PREPROCESSING = YES
1949 gezelter 1447
1950 gezelter 2046 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1951     # in the source code. If set to NO only conditional compilation will be
1952     # performed. Macro expansion can be done in a controlled way by setting
1953     # EXPAND_ONLY_PREDEF to YES.
1954     # The default value is: NO.
1955     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1956 gezelter 1447
1957 tim 48 MACRO_EXPANSION = NO
1958 gezelter 1447
1959 gezelter 2046 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1960     # the macro expansion is limited to the macros specified with the PREDEFINED and
1961     # EXPAND_AS_DEFINED tags.
1962     # The default value is: NO.
1963     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1964 gezelter 1447
1965 tim 48 EXPAND_ONLY_PREDEF = NO
1966 gezelter 1447
1967 gezelter 2046 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
1968     # INCLUDE_PATH will be searched if a #include is found.
1969     # The default value is: YES.
1970     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1971 gezelter 1447
1972 tim 48 SEARCH_INCLUDES = YES
1973 gezelter 1447
1974     # The INCLUDE_PATH tag can be used to specify one or more directories that
1975 gezelter 2046 # contain include files that are not input files but should be processed by the
1976     # preprocessor.
1977     # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1978 gezelter 1447
1979     INCLUDE_PATH =
1980    
1981     # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1982     # patterns (like *.h and *.hpp) to filter out the header-files in the
1983 gezelter 2046 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
1984     # used.
1985     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1986 gezelter 1447
1987     INCLUDE_FILE_PATTERNS =
1988    
1989 gezelter 2046 # The PREDEFINED tag can be used to specify one or more macro names that are
1990     # defined before the preprocessor is started (similar to the -D option of e.g.
1991     # gcc). The argument of the tag is a list of macros of the form: name or
1992     # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1993     # is assumed. To prevent a macro definition from being undefined via #undef or
1994     # recursively expanded use the := operator instead of the = operator.
1995     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1996 gezelter 1447
1997 gezelter 2046 PREDEFINED = ANTLR_CXX_SUPPORTS_NAMESPACE \
1998     "ANTLR_USE_NAMESPACE(_x_)=_x_::" \
1999     "ANTLR_USING_NAMESPACE(_x_)=using namespace _x_;" \
2000     "ANTLR_C_USING(_x_)=" \
2001     "ANTLR_API=" \
2002     IS_MPI \
2003     HAVE_QHULL \
2004     HAVE_FFTW3
2005 gezelter 1447
2006 gezelter 2046 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2007     # tag can be used to specify a list of macro names that should be expanded. The
2008     # macro definition that is found in the sources will be used. Use the PREDEFINED
2009     # tag if you want to use a different macro definition that overrules the
2010     # definition found in the source code.
2011     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2012 gezelter 1447
2013     EXPAND_AS_DEFINED =
2014    
2015 gezelter 2046 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2016     # remove all references to function-like macros that are alone on a line, have
2017     # an all uppercase name, and do not end with a semicolon. Such function macros
2018     # are typically used for boiler-plate code, and will confuse the parser if not
2019     # removed.
2020     # The default value is: YES.
2021     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2022 gezelter 1447
2023 tim 48 SKIP_FUNCTION_MACROS = YES
2024 gezelter 1447
2025 tim 48 #---------------------------------------------------------------------------
2026 gezelter 2046 # Configuration options related to external references
2027 tim 48 #---------------------------------------------------------------------------
2028 gezelter 1447
2029 gezelter 2046 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2030     # file the location of the external documentation should be added. The format of
2031     # a tag file without this location is as follows:
2032 gezelter 1447 # TAGFILES = file1 file2 ...
2033     # Adding location for the tag files is done as follows:
2034     # TAGFILES = file1=loc1 "file2 = loc2" ...
2035 gezelter 2046 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2036     # section "Linking to external documentation" for more information about the use
2037     # of tag files.
2038     # Note: Each tag file must have a unique name (where the name does NOT include
2039     # the path). If a tag file is not located in the directory in which doxygen is
2040     # run, you must also specify the path to the tagfile here.
2041 gezelter 1447
2042     TAGFILES =
2043    
2044 gezelter 2046 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2045     # tag file that is based on the input files it reads. See section "Linking to
2046     # external documentation" for more information about the usage of tag files.
2047 gezelter 1447
2048     GENERATE_TAGFILE =
2049    
2050 gezelter 2046 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
2051     # class index. If set to NO only the inherited external classes will be listed.
2052     # The default value is: NO.
2053 gezelter 1447
2054 tim 48 ALLEXTERNALS = NO
2055 gezelter 1447
2056 gezelter 2046 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2057     # the modules index. If set to NO, only the current project's groups will be
2058     # listed.
2059     # The default value is: YES.
2060 gezelter 1447
2061 tim 48 EXTERNAL_GROUPS = YES
2062 gezelter 1447
2063 gezelter 2046 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2064     # the related pages index. If set to NO, only the current project's pages will
2065     # be listed.
2066     # The default value is: YES.
2067    
2068     EXTERNAL_PAGES = YES
2069    
2070 gezelter 1447 # The PERL_PATH should be the absolute path and name of the perl script
2071 gezelter 2046 # interpreter (i.e. the result of 'which perl').
2072     # The default file (with absolute path) is: /usr/bin/perl.
2073 gezelter 1447
2074 tim 48 PERL_PATH = /usr/bin/perl
2075 gezelter 1447
2076 tim 48 #---------------------------------------------------------------------------
2077 gezelter 1447 # Configuration options related to the dot tool
2078 tim 48 #---------------------------------------------------------------------------
2079 gezelter 1447
2080 gezelter 2046 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2081     # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2082     # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2083     # disabled, but it is recommended to install and use dot, since it yields more
2084     # powerful graphs.
2085     # The default value is: YES.
2086 gezelter 1447
2087 tim 48 CLASS_DIAGRAMS = YES
2088 gezelter 1447
2089     # You can define message sequence charts within doxygen comments using the \msc
2090 gezelter 2046 # command. Doxygen will then run the mscgen tool (see:
2091     # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2092 gezelter 1447 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2093     # the mscgen tool resides. If left empty the tool is assumed to be found in the
2094     # default search path.
2095    
2096     MSCGEN_PATH =
2097    
2098 gezelter 2046 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2099     # then run dia to produce the diagram and insert it in the documentation. The
2100     # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2101     # If left empty dia is assumed to be found in the default search path.
2102 gezelter 1447
2103 gezelter 2046 DIA_PATH =
2104    
2105     # If set to YES, the inheritance and collaboration graphs will hide inheritance
2106     # and usage relations if the target is undocumented or is not a class.
2107     # The default value is: YES.
2108    
2109 tim 48 HIDE_UNDOC_RELATIONS = YES
2110 gezelter 1447
2111     # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2112 gezelter 2046 # available from the path. This tool is part of Graphviz (see:
2113     # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2114     # Bell Labs. The other options in this section have no effect if this option is
2115     # set to NO
2116     # The default value is: NO.
2117 gezelter 1447
2118 tim 48 HAVE_DOT = NO
2119 gezelter 1447
2120 gezelter 2046 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2121     # to run in parallel. When set to 0 doxygen will base this on the number of
2122     # processors available in the system. You can set it explicitly to a value
2123     # larger than 0 to get control over the balance between CPU load and processing
2124     # speed.
2125     # Minimum value: 0, maximum value: 32, default value: 0.
2126     # This tag requires that the tag HAVE_DOT is set to YES.
2127 gezelter 1447
2128 gezelter 1879 DOT_NUM_THREADS = 0
2129    
2130 gezelter 2046 # When you want a differently looking font n the dot files that doxygen
2131     # generates you can specify the font name using DOT_FONTNAME. You need to make
2132     # sure dot is able to find the font, which can be done by putting it in a
2133     # standard location or by setting the DOTFONTPATH environment variable or by
2134     # setting DOT_FONTPATH to the directory containing the font.
2135     # The default value is: Helvetica.
2136     # This tag requires that the tag HAVE_DOT is set to YES.
2137 gezelter 1879
2138 gezelter 2046 DOT_FONTNAME = Helvetica
2139 gezelter 1447
2140 gezelter 2046 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2141     # dot graphs.
2142     # Minimum value: 4, maximum value: 24, default value: 10.
2143     # This tag requires that the tag HAVE_DOT is set to YES.
2144 gezelter 1447
2145     DOT_FONTSIZE = 10
2146    
2147 gezelter 2046 # By default doxygen will tell dot to use the default font as specified with
2148     # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2149     # the path where dot can find it using this tag.
2150     # This tag requires that the tag HAVE_DOT is set to YES.
2151 gezelter 1447
2152     DOT_FONTPATH =
2153    
2154 gezelter 2046 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2155     # each documented class showing the direct and indirect inheritance relations.
2156     # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2157     # The default value is: YES.
2158     # This tag requires that the tag HAVE_DOT is set to YES.
2159 gezelter 1447
2160 tim 48 CLASS_GRAPH = YES
2161 gezelter 1447
2162 gezelter 2046 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2163     # graph for each documented class showing the direct and indirect implementation
2164     # dependencies (inheritance, containment, and class references variables) of the
2165     # class with other documented classes.
2166     # The default value is: YES.
2167     # This tag requires that the tag HAVE_DOT is set to YES.
2168 gezelter 1447
2169 tim 48 COLLABORATION_GRAPH = YES
2170 gezelter 1447
2171 gezelter 2046 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2172     # groups, showing the direct groups dependencies.
2173     # The default value is: YES.
2174     # This tag requires that the tag HAVE_DOT is set to YES.
2175 gezelter 1447
2176     GROUP_GRAPHS = YES
2177    
2178     # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2179     # collaboration diagrams in a style similar to the OMG's Unified Modeling
2180     # Language.
2181 gezelter 2046 # The default value is: NO.
2182     # This tag requires that the tag HAVE_DOT is set to YES.
2183 gezelter 1447
2184 tim 48 UML_LOOK = NO
2185 gezelter 1447
2186 gezelter 2046 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2187     # class node. If there are many fields or methods and many nodes the graph may
2188     # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2189     # number of items for each type to make the size more manageable. Set this to 0
2190     # for no limit. Note that the threshold may be exceeded by 50% before the limit
2191     # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2192     # but if the number exceeds 15, the total amount of fields shown is limited to
2193     # 10.
2194     # Minimum value: 0, maximum value: 100, default value: 10.
2195     # This tag requires that the tag HAVE_DOT is set to YES.
2196 gezelter 1879
2197     UML_LIMIT_NUM_FIELDS = 10
2198    
2199 gezelter 2046 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2200     # collaboration graphs will show the relations between templates and their
2201     # instances.
2202     # The default value is: NO.
2203     # This tag requires that the tag HAVE_DOT is set to YES.
2204 gezelter 1447
2205 tim 48 TEMPLATE_RELATIONS = NO
2206 gezelter 1447
2207 gezelter 2046 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2208     # YES then doxygen will generate a graph for each documented file showing the
2209     # direct and indirect include dependencies of the file with other documented
2210     # files.
2211     # The default value is: YES.
2212     # This tag requires that the tag HAVE_DOT is set to YES.
2213 gezelter 1447
2214 tim 48 INCLUDE_GRAPH = YES
2215 gezelter 1447
2216 gezelter 2046 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2217     # set to YES then doxygen will generate a graph for each documented file showing
2218     # the direct and indirect include dependencies of the file with other documented
2219     # files.
2220     # The default value is: YES.
2221     # This tag requires that the tag HAVE_DOT is set to YES.
2222 gezelter 1447
2223 tim 48 INCLUDED_BY_GRAPH = YES
2224 gezelter 1447
2225 gezelter 2046 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2226     # dependency graph for every global function or class method.
2227     #
2228     # Note that enabling this option will significantly increase the time of a run.
2229     # So in most cases it will be better to enable call graphs for selected
2230     # functions only using the \callgraph command.
2231     # The default value is: NO.
2232     # This tag requires that the tag HAVE_DOT is set to YES.
2233 gezelter 1447
2234     CALL_GRAPH = YES
2235    
2236 gezelter 2046 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2237     # dependency graph for every global function or class method.
2238     #
2239     # Note that enabling this option will significantly increase the time of a run.
2240     # So in most cases it will be better to enable caller graphs for selected
2241     # functions only using the \callergraph command.
2242     # The default value is: NO.
2243     # This tag requires that the tag HAVE_DOT is set to YES.
2244 gezelter 1447
2245     CALLER_GRAPH = YES
2246    
2247 gezelter 2046 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2248     # hierarchy of all classes instead of a textual one.
2249     # The default value is: YES.
2250     # This tag requires that the tag HAVE_DOT is set to YES.
2251 gezelter 1447
2252 tim 48 GRAPHICAL_HIERARCHY = YES
2253 gezelter 1447
2254 gezelter 2046 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2255     # dependencies a directory has on other directories in a graphical way. The
2256     # dependency relations are determined by the #include relations between the
2257     # files in the directories.
2258     # The default value is: YES.
2259     # This tag requires that the tag HAVE_DOT is set to YES.
2260 gezelter 1447
2261     DIRECTORY_GRAPH = YES
2262    
2263     # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2264 gezelter 2046 # generated by dot.
2265     # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2266     # to make the SVG files visible in IE 9+ (other browsers do not have this
2267     # requirement).
2268     # Possible values are: png, jpg, gif and svg.
2269     # The default value is: png.
2270     # This tag requires that the tag HAVE_DOT is set to YES.
2271 gezelter 1447
2272 tim 48 DOT_IMAGE_FORMAT = png
2273 gezelter 1447
2274 gezelter 1879 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2275     # enable generation of interactive SVG images that allow zooming and panning.
2276 gezelter 2046 #
2277     # Note that this requires a modern browser other than Internet Explorer. Tested
2278     # and working are Firefox, Chrome, Safari, and Opera.
2279     # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2280     # the SVG files visible. Older versions of IE do not have SVG support.
2281     # The default value is: NO.
2282     # This tag requires that the tag HAVE_DOT is set to YES.
2283 gezelter 1879
2284     INTERACTIVE_SVG = NO
2285    
2286 gezelter 2046 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2287 gezelter 1447 # found. If left blank, it is assumed the dot tool can be found in the path.
2288 gezelter 2046 # This tag requires that the tag HAVE_DOT is set to YES.
2289 gezelter 1447
2290     DOT_PATH =
2291    
2292     # The DOTFILE_DIRS tag can be used to specify one or more directories that
2293 gezelter 2046 # contain dot files that are included in the documentation (see the \dotfile
2294     # command).
2295     # This tag requires that the tag HAVE_DOT is set to YES.
2296 gezelter 1447
2297     DOTFILE_DIRS =
2298    
2299 gezelter 1879 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2300 gezelter 2046 # contain msc files that are included in the documentation (see the \mscfile
2301     # command).
2302 gezelter 1879
2303     MSCFILE_DIRS =
2304    
2305 gezelter 2046 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2306     # contain dia files that are included in the documentation (see the \diafile
2307     # command).
2308 gezelter 1447
2309 gezelter 2046 DIAFILE_DIRS =
2310    
2311     # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2312     # that will be shown in the graph. If the number of nodes in a graph becomes
2313     # larger than this value, doxygen will truncate the graph, which is visualized
2314     # by representing a node as a red box. Note that doxygen if the number of direct
2315     # children of the root node in a graph is already larger than
2316     # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2317     # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2318     # Minimum value: 0, maximum value: 10000, default value: 50.
2319     # This tag requires that the tag HAVE_DOT is set to YES.
2320    
2321 gezelter 1447 DOT_GRAPH_MAX_NODES = 50
2322    
2323 gezelter 2046 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2324     # generated by dot. A depth value of 3 means that only nodes reachable from the
2325     # root by following a path via at most 3 edges will be shown. Nodes that lay
2326     # further from the root node will be omitted. Note that setting this option to 1
2327     # or 2 may greatly reduce the computation time needed for large code bases. Also
2328     # note that the size of a graph can be further restricted by
2329 gezelter 1447 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2330 gezelter 2046 # Minimum value: 0, maximum value: 1000, default value: 0.
2331     # This tag requires that the tag HAVE_DOT is set to YES.
2332 gezelter 1447
2333     MAX_DOT_GRAPH_DEPTH = 0
2334    
2335     # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2336 gezelter 2046 # background. This is disabled by default, because dot on Windows does not seem
2337     # to support this out of the box.
2338     #
2339     # Warning: Depending on the platform used, enabling this option may lead to
2340     # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2341     # read).
2342     # The default value is: NO.
2343     # This tag requires that the tag HAVE_DOT is set to YES.
2344 gezelter 1447
2345     DOT_TRANSPARENT = NO
2346    
2347     # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2348     # files in one run (i.e. multiple -o and -T options on the command line). This
2349 gezelter 2046 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2350     # this, this feature is disabled by default.
2351     # The default value is: NO.
2352     # This tag requires that the tag HAVE_DOT is set to YES.
2353 gezelter 1447
2354     DOT_MULTI_TARGETS = NO
2355    
2356 gezelter 2046 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2357     # explaining the meaning of the various boxes and arrows in the dot generated
2358     # graphs.
2359     # The default value is: YES.
2360     # This tag requires that the tag HAVE_DOT is set to YES.
2361 gezelter 1447
2362 tim 48 GENERATE_LEGEND = YES
2363 gezelter 1447
2364 gezelter 2046 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2365     # files that are used to generate the various graphs.
2366     # The default value is: YES.
2367     # This tag requires that the tag HAVE_DOT is set to YES.
2368 gezelter 1447
2369 tim 48 DOT_CLEANUP = YES