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