ViewVC Help
View File | Revision Log | Show Annotations | Root Listing
root/cvsroot/UserCode/UHHAnalysis/Doxyfile
Revision: 1.6
Committed: Fri Oct 19 12:53:50 2012 UTC (12 years, 6 months ago) by peiffer
Branch: MAIN
CVS Tags: HEAD
Changes since 1.5: +1 -1 lines
Log Message:
path

File Contents

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