OSDN Git Service

Replace TortoiseSVN with TortoiseGit
[tortoisegit/TortoiseGitJp.git] / doc / API / Doxyfile
1 # Doxyfile 1.3.5\r
2 \r
3 # This file describes the settings to be used by the documentation system\r
4 # doxygen (www.doxygen.org) for a project\r
5 #\r
6 # All text after a hash (#) is considered a comment and will be ignored\r
7 # The format is:\r
8 #       TAG = value [value, ...]\r
9 # For lists items can also be appended using:\r
10 #       TAG += value [value, ...]\r
11 # Values that contain spaces should be placed between quotes (" ")\r
12 \r
13 #---------------------------------------------------------------------------\r
14 # Project related configuration options\r
15 #---------------------------------------------------------------------------\r
16 \r
17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded \r
18 # by quotes) that should identify the project.\r
19 \r
20 PROJECT_NAME           = TortoiseGit\r
21 \r
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number. \r
23 # This could be handy for archiving the generated documentation or \r
24 # if some version control system is used.\r
25 \r
26 PROJECT_NUMBER         = $LastChangedRevision: 10696 $\r
27 \r
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) \r
29 # base path where the generated documentation will be put. \r
30 # If a relative path is entered, it will be relative to the location \r
31 # where doxygen was started. If left blank the current directory will be used.\r
32 \r
33 OUTPUT_DIRECTORY       = output\doxygen\r
34 \r
35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all \r
36 # documentation generated by doxygen is written. Doxygen will use this \r
37 # information to generate all constant output in the proper language. \r
38 # The default language is English, other supported languages are: \r
39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, \r
40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en \r
41 # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese, \r
42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.\r
43 \r
44 OUTPUT_LANGUAGE        = English\r
45 \r
46 # This tag can be used to specify the encoding used in the generated output. \r
47 # The encoding is not always determined by the language that is chosen, \r
48 # but also whether or not the output is meant for Windows or non-Windows users. \r
49 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES \r
50 # forces the Windows encoding (this is the default for the Windows binary), \r
51 # whereas setting the tag to NO uses a Unix-style encoding (the default for \r
52 # all platforms other than Windows).\r
53 \r
54 USE_WINDOWS_ENCODING   = YES\r
55 \r
56 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will \r
57 # include brief member descriptions after the members that are listed in \r
58 # the file and class documentation (similar to JavaDoc). \r
59 # Set to NO to disable this.\r
60 \r
61 BRIEF_MEMBER_DESC      = YES\r
62 \r
63 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend \r
64 # the brief description of a member or function before the detailed description. \r
65 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the \r
66 # brief descriptions will be completely suppressed.\r
67 \r
68 REPEAT_BRIEF           = YES\r
69 \r
70 # This tag implements a quasi-intelligent brief description abbreviator \r
71 # that is used to form the text in various listings. Each string \r
72 # in this list, if found as the leading text of the brief description, will be \r
73 # stripped from the text and the result after processing the whole list, is used \r
74 # as the annotated text. Otherwise, the brief description is used as-is. If left \r
75 # blank, the following values are used ("$name" is automatically replaced with the \r
76 # name of the entity): "The $name class" "The $name widget" "The $name file" \r
77 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the"\r
78 \r
79 ABBREVIATE_BRIEF       = \r
80 \r
81 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then \r
82 # Doxygen will generate a detailed section even if there is only a brief \r
83 # description.\r
84 \r
85 ALWAYS_DETAILED_SEC    = NO\r
86 \r
87 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited \r
88 # members of a class in the documentation of that class as if those members were \r
89 # ordinary class members. Constructors, destructors and assignment operators of \r
90 # the base classes will not be shown.\r
91 \r
92 INLINE_INHERITED_MEMB  = NO\r
93 \r
94 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full \r
95 # path before files name in the file list and in the header files. If set \r
96 # to NO the shortest path that makes the file name unique will be used.\r
97 \r
98 FULL_PATH_NAMES        = NO\r
99 \r
100 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag \r
101 # can be used to strip a user-defined part of the path. Stripping is \r
102 # only done if one of the specified strings matches the left-hand part of \r
103 # the path. It is allowed to use relative paths in the argument list.\r
104 \r
105 STRIP_FROM_PATH        = \r
106 \r
107 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter \r
108 # (but less readable) file names. This can be useful is your file systems \r
109 # doesn't support long names like on DOS, Mac, or CD-ROM.\r
110 \r
111 SHORT_NAMES            = NO\r
112 \r
113 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen \r
114 # will interpret the first line (until the first dot) of a JavaDoc-style \r
115 # comment as the brief description. If set to NO, the JavaDoc \r
116 # comments will behave just like the Qt-style comments (thus requiring an \r
117 # explicit @brief command for a brief description.\r
118 \r
119 JAVADOC_AUTOBRIEF      = NO\r
120 \r
121 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen \r
122 # treat a multi-line C++ special comment block (i.e. a block of //! or /// \r
123 # comments) as a brief description. This used to be the default behaviour. \r
124 # The new default is to treat a multi-line C++ comment block as a detailed \r
125 # description. Set this tag to YES if you prefer the old behaviour instead.\r
126 \r
127 MULTILINE_CPP_IS_BRIEF = NO\r
128 \r
129 # If the DETAILS_AT_TOP tag is set to YES then Doxygen \r
130 # will output the detailed description near the top, like JavaDoc.\r
131 # If set to NO, the detailed description appears after the member \r
132 # documentation.\r
133 \r
134 DETAILS_AT_TOP         = YES\r
135 \r
136 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented \r
137 # member inherits the documentation from any documented member that it \r
138 # re-implements.\r
139 \r
140 INHERIT_DOCS           = YES\r
141 \r
142 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC \r
143 # tag is set to YES, then doxygen will reuse the documentation of the first \r
144 # member in the group (if any) for the other members of the group. By default \r
145 # all members of a group must be documented explicitly.\r
146 \r
147 DISTRIBUTE_GROUP_DOC   = NO\r
148 \r
149 # The TAB_SIZE tag can be used to set the number of spaces in a tab. \r
150 # Doxygen uses this value to replace tabs by spaces in code fragments.\r
151 \r
152 TAB_SIZE               = 4\r
153 \r
154 # This tag can be used to specify a number of aliases that acts \r
155 # as commands in the documentation. An alias has the form "name=value". \r
156 # For example adding "sideeffect=\par Side Effects:\n" will allow you to \r
157 # put the command \sideeffect (or @sideeffect) in the documentation, which \r
158 # will result in a user-defined paragraph with heading "Side Effects:". \r
159 # You can put \n's in the value part of an alias to insert newlines.\r
160 \r
161 ALIASES                = \r
162 \r
163 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources \r
164 # only. Doxygen will then generate output that is more tailored for C. \r
165 # For instance, some of the names that are used will be different. The list \r
166 # of all members will be omitted, etc.\r
167 \r
168 OPTIMIZE_OUTPUT_FOR_C  = NO\r
169 \r
170 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources \r
171 # only. Doxygen will then generate output that is more tailored for Java. \r
172 # For instance, namespaces will be presented as packages, qualified scopes \r
173 # will look different, etc.\r
174 \r
175 OPTIMIZE_OUTPUT_JAVA   = NO\r
176 \r
177 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of \r
178 # the same type (for instance a group of public functions) to be put as a \r
179 # subgroup of that type (e.g. under the Public Functions section). Set it to \r
180 # NO to prevent subgrouping. Alternatively, this can be done per class using \r
181 # the \nosubgrouping command.\r
182 \r
183 SUBGROUPING            = YES\r
184 \r
185 #---------------------------------------------------------------------------\r
186 # Build related configuration options\r
187 #---------------------------------------------------------------------------\r
188 \r
189 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in \r
190 # documentation are documented, even if no documentation was available. \r
191 # Private class members and static file members will be hidden unless \r
192 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES\r
193 \r
194 EXTRACT_ALL            = NO\r
195 \r
196 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class \r
197 # will be included in the documentation.\r
198 \r
199 EXTRACT_PRIVATE        = NO\r
200 \r
201 # If the EXTRACT_STATIC tag is set to YES all static members of a file \r
202 # will be included in the documentation.\r
203 \r
204 EXTRACT_STATIC         = NO\r
205 \r
206 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) \r
207 # defined locally in source files will be included in the documentation. \r
208 # If set to NO only classes defined in header files are included.\r
209 \r
210 EXTRACT_LOCAL_CLASSES  = YES\r
211 \r
212 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all \r
213 # undocumented members of documented classes, files or namespaces. \r
214 # If set to NO (the default) these members will be included in the \r
215 # various overviews, but no documentation section is generated. \r
216 # This option has no effect if EXTRACT_ALL is enabled.\r
217 \r
218 HIDE_UNDOC_MEMBERS     = NO\r
219 \r
220 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all \r
221 # undocumented classes that are normally visible in the class hierarchy. \r
222 # If set to NO (the default) these classes will be included in the various \r
223 # overviews. This option has no effect if EXTRACT_ALL is enabled.\r
224 \r
225 HIDE_UNDOC_CLASSES     = NO\r
226 \r
227 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all \r
228 # friend (class|struct|union) declarations. \r
229 # If set to NO (the default) these declarations will be included in the \r
230 # documentation.\r
231 \r
232 HIDE_FRIEND_COMPOUNDS  = NO\r
233 \r
234 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any \r
235 # documentation blocks found inside the body of a function. \r
236 # If set to NO (the default) these blocks will be appended to the \r
237 # function's detailed documentation block.\r
238 \r
239 HIDE_IN_BODY_DOCS      = NO\r
240 \r
241 # The INTERNAL_DOCS tag determines if documentation \r
242 # that is typed after a \internal command is included. If the tag is set \r
243 # to NO (the default) then the documentation will be excluded. \r
244 # Set it to YES to include the internal documentation.\r
245 \r
246 INTERNAL_DOCS          = NO\r
247 \r
248 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate \r
249 # file names in lower-case letters. If set to YES upper-case letters are also \r
250 # allowed. This is useful if you have classes or files whose names only differ \r
251 # in case and if your file system supports case sensitive file names. Windows \r
252 # users are advised to set this option to NO.\r
253 \r
254 CASE_SENSE_NAMES       = YES\r
255 \r
256 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen \r
257 # will show members with their full class and namespace scopes in the \r
258 # documentation. If set to YES the scope will be hidden.\r
259 \r
260 HIDE_SCOPE_NAMES       = NO\r
261 \r
262 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen \r
263 # will put a list of the files that are included by a file in the documentation \r
264 # of that file.\r
265 \r
266 SHOW_INCLUDE_FILES     = YES\r
267 \r
268 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] \r
269 # is inserted in the documentation for inline members.\r
270 \r
271 INLINE_INFO            = YES\r
272 \r
273 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen \r
274 # will sort the (detailed) documentation of file and class members \r
275 # alphabetically by member name. If set to NO the members will appear in \r
276 # declaration order.\r
277 \r
278 SORT_MEMBER_DOCS       = YES\r
279 \r
280 # The GENERATE_TODOLIST tag can be used to enable (YES) or \r
281 # disable (NO) the todo list. This list is created by putting \todo \r
282 # commands in the documentation.\r
283 \r
284 GENERATE_TODOLIST      = YES\r
285 \r
286 # The GENERATE_TESTLIST tag can be used to enable (YES) or \r
287 # disable (NO) the test list. This list is created by putting \test \r
288 # commands in the documentation.\r
289 \r
290 GENERATE_TESTLIST      = NO\r
291 \r
292 # The GENERATE_BUGLIST tag can be used to enable (YES) or \r
293 # disable (NO) the bug list. This list is created by putting \bug \r
294 # commands in the documentation.\r
295 \r
296 GENERATE_BUGLIST       = YES\r
297 \r
298 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or \r
299 # disable (NO) the deprecated list. This list is created by putting \r
300 # \deprecated commands in the documentation.\r
301 \r
302 GENERATE_DEPRECATEDLIST= NO\r
303 \r
304 # The ENABLED_SECTIONS tag can be used to enable conditional \r
305 # documentation sections, marked by \if sectionname ... \endif.\r
306 \r
307 ENABLED_SECTIONS       = \r
308 \r
309 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines \r
310 # the initial value of a variable or define consists of for it to appear in \r
311 # the documentation. If the initializer consists of more lines than specified \r
312 # here it will be hidden. Use a value of 0 to hide initializers completely. \r
313 # The appearance of the initializer of individual variables and defines in the \r
314 # documentation can be controlled using \showinitializer or \hideinitializer \r
315 # command in the documentation regardless of this setting.\r
316 \r
317 MAX_INITIALIZER_LINES  = 30\r
318 \r
319 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated \r
320 # at the bottom of the documentation of classes and structs. If set to YES the \r
321 # list will mention the files that were used to generate the documentation.\r
322 \r
323 SHOW_USED_FILES        = NO\r
324 \r
325 #---------------------------------------------------------------------------\r
326 # configuration options related to warning and progress messages\r
327 #---------------------------------------------------------------------------\r
328 \r
329 # The QUIET tag can be used to turn on/off the messages that are generated \r
330 # by doxygen. Possible values are YES and NO. If left blank NO is used.\r
331 \r
332 QUIET                  = YES\r
333 \r
334 # The WARNINGS tag can be used to turn on/off the warning messages that are \r
335 # generated by doxygen. Possible values are YES and NO. If left blank \r
336 # NO is used.\r
337 \r
338 WARNINGS               = NO\r
339 \r
340 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings \r
341 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will \r
342 # automatically be disabled.\r
343 \r
344 WARN_IF_UNDOCUMENTED   = NO\r
345 \r
346 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for \r
347 # potential errors in the documentation, such as not documenting some \r
348 # parameters in a documented function, or documenting parameters that \r
349 # don't exist or using markup commands wrongly.\r
350 \r
351 WARN_IF_DOC_ERROR      = NO\r
352 \r
353 # The WARN_FORMAT tag determines the format of the warning messages that \r
354 # doxygen can produce. The string should contain the $file, $line, and $text \r
355 # tags, which will be replaced by the file and line number from which the \r
356 # warning originated and the warning text.\r
357 \r
358 WARN_FORMAT            = "$file:$line: $text"\r
359 \r
360 # The WARN_LOGFILE tag can be used to specify a file to which warning \r
361 # and error messages should be written. If left blank the output is written \r
362 # to stderr.\r
363 \r
364 WARN_LOGFILE           = \r
365 \r
366 #---------------------------------------------------------------------------\r
367 # configuration options related to the input files\r
368 #---------------------------------------------------------------------------\r
369 \r
370 # The INPUT tag can be used to specify the files and/or directories that contain \r
371 # documented source files. You may enter file names like "myfile.cpp" or \r
372 # directories like "/usr/src/myproject". Separate the files or directories \r
373 # with spaces.\r
374 \r
375 INPUT                  = ..\src ..\build.txt\r
376 \r
377 # If the value of the INPUT tag contains directories, you can use the \r
378 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp \r
379 # and *.h) to filter out the source-files in the directories. If left \r
380 # blank the following patterns are tested: \r
381 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp \r
382 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc\r
383 \r
384 FILE_PATTERNS          = \r
385 \r
386 # The RECURSIVE tag can be used to turn specify whether or not subdirectories \r
387 # should be searched for input files as well. Possible values are YES and NO. \r
388 # If left blank NO is used.\r
389 \r
390 RECURSIVE              = YES\r
391 \r
392 # The EXCLUDE tag can be used to specify files and/or directories that should \r
393 # excluded from the INPUT source files. This way you can easily exclude a \r
394 # subdirectory from a directory tree whose root is specified with the INPUT tag.\r
395 \r
396 EXCLUDE                = ..\src\TortoisePlink ..\ext ..\src\Utils\hunspell ..\src\Utils\NewMenu ..\src\Utils\scintilla ..\src\Utils\TreePropSheet\r
397 \r
398 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories \r
399 # that are symbolic links (a Unix filesystem feature) are excluded from the input.\r
400 \r
401 EXCLUDE_SYMLINKS       = NO\r
402 \r
403 # If the value of the INPUT tag contains directories, you can use the \r
404 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude \r
405 # certain files from those directories.\r
406 \r
407 EXCLUDE_PATTERNS       = \r
408 \r
409 # The EXAMPLE_PATH tag can be used to specify one or more files or \r
410 # directories that contain example code fragments that are included (see \r
411 # the \include command).\r
412 \r
413 EXAMPLE_PATH           = \r
414 \r
415 # If the value of the EXAMPLE_PATH tag contains directories, you can use the \r
416 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp \r
417 # and *.h) to filter out the source-files in the directories. If left \r
418 # blank all files are included.\r
419 \r
420 EXAMPLE_PATTERNS       = \r
421 \r
422 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be \r
423 # searched for input files to be used with the \include or \dontinclude \r
424 # commands irrespective of the value of the RECURSIVE tag. \r
425 # Possible values are YES and NO. If left blank NO is used.\r
426 \r
427 EXAMPLE_RECURSIVE      = NO\r
428 \r
429 # The IMAGE_PATH tag can be used to specify one or more files or \r
430 # directories that contain image that are included in the documentation (see \r
431 # the \image command).\r
432 \r
433 IMAGE_PATH             = ..\src ..\src\Utils ..\src\Utils\MiscUI\r
434 \r
435 # The INPUT_FILTER tag can be used to specify a program that doxygen should \r
436 # invoke to filter for each input file. Doxygen will invoke the filter program \r
437 # by executing (via popen()) the command <filter> <input-file>, where <filter> \r
438 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an \r
439 # input file. Doxygen will then use the output that the filter program writes \r
440 # to standard output.\r
441 \r
442 INPUT_FILTER           = \r
443 \r
444 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using \r
445 # INPUT_FILTER) will be used to filter the input files when producing source \r
446 # files to browse (i.e. when SOURCE_BROWSER is set to YES).\r
447 \r
448 FILTER_SOURCE_FILES    = NO\r
449 \r
450 #---------------------------------------------------------------------------\r
451 # configuration options related to source browsing\r
452 #---------------------------------------------------------------------------\r
453 \r
454 # If the SOURCE_BROWSER tag is set to YES then a list of source files will \r
455 # be generated. Documented entities will be cross-referenced with these sources. \r
456 # Note: To get rid of all source code in the generated output, make sure also \r
457 # VERBATIM_HEADERS is set to NO.\r
458 \r
459 SOURCE_BROWSER         = NO\r
460 \r
461 # Setting the INLINE_SOURCES tag to YES will include the body \r
462 # of functions and classes directly in the documentation.\r
463 \r
464 INLINE_SOURCES         = NO\r
465 \r
466 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct \r
467 # doxygen to hide any special comment blocks from generated source code \r
468 # fragments. Normal C and C++ comments will always remain visible.\r
469 \r
470 STRIP_CODE_COMMENTS    = YES\r
471 \r
472 # If the REFERENCED_BY_RELATION tag is set to YES (the default) \r
473 # then for each documented function all documented \r
474 # functions referencing it will be listed.\r
475 \r
476 REFERENCED_BY_RELATION = YES\r
477 \r
478 # If the REFERENCES_RELATION tag is set to YES (the default) \r
479 # then for each documented function all documented entities \r
480 # called/used by that function will be listed.\r
481 \r
482 REFERENCES_RELATION    = YES\r
483 \r
484 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen \r
485 # will generate a verbatim copy of the header file for each class for \r
486 # which an include is specified. Set to NO to disable this.\r
487 \r
488 VERBATIM_HEADERS       = NO\r
489 \r
490 #---------------------------------------------------------------------------\r
491 # configuration options related to the alphabetical class index\r
492 #---------------------------------------------------------------------------\r
493 \r
494 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index \r
495 # of all compounds will be generated. Enable this if the project \r
496 # contains a lot of classes, structs, unions or interfaces.\r
497 \r
498 ALPHABETICAL_INDEX     = YES\r
499 \r
500 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then \r
501 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns \r
502 # in which this list will be split (can be a number in the range [1..20])\r
503 \r
504 COLS_IN_ALPHA_INDEX    = 5\r
505 \r
506 # In case all classes in a project start with a common prefix, all \r
507 # classes will be put under the same header in the alphabetical index. \r
508 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that \r
509 # should be ignored while generating the index headers.\r
510 \r
511 IGNORE_PREFIX          = C\r
512 \r
513 #---------------------------------------------------------------------------\r
514 # configuration options related to the HTML output\r
515 #---------------------------------------------------------------------------\r
516 \r
517 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will \r
518 # generate HTML output.\r
519 \r
520 GENERATE_HTML          = YES\r
521 \r
522 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. \r
523 # If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
524 # put in front of it. If left blank `html' will be used as the default path.\r
525 \r
526 HTML_OUTPUT            = html\r
527 \r
528 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for \r
529 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank \r
530 # doxygen will generate files with .html extension.\r
531 \r
532 HTML_FILE_EXTENSION    = .html\r
533 \r
534 # The HTML_HEADER tag can be used to specify a personal HTML header for \r
535 # each generated HTML page. If it is left blank doxygen will generate a \r
536 # standard header.\r
537 \r
538 HTML_HEADER            = \r
539 \r
540 # The HTML_FOOTER tag can be used to specify a personal HTML footer for \r
541 # each generated HTML page. If it is left blank doxygen will generate a \r
542 # standard footer.\r
543 \r
544 HTML_FOOTER            = \r
545 \r
546 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading \r
547 # style sheet that is used by each HTML page. It can be used to \r
548 # fine-tune the look of the HTML output. If the tag is left blank doxygen \r
549 # will generate a default style sheet. Note that doxygen will try to copy \r
550 # the style sheet file to the HTML output directory, so don't put your own \r
551 # stylesheet in the HTML output directory as well, or it will be erased!\r
552 \r
553 HTML_STYLESHEET        = \r
554 \r
555 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, \r
556 # files or namespaces will be aligned in HTML using tables. If set to \r
557 # NO a bullet list will be used.\r
558 \r
559 HTML_ALIGN_MEMBERS     = YES\r
560 \r
561 # If the GENERATE_HTMLHELP tag is set to YES, additional index files \r
562 # will be generated that can be used as input for tools like the \r
563 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) \r
564 # of the generated HTML documentation.\r
565 \r
566 GENERATE_HTMLHELP      = YES\r
567 \r
568 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can \r
569 # be used to specify the file name of the resulting .chm file. You \r
570 # can add a path in front of the file if the result should not be \r
571 # written to the html output directory.\r
572 \r
573 CHM_FILE               = TortoiseAPI.chm\r
574 \r
575 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag \r
576 # controls if a separate .chi index file is generated (YES) or that \r
577 # it should be included in the master .chm file (NO).\r
578 \r
579 GENERATE_CHI           = NO\r
580 \r
581 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag \r
582 # controls whether a binary table of contents is generated (YES) or a \r
583 # normal table of contents (NO) in the .chm file.\r
584 \r
585 BINARY_TOC             = NO\r
586 \r
587 # The TOC_EXPAND flag can be set to YES to add extra items for group members \r
588 # to the contents of the HTML help documentation and to the tree view.\r
589 \r
590 TOC_EXPAND             = NO\r
591 \r
592 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at \r
593 # top of each HTML page. The value NO (the default) enables the index and \r
594 # the value YES disables it.\r
595 \r
596 DISABLE_INDEX          = NO\r
597 \r
598 # This tag can be used to set the number of enum values (range [1..20]) \r
599 # that doxygen will group on one line in the generated HTML documentation.\r
600 \r
601 ENUM_VALUES_PER_LINE   = 4\r
602 \r
603 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be\r
604 # generated containing a tree-like index structure (just like the one that \r
605 # is generated for HTML Help). For this to work a browser that supports \r
606 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, \r
607 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are \r
608 # probably better off using the HTML help feature.\r
609 \r
610 GENERATE_TREEVIEW      = NO\r
611 \r
612 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be \r
613 # used to set the initial width (in pixels) of the frame in which the tree \r
614 # is shown.\r
615 \r
616 TREEVIEW_WIDTH         = 250\r
617 \r
618 #---------------------------------------------------------------------------\r
619 # configuration options related to the LaTeX output\r
620 #---------------------------------------------------------------------------\r
621 \r
622 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will \r
623 # generate Latex output.\r
624 \r
625 GENERATE_LATEX         = NO\r
626 \r
627 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. \r
628 # If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
629 # put in front of it. If left blank `latex' will be used as the default path.\r
630 \r
631 LATEX_OUTPUT           = latex\r
632 \r
633 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be \r
634 # invoked. If left blank `latex' will be used as the default command name.\r
635 \r
636 LATEX_CMD_NAME         = latex\r
637 \r
638 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to \r
639 # generate index for LaTeX. If left blank `makeindex' will be used as the \r
640 # default command name.\r
641 \r
642 MAKEINDEX_CMD_NAME     = makeindex\r
643 \r
644 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact \r
645 # LaTeX documents. This may be useful for small projects and may help to \r
646 # save some trees in general.\r
647 \r
648 COMPACT_LATEX          = NO\r
649 \r
650 # The PAPER_TYPE tag can be used to set the paper type that is used \r
651 # by the printer. Possible values are: a4, a4wide, letter, legal and \r
652 # executive. If left blank a4wide will be used.\r
653 \r
654 PAPER_TYPE             = a4wide\r
655 \r
656 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX \r
657 # packages that should be included in the LaTeX output.\r
658 \r
659 EXTRA_PACKAGES         = \r
660 \r
661 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for \r
662 # the generated latex document. The header should contain everything until \r
663 # the first chapter. If it is left blank doxygen will generate a \r
664 # standard header. Notice: only use this tag if you know what you are doing!\r
665 \r
666 LATEX_HEADER           = \r
667 \r
668 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated \r
669 # is prepared for conversion to pdf (using ps2pdf). The pdf file will \r
670 # contain links (just like the HTML output) instead of page references \r
671 # This makes the output suitable for online browsing using a pdf viewer.\r
672 \r
673 PDF_HYPERLINKS         = NO\r
674 \r
675 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of \r
676 # plain latex in the generated Makefile. Set this option to YES to get a \r
677 # higher quality PDF documentation.\r
678 \r
679 USE_PDFLATEX           = NO\r
680 \r
681 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. \r
682 # command to the generated LaTeX files. This will instruct LaTeX to keep \r
683 # running if errors occur, instead of asking the user for help. \r
684 # This option is also used when generating formulas in HTML.\r
685 \r
686 LATEX_BATCHMODE        = NO\r
687 \r
688 # If LATEX_HIDE_INDICES is set to YES then doxygen will not \r
689 # include the index chapters (such as File Index, Compound Index, etc.) \r
690 # in the output.\r
691 \r
692 LATEX_HIDE_INDICES     = NO\r
693 \r
694 #---------------------------------------------------------------------------\r
695 # configuration options related to the RTF output\r
696 #---------------------------------------------------------------------------\r
697 \r
698 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output \r
699 # The RTF output is optimized for Word 97 and may not look very pretty with \r
700 # other RTF readers or editors.\r
701 \r
702 GENERATE_RTF           = NO\r
703 \r
704 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. \r
705 # If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
706 # put in front of it. If left blank `rtf' will be used as the default path.\r
707 \r
708 RTF_OUTPUT             = rtf\r
709 \r
710 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact \r
711 # RTF documents. This may be useful for small projects and may help to \r
712 # save some trees in general.\r
713 \r
714 COMPACT_RTF            = NO\r
715 \r
716 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated \r
717 # will contain hyperlink fields. The RTF file will \r
718 # contain links (just like the HTML output) instead of page references. \r
719 # This makes the output suitable for online browsing using WORD or other \r
720 # programs which support those fields. \r
721 # Note: wordpad (write) and others do not support links.\r
722 \r
723 RTF_HYPERLINKS         = NO\r
724 \r
725 # Load stylesheet definitions from file. Syntax is similar to doxygen's \r
726 # config file, i.e. a series of assignments. You only have to provide \r
727 # replacements, missing definitions are set to their default value.\r
728 \r
729 RTF_STYLESHEET_FILE    = \r
730 \r
731 # Set optional variables used in the generation of an rtf document. \r
732 # Syntax is similar to doxygen's config file.\r
733 \r
734 RTF_EXTENSIONS_FILE    = \r
735 \r
736 #---------------------------------------------------------------------------\r
737 # configuration options related to the man page output\r
738 #---------------------------------------------------------------------------\r
739 \r
740 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will \r
741 # generate man pages\r
742 \r
743 GENERATE_MAN           = NO\r
744 \r
745 # The MAN_OUTPUT tag is used to specify where the man pages will be put. \r
746 # If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
747 # put in front of it. If left blank `man' will be used as the default path.\r
748 \r
749 MAN_OUTPUT             = man\r
750 \r
751 # The MAN_EXTENSION tag determines the extension that is added to \r
752 # the generated man pages (default is the subroutine's section .3)\r
753 \r
754 MAN_EXTENSION          = .3\r
755 \r
756 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, \r
757 # then it will generate one additional man file for each entity \r
758 # documented in the real man page(s). These additional files \r
759 # only source the real man page, but without them the man command \r
760 # would be unable to find the correct page. The default is NO.\r
761 \r
762 MAN_LINKS              = NO\r
763 \r
764 #---------------------------------------------------------------------------\r
765 # configuration options related to the XML output\r
766 #---------------------------------------------------------------------------\r
767 \r
768 # If the GENERATE_XML tag is set to YES Doxygen will \r
769 # generate an XML file that captures the structure of \r
770 # the code including all documentation.\r
771 \r
772 GENERATE_XML           = NO\r
773 \r
774 # The XML_OUTPUT tag is used to specify where the XML pages will be put. \r
775 # If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
776 # put in front of it. If left blank `xml' will be used as the default path.\r
777 \r
778 XML_OUTPUT             = xml\r
779 \r
780 # The XML_SCHEMA tag can be used to specify an XML schema, \r
781 # which can be used by a validating XML parser to check the \r
782 # syntax of the XML files.\r
783 \r
784 XML_SCHEMA             = \r
785 \r
786 # The XML_DTD tag can be used to specify an XML DTD, \r
787 # which can be used by a validating XML parser to check the \r
788 # syntax of the XML files.\r
789 \r
790 XML_DTD                = \r
791 \r
792 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will \r
793 # dump the program listings (including syntax highlighting \r
794 # and cross-referencing information) to the XML output. Note that \r
795 # enabling this will significantly increase the size of the XML output.\r
796 \r
797 XML_PROGRAMLISTING     = YES\r
798 \r
799 #---------------------------------------------------------------------------\r
800 # configuration options for the AutoGen Definitions output\r
801 #---------------------------------------------------------------------------\r
802 \r
803 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will \r
804 # generate an AutoGen Definitions (see autogen.sf.net) file \r
805 # that captures the structure of the code including all \r
806 # documentation. Note that this feature is still experimental \r
807 # and incomplete at the moment.\r
808 \r
809 GENERATE_AUTOGEN_DEF   = NO\r
810 \r
811 #---------------------------------------------------------------------------\r
812 # configuration options related to the Perl module output\r
813 #---------------------------------------------------------------------------\r
814 \r
815 # If the GENERATE_PERLMOD tag is set to YES Doxygen will \r
816 # generate a Perl module file that captures the structure of \r
817 # the code including all documentation. Note that this \r
818 # feature is still experimental and incomplete at the \r
819 # moment.\r
820 \r
821 GENERATE_PERLMOD       = NO\r
822 \r
823 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate \r
824 # the necessary Makefile rules, Perl scripts and LaTeX code to be able \r
825 # to generate PDF and DVI output from the Perl module output.\r
826 \r
827 PERLMOD_LATEX          = NO\r
828 \r
829 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be \r
830 # nicely formatted so it can be parsed by a human reader.  This is useful \r
831 # if you want to understand what is going on.  On the other hand, if this \r
832 # tag is set to NO the size of the Perl module output will be much smaller \r
833 # and Perl will parse it just the same.\r
834 \r
835 PERLMOD_PRETTY         = YES\r
836 \r
837 # The names of the make variables in the generated doxyrules.make file \r
838 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. \r
839 # This is useful so different doxyrules.make files included by the same \r
840 # Makefile don't overwrite each other's variables.\r
841 \r
842 PERLMOD_MAKEVAR_PREFIX = \r
843 \r
844 #---------------------------------------------------------------------------\r
845 # Configuration options related to the preprocessor   \r
846 #---------------------------------------------------------------------------\r
847 \r
848 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will \r
849 # evaluate all C-preprocessor directives found in the sources and include \r
850 # files.\r
851 \r
852 ENABLE_PREPROCESSING   = YES\r
853 \r
854 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro \r
855 # names in the source code. If set to NO (the default) only conditional \r
856 # compilation will be performed. Macro expansion can be done in a controlled \r
857 # way by setting EXPAND_ONLY_PREDEF to YES.\r
858 \r
859 MACRO_EXPANSION        = NO\r
860 \r
861 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES \r
862 # then the macro expansion is limited to the macros specified with the \r
863 # PREDEFINED and EXPAND_AS_PREDEFINED tags.\r
864 \r
865 EXPAND_ONLY_PREDEF     = NO\r
866 \r
867 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files \r
868 # in the INCLUDE_PATH (see below) will be search if a #include is found.\r
869 \r
870 SEARCH_INCLUDES        = YES\r
871 \r
872 # The INCLUDE_PATH tag can be used to specify one or more directories that \r
873 # contain include files that are not input files but should be processed by \r
874 # the preprocessor.\r
875 \r
876 INCLUDE_PATH           = \r
877 \r
878 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard \r
879 # patterns (like *.h and *.hpp) to filter out the header-files in the \r
880 # directories. If left blank, the patterns specified with FILE_PATTERNS will \r
881 # be used.\r
882 \r
883 INCLUDE_FILE_PATTERNS  = \r
884 \r
885 # The PREDEFINED tag can be used to specify one or more macro names that \r
886 # are defined before the preprocessor is started (similar to the -D option of \r
887 # gcc). The argument of the tag is a list of macros of the form: name \r
888 # or name=definition (no spaces). If the definition and the = are \r
889 # omitted =1 is assumed.\r
890 \r
891 PREDEFINED             = "DECLARE_INTERFACE(name)=class name" \\r
892 "STDMETHOD(result,name)=virtual result name" \\r
893 "PURE= = 0" \\r
894 THIS_= \\r
895 THIS= \\r
896 DECLARE_REGISTRY_RESOURCEID=// \\r
897 DECLARE_PROTECT_FINAL_CONSTRUCT=// \\r
898 "DECLARE_AGGREGATABLE(Class)= " \\r
899 "DECLARE_REGISTRY_RESOURCEID(Id)= " \\r
900 DECLARE_MESSAGE_MAP = \\r
901 BEGIN_MESSAGE_MAP=/* \\r
902 END_MESSAGE_MAP=*/// \\r
903 BEGIN_COM_MAP=/* \\r
904 END_COM_MAP=*/// \\r
905 BEGIN_PROP_MAP=/* \\r
906 END_PROP_MAP=*/// \\r
907 BEGIN_MSG_MAP=/* \\r
908 END_MSG_MAP=*/// \\r
909 BEGIN_PROPERTY_MAP=/* \\r
910 END_PROPERTY_MAP=*/// \\r
911 BEGIN_OBJECT_MAP=/* \\r
912 END_OBJECT_MAP()=*/// \\r
913 DECLARE_VIEW_STATUS=// \\r
914 "STDMETHOD(a)=HRESULT a" \\r
915 "ATL_NO_VTABLE= " \\r
916 "__declspec(a)= " \\r
917 BEGIN_CONNECTION_POINT_MAP=/* \\r
918 END_CONNECTION_POINT_MAP=*/// \\r
919 "DECLARE_DYNAMIC(class)= " \\r
920 "IMPLEMENT_DYNAMIC(class1, class2)= " \\r
921 "DECLARE_DYNCREATE(class)= " \\r
922 "IMPLEMENT_DYNCREATE(class1, class2)= " \\r
923 "IMPLEMENT_SERIAL(class1, class2, class3)= " \\r
924 "DECLARE_MESSAGE_MAP()= " \\r
925 TRY=try \\r
926 "CATCH_ALL(e)= catch(...)" \\r
927 END_CATCH_ALL= \\r
928 "THROW_LAST()= throw"\\r
929 "RUNTIME_CLASS(class)=class" \\r
930 "MAKEINTRESOURCE(nId)=nId" \\r
931 "IMPLEMENT_REGISTER(v, w, x, y, z)= " \\r
932 "ASSERT(x)=assert(x)" \\r
933 "ASSERT_VALID(x)=assert(x)" \\r
934 "TRACE0(x)=printf(x)" \\r
935 "OS_ERR(A,B)={ #A, B }" \\r
936 __cplusplus \\r
937 "DECLARE_OLECREATE(class)= " \\r
938 "BEGIN_DISPATCH_MAP(class1, class2)= " \\r
939 "INTERFACE_PART(class, id, name)= " \\r
940 "END_INTERFACE_MAP()=" \\r
941 "DISP_FUNCTION(class, name, function, result, id)=" \\r
942 "END_DISPATCH_MAP()=" \\r
943 "IMPLEMENT_OLECREATE2(class, name, id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11)="\r
944 \r
945 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then \r
946 # this tag can be used to specify a list of macro names that should be expanded. \r
947 # The macro definition that is found in the sources will be used. \r
948 # Use the PREDEFINED tag if you want to use a different macro definition.\r
949 \r
950 EXPAND_AS_DEFINED      = \r
951 \r
952 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then \r
953 # doxygen's preprocessor will remove all function-like macros that are alone \r
954 # on a line, have an all uppercase name, and do not end with a semicolon. Such \r
955 # function macros are typically used for boiler-plate code, and will confuse the \r
956 # parser if not removed.\r
957 \r
958 SKIP_FUNCTION_MACROS   = YES\r
959 \r
960 #---------------------------------------------------------------------------\r
961 # Configuration::addtions related to external references   \r
962 #---------------------------------------------------------------------------\r
963 \r
964 # The TAGFILES option can be used to specify one or more tagfiles. \r
965 # Optionally an initial location of the external documentation \r
966 # can be added for each tagfile. The format of a tag file without \r
967 # this location is as follows: \r
968 #   TAGFILES = file1 file2 ... \r
969 # Adding location for the tag files is done as follows: \r
970 #   TAGFILES = file1=loc1 "file2 = loc2" ... \r
971 # where "loc1" and "loc2" can be relative or absolute paths or \r
972 # URLs. If a location is present for each tag, the installdox tool \r
973 # does not have to be run to correct the links.\r
974 # Note that each tag file must have a unique name\r
975 # (where the name does NOT include the path)\r
976 # If a tag file is not located in the directory in which doxygen \r
977 # is run, you must also specify the path to the tagfile here.\r
978 \r
979 TAGFILES               = \r
980 \r
981 # When a file name is specified after GENERATE_TAGFILE, doxygen will create \r
982 # a tag file that is based on the input files it reads.\r
983 \r
984 GENERATE_TAGFILE       = \r
985 \r
986 # If the ALLEXTERNALS tag is set to YES all external classes will be listed \r
987 # in the class index. If set to NO only the inherited external classes \r
988 # will be listed.\r
989 \r
990 ALLEXTERNALS           = NO\r
991 \r
992 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed \r
993 # in the modules index. If set to NO, only the current project's groups will \r
994 # be listed.\r
995 \r
996 EXTERNAL_GROUPS        = YES\r
997 \r
998 # The PERL_PATH should be the absolute path and name of the perl script \r
999 # interpreter (i.e. the result of `which perl').\r
1000 \r
1001 PERL_PATH              = /usr/bin/perl\r
1002 \r
1003 #---------------------------------------------------------------------------\r
1004 # Configuration options related to the dot tool   \r
1005 #---------------------------------------------------------------------------\r
1006 \r
1007 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will \r
1008 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or \r
1009 # super classes. Setting the tag to NO turns the diagrams off. Note that this \r
1010 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is \r
1011 # recommended to install and use dot, since it yields more powerful graphs.\r
1012 \r
1013 CLASS_DIAGRAMS         = NO\r
1014 \r
1015 # If set to YES, the inheritance and collaboration graphs will hide \r
1016 # inheritance and usage relations if the target is undocumented \r
1017 # or is not a class.\r
1018 \r
1019 HIDE_UNDOC_RELATIONS   = NO\r
1020 \r
1021 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is \r
1022 # available from the path. This tool is part of Graphviz, a graph visualization \r
1023 # toolkit from AT&T and Lucent Bell Labs. The other options in this section \r
1024 # have no effect if this option is set to NO (the default)\r
1025 \r
1026 HAVE_DOT               = YES\r
1027 \r
1028 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen \r
1029 # will generate a graph for each documented class showing the direct and \r
1030 # indirect inheritance relations. Setting this tag to YES will force the \r
1031 # the CLASS_DIAGRAMS tag to NO.\r
1032 \r
1033 CLASS_GRAPH            = NO\r
1034 \r
1035 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen \r
1036 # will generate a graph for each documented class showing the direct and \r
1037 # indirect implementation dependencies (inheritance, containment, and \r
1038 # class references variables) of the class with other documented classes.\r
1039 \r
1040 COLLABORATION_GRAPH    = YES\r
1041 \r
1042 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and \r
1043 # collaboration diagrams in a style similar to the OMG's Unified Modeling \r
1044 # Language.\r
1045 \r
1046 UML_LOOK               = NO\r
1047 \r
1048 # If set to YES, the inheritance and collaboration graphs will show the \r
1049 # relations between templates and their instances.\r
1050 \r
1051 TEMPLATE_RELATIONS     = NO\r
1052 \r
1053 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT \r
1054 # tags are set to YES then doxygen will generate a graph for each documented \r
1055 # file showing the direct and indirect include dependencies of the file with \r
1056 # other documented files.\r
1057 \r
1058 INCLUDE_GRAPH          = YES\r
1059 \r
1060 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and \r
1061 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each \r
1062 # documented header file showing the documented files that directly or \r
1063 # indirectly include this file.\r
1064 \r
1065 INCLUDED_BY_GRAPH      = YES\r
1066 \r
1067 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will \r
1068 # generate a call dependency graph for every global function or class method. \r
1069 # Note that enabling this option will significantly increase the time of a run. \r
1070 # So in most cases it will be better to enable call graphs for selected \r
1071 # functions only using the \callgraph command.\r
1072 \r
1073 CALL_GRAPH             = NO\r
1074 \r
1075 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen \r
1076 # will graphical hierarchy of all classes instead of a textual one.\r
1077 \r
1078 GRAPHICAL_HIERARCHY    = YES\r
1079 \r
1080 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images \r
1081 # generated by dot. Possible values are png, jpg, or gif\r
1082 # If left blank png will be used.\r
1083 \r
1084 DOT_IMAGE_FORMAT       = png\r
1085 \r
1086 # The tag DOT_PATH can be used to specify the path where the dot tool can be \r
1087 # found. If left blank, it is assumed the dot tool can be found on the path.\r
1088 \r
1089 DOT_PATH               = \r
1090 \r
1091 # The DOTFILE_DIRS tag can be used to specify one or more directories that \r
1092 # contain dot files that are included in the documentation (see the \r
1093 # \dotfile command).\r
1094 \r
1095 DOTFILE_DIRS           = \r
1096 \r
1097 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width \r
1098 # (in pixels) of the graphs generated by dot. If a graph becomes larger than \r
1099 # this value, doxygen will try to truncate the graph, so that it fits within \r
1100 # the specified constraint. Beware that most browsers cannot cope with very \r
1101 # large images.\r
1102 \r
1103 MAX_DOT_GRAPH_WIDTH    = 1024\r
1104 \r
1105 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height \r
1106 # (in pixels) of the graphs generated by dot. If a graph becomes larger than \r
1107 # this value, doxygen will try to truncate the graph, so that it fits within \r
1108 # the specified constraint. Beware that most browsers cannot cope with very \r
1109 # large images.\r
1110 \r
1111 MAX_DOT_GRAPH_HEIGHT   = 1024\r
1112 \r
1113 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the \r
1114 # graphs generated by dot. A depth value of 3 means that only nodes reachable \r
1115 # from the root by following a path via at most 3 edges will be shown. Nodes that \r
1116 # lay further from the root node will be omitted. Note that setting this option to \r
1117 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also \r
1118 # note that a graph may be further truncated if the graph's image dimensions are \r
1119 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). \r
1120 # If 0 is used for the depth value (the default), the graph is not depth-constrained.\r
1121 \r
1122 MAX_DOT_GRAPH_DEPTH    = 0\r
1123 \r
1124 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will \r
1125 # generate a legend page explaining the meaning of the various boxes and \r
1126 # arrows in the dot generated graphs.\r
1127 \r
1128 GENERATE_LEGEND        = YES\r
1129 \r
1130 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will \r
1131 # remove the intermediate dot files that are used to generate \r
1132 # the various graphs.\r
1133 \r
1134 DOT_CLEANUP            = YES\r
1135 \r
1136 #---------------------------------------------------------------------------\r
1137 # Configuration::addtions related to the search engine   \r
1138 #---------------------------------------------------------------------------\r
1139 \r
1140 # The SEARCHENGINE tag specifies whether or not a search engine should be \r
1141 # used. If set to NO the values of all tags below this one will be ignored.\r
1142 \r
1143 SEARCHENGINE           = NO\r
1144 \r