ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/OpenMD/branches/development/doc/Doxyfile.in
Revision: 1465
Committed: Fri Jul 9 23:08:25 2010 UTC (14 years, 9 months ago) by chuckv
Original Path: branches/development/make/Doxyfile
File size: 66836 byte(s)
Log Message:
Creating busticated version of OpenMD

File Contents

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