| blob | bdf91806e6258269386c3a51abd4106b22309804 |
1 # Doxyfile 1.3-rc1\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 # General 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 = Git\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 = \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 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in \r
47 # documentation are documented, even if no documentation was available. \r
48 # Private class members and static file members will be hidden unless \r
49 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES\r
50 \r
51 EXTRACT_ALL = NO\r
52 \r
53 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class \r
54 # will be included in the documentation.\r
55 \r
56 EXTRACT_PRIVATE = NO\r
57 \r
58 # If the EXTRACT_STATIC tag is set to YES all static members of a file \r
59 # will be included in the documentation.\r
60 \r
61 EXTRACT_STATIC = NO\r
62 \r
63 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) \r
64 # defined locally in source files will be included in the documentation. \r
65 # If set to NO only classes defined in header files are included.\r
66 \r
67 EXTRACT_LOCAL_CLASSES = YES\r
68 \r
69 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all \r
70 # undocumented members of documented classes, files or namespaces. \r
71 # If set to NO (the default) these members will be included in the \r
72 # various overviews, but no documentation section is generated. \r
73 # This option has no effect if EXTRACT_ALL is enabled.\r
74 \r
75 HIDE_UNDOC_MEMBERS = NO\r
76 \r
77 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all \r
78 # undocumented classes that are normally visible in the class hierarchy. \r
79 # If set to NO (the default) these class will be included in the various \r
80 # overviews. This option has no effect if EXTRACT_ALL is enabled.\r
81 \r
82 HIDE_UNDOC_CLASSES = NO\r
83 \r
84 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all \r
85 # friend (class|struct|union) declarations. \r
86 # If set to NO (the default) these declarations will be included in the \r
87 # documentation.\r
88 \r
89 HIDE_FRIEND_COMPOUNDS = NO\r
90 \r
91 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any \r
92 # documentation blocks found inside the body of a function. \r
93 # If set to NO (the default) these blocks will be appended to the \r
94 # function's detailed documentation block.\r
95 \r
96 HIDE_IN_BODY_DOCS = NO\r
97 \r
98 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will \r
99 # include brief member descriptions after the members that are listed in \r
100 # the file and class documentation (similar to JavaDoc). \r
101 # Set to NO to disable this.\r
102 \r
103 BRIEF_MEMBER_DESC = YES\r
104 \r
105 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend \r
106 # the brief description of a member or function before the detailed description. \r
107 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the \r
108 # brief descriptions will be completely suppressed.\r
109 \r
110 REPEAT_BRIEF = YES\r
111 \r
112 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then \r
113 # Doxygen will generate a detailed section even if there is only a brief \r
114 # description.\r
115 \r
116 ALWAYS_DETAILED_SEC = NO\r
117 \r
118 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited \r
119 # members of a class in the documentation of that class as if those members were \r
120 # ordinary class members. Constructors, destructors and assignment operators of \r
121 # the base classes will not be shown.\r
122 \r
123 INLINE_INHERITED_MEMB = NO\r
124 \r
125 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full \r
126 # path before files name in the file list and in the header files. If set \r
127 # to NO the shortest path that makes the file name unique will be used.\r
128 \r
129 FULL_PATH_NAMES = NO\r
130 \r
131 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag \r
132 # can be used to strip a user defined part of the path. Stripping is \r
133 # only done if one of the specified strings matches the left-hand part of \r
134 # the path. It is allowed to use relative paths in the argument list.\r
135 \r
136 STRIP_FROM_PATH = \r
137 \r
138 # The INTERNAL_DOCS tag determines if documentation \r
139 # that is typed after a \internal command is included. If the tag is set \r
140 # to NO (the default) then the documentation will be excluded. \r
141 # Set it to YES to include the internal documentation.\r
142 \r
143 INTERNAL_DOCS = NO\r
144 \r
145 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate \r
146 # file names in lower case letters. If set to YES upper case letters are also \r
147 # allowed. This is useful if you have classes or files whose names only differ \r
148 # in case and if your file system supports case sensitive file names. Windows \r
149 # users are adviced to set this option to NO.\r
150 \r
151 CASE_SENSE_NAMES = YES\r
152 \r
153 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter \r
154 # (but less readable) file names. This can be useful is your file systems \r
155 # doesn't support long names like on DOS, Mac, or CD-ROM.\r
156 \r
157 SHORT_NAMES = NO\r
158 \r
159 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen \r
160 # will show members with their full class and namespace scopes in the \r
161 # documentation. If set to YES the scope will be hidden.\r
162 \r
163 HIDE_SCOPE_NAMES = NO\r
164 \r
165 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen \r
166 # will generate a verbatim copy of the header file for each class for \r
167 # which an include is specified. Set to NO to disable this.\r
168 \r
169 VERBATIM_HEADERS = YES\r
170 \r
171 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen \r
172 # will put list of the files that are included by a file in the documentation \r
173 # of that file.\r
174 \r
175 SHOW_INCLUDE_FILES = YES\r
176 \r
177 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen \r
178 # will interpret the first line (until the first dot) of a JavaDoc-style \r
179 # comment as the brief description. If set to NO, the JavaDoc \r
180 # comments will behave just like the Qt-style comments (thus requiring an \r
181 # explict @brief command for a brief description.\r
182 \r
183 JAVADOC_AUTOBRIEF = YES\r
184 \r
185 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen \r
186 # treat a multi-line C++ special comment block (i.e. a block of //! or /// \r
187 # comments) as a brief description. This used to be the default behaviour. \r
188 # The new default is to treat a multi-line C++ comment block as a detailed \r
189 # description. Set this tag to YES if you prefer the old behaviour instead.\r
190 \r
191 MULTILINE_CPP_IS_BRIEF = NO\r
192 \r
193 # If the DETAILS_AT_TOP tag is set to YES then Doxygen \r
194 # will output the detailed description near the top, like JavaDoc.\r
195 # If set to NO, the detailed description appears after the member \r
196 # documentation.\r
197 \r
198 DETAILS_AT_TOP = NO\r
199 \r
200 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented \r
201 # member inherits the documentation from any documented member that it \r
202 # reimplements.\r
203 \r
204 INHERIT_DOCS = YES\r
205 \r
206 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] \r
207 # is inserted in the documentation for inline members.\r
208 \r
209 INLINE_INFO = YES\r
210 \r
211 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen \r
212 # will sort the (detailed) documentation of file and class members \r
213 # alphabetically by member name. If set to NO the members will appear in \r
214 # declaration order.\r
215 \r
216 SORT_MEMBER_DOCS = YES\r
217 \r
218 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC \r
219 # tag is set to YES, then doxygen will reuse the documentation of the first \r
220 # member in the group (if any) for the other members of the group. By default \r
221 # all members of a group must be documented explicitly.\r
222 \r
223 DISTRIBUTE_GROUP_DOC = NO\r
224 \r
225 # The TAB_SIZE tag can be used to set the number of spaces in a tab. \r
226 # Doxygen uses this value to replace tabs by spaces in code fragments.\r
227 \r
228 TAB_SIZE = 8\r
229 \r
230 # The GENERATE_TODOLIST tag can be used to enable (YES) or \r
231 # disable (NO) the todo list. This list is created by putting \todo \r
232 # commands in the documentation.\r
233 \r
234 GENERATE_TODOLIST = YES\r
235 \r
236 # The GENERATE_TESTLIST tag can be used to enable (YES) or \r
237 # disable (NO) the test list. This list is created by putting \test \r
238 # commands in the documentation.\r
239 \r
240 GENERATE_TESTLIST = YES\r
241 \r
242 # The GENERATE_BUGLIST tag can be used to enable (YES) or \r
243 # disable (NO) the bug list. This list is created by putting \bug \r
244 # commands in the documentation.\r
245 \r
246 GENERATE_BUGLIST = YES\r
247 \r
248 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or \r
249 # disable (NO) the deprecated list. This list is created by putting \r
250 # \deprecated commands in the documentation.\r
251 \r
252 GENERATE_DEPRECATEDLIST= YES\r
253 \r
254 # This tag can be used to specify a number of aliases that acts \r
255 # as commands in the documentation. An alias has the form "name=value". \r
256 # For example adding "sideeffect=\par Side Effects:\n" will allow you to \r
257 # put the command \sideeffect (or @sideeffect) in the documentation, which \r
258 # will result in a user defined paragraph with heading "Side Effects:". \r
259 # You can put \n's in the value part of an alias to insert newlines.\r
260 \r
261 ALIASES = "copyright=@if copyrights" \\r
262 "endcopyright=@endif"\r
263 \r
264 # The ENABLED_SECTIONS tag can be used to enable conditional \r
265 # documentation sections, marked by \if sectionname ... \endif.\r
266 \r
267 ENABLED_SECTIONS = \r
268 \r
269 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines \r
270 # the initial value of a variable or define consist of for it to appear in \r
271 # the documentation. If the initializer consists of more lines than specified \r
272 # here it will be hidden. Use a value of 0 to hide initializers completely. \r
273 # The appearance of the initializer of individual variables and defines in the \r
274 # documentation can be controlled using \showinitializer or \hideinitializer \r
275 # command in the documentation regardless of this setting.\r
276 \r
277 MAX_INITIALIZER_LINES = 30\r
278 \r
279 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources \r
280 # only. Doxygen will then generate output that is more tailored for C. \r
281 # For instance some of the names that are used will be different. The list \r
282 # of all members will be omitted, etc.\r
283 \r
284 OPTIMIZE_OUTPUT_FOR_C = YES\r
285 \r
286 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources \r
287 # only. Doxygen will then generate output that is more tailored for Java. \r
288 # For instance namespaces will be presented as packages, qualified scopes \r
289 # will look different, etc.\r
290 \r
291 OPTIMIZE_OUTPUT_JAVA = NO\r
292 \r
293 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated \r
294 # at the bottom of the documentation of classes and structs. If set to YES the \r
295 # list will mention the files that were used to generate the documentation.\r
296 \r
297 SHOW_USED_FILES = YES\r
298 \r
299 #---------------------------------------------------------------------------\r
300 # configuration options related to warning and progress messages\r
301 #---------------------------------------------------------------------------\r
302 \r
303 # The QUIET tag can be used to turn on/off the messages that are generated \r
304 # by doxygen. Possible values are YES and NO. If left blank NO is used.\r
305 \r
306 QUIET = NO\r
307 \r
308 # The WARNINGS tag can be used to turn on/off the warning messages that are \r
309 # generated by doxygen. Possible values are YES and NO. If left blank \r
310 # NO is used.\r
311 \r
312 WARNINGS = YES\r
313 \r
314 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings \r
315 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will \r
316 # automatically be disabled.\r
317 \r
318 WARN_IF_UNDOCUMENTED = YES\r
319 \r
320 # The WARN_FORMAT tag determines the format of the warning messages that \r
321 # doxygen can produce. The string should contain the $file, $line, and $text \r
322 # tags, which will be replaced by the file and line number from which the \r
323 # warning originated and the warning text.\r
324 \r
325 WARN_FORMAT = "$file:$line: $text"\r
326 \r
327 # The WARN_LOGFILE tag can be used to specify a file to which warning \r
328 # and error messages should be written. If left blank the output is written \r
329 # to stderr.\r
330 \r
331 WARN_LOGFILE = \r
332 \r
333 #---------------------------------------------------------------------------\r
334 # configuration options related to the input files\r
335 #---------------------------------------------------------------------------\r
336 \r
337 # The INPUT tag can be used to specify the files and/or directories that contain \r
338 # documented source files. You may enter file names like "myfile.cpp" or \r
339 # directories like "/usr/src/myproject". Separate the files or directories \r
340 # with spaces.\r
341 \r
342 INPUT = ..\ext\Git\Git/include\r
343 \r
344 # If the value of the INPUT tag contains directories, you can use the \r
345 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp \r
346 # and *.h) to filter out the source-files in the directories. If left \r
347 # blank the following patterns are tested: \r
348 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp \r
349 # *.h++ *.idl *.odl\r
350 \r
351 FILE_PATTERNS = *.h\r
352 \r
353 # The RECURSIVE tag can be used to turn specify whether or not subdirectories \r
354 # should be searched for input files as well. Possible values are YES and NO. \r
355 # If left blank NO is used.\r
356 \r
357 RECURSIVE = NO\r
358 \r
359 # The EXCLUDE tag can be used to specify files and/or directories that should \r
360 # excluded from the INPUT source files. This way you can easily exclude a \r
361 # subdirectory from a directory tree whose root is specified with the INPUT tag.\r
362 \r
363 EXCLUDE = \r
364 \r
365 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories \r
366 # that are symbolic links (a Unix filesystem feature) are excluded from the input.\r
367 \r
368 EXCLUDE_SYMLINKS = NO\r
369 \r
370 # If the value of the INPUT tag contains directories, you can use the \r
371 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude \r
372 # certain files from those directories.\r
373 \r
374 EXCLUDE_PATTERNS = \r
375 \r
376 # The EXAMPLE_PATH tag can be used to specify one or more files or \r
377 # directories that contain example code fragments that are included (see \r
378 # the \include command).\r
379 \r
380 EXAMPLE_PATH = \r
381 \r
382 # If the value of the EXAMPLE_PATH tag contains directories, you can use the \r
383 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp \r
384 # and *.h) to filter out the source-files in the directories. If left \r
385 # blank all files are included.\r
386 \r
387 EXAMPLE_PATTERNS = \r
388 \r
389 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be \r
390 # searched for input files to be used with the \include or \dontinclude \r
391 # commands irrespective of the value of the RECURSIVE tag. \r
392 # Possible values are YES and NO. If left blank NO is used.\r
393 \r
394 EXAMPLE_RECURSIVE = NO\r
395 \r
396 # The IMAGE_PATH tag can be used to specify one or more files or \r
397 # directories that contain image that are included in the documentation (see \r
398 # the \image command).\r
399 \r
400 IMAGE_PATH = \r
401 \r
402 # The INPUT_FILTER tag can be used to specify a program that doxygen should \r
403 # invoke to filter for each input file. Doxygen will invoke the filter program \r
404 # by executing (via popen()) the command <filter> <input-file>, where <filter> \r
405 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an \r
406 # input file. Doxygen will then use the output that the filter program writes \r
407 # to standard output.\r
408 \r
409 INPUT_FILTER = \r
410 \r
411 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using \r
412 # INPUT_FILTER) will be used to filter the input files when producing source \r
413 # files to browse (i.e. when SOURCE_BROWSER is set to YES).\r
414 \r
415 FILTER_SOURCE_FILES = NO\r
416 \r
417 #---------------------------------------------------------------------------\r
418 # configuration options related to source browsing\r
419 #---------------------------------------------------------------------------\r
420 \r
421 # If the SOURCE_BROWSER tag is set to YES then a list of source files will \r
422 # be generated. Documented entities will be cross-referenced with these sources.\r
423 \r
424 SOURCE_BROWSER = YES\r
425 \r
426 # Setting the INLINE_SOURCES tag to YES will include the body \r
427 # of functions and classes directly in the documentation.\r
428 \r
429 INLINE_SOURCES = NO\r
430 \r
431 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct \r
432 # doxygen to hide any special comment blocks from generated source code \r
433 # fragments. Normal C and C++ comments will always remain visible.\r
434 \r
435 STRIP_CODE_COMMENTS = NO\r
436 \r
437 # If the REFERENCED_BY_RELATION tag is set to YES (the default) \r
438 # then for each documented function all documented \r
439 # functions referencing it will be listed.\r
440 \r
441 REFERENCED_BY_RELATION = YES\r
442 \r
443 # If the REFERENCES_RELATION tag is set to YES (the default) \r
444 # then for each documented function all documented entities \r
445 # called/used by that function will be listed.\r
446 \r
447 REFERENCES_RELATION = YES\r
448 \r
449 #---------------------------------------------------------------------------\r
450 # configuration options related to the alphabetical class index\r
451 #---------------------------------------------------------------------------\r
452 \r
453 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index \r
454 # of all compounds will be generated. Enable this if the project \r
455 # contains a lot of classes, structs, unions or interfaces.\r
456 \r
457 ALPHABETICAL_INDEX = NO\r
458 \r
459 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then \r
460 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns \r
461 # in which this list will be split (can be a number in the range [1..20])\r
462 \r
463 COLS_IN_ALPHA_INDEX = 5\r
464 \r
465 # In case all classes in a project start with a common prefix, all \r
466 # classes will be put under the same header in the alphabetical index. \r
467 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that \r
468 # should be ignored while generating the index headers.\r
469 \r
470 IGNORE_PREFIX = \r
471 \r
472 #---------------------------------------------------------------------------\r
473 # configuration options related to the HTML output\r
474 #---------------------------------------------------------------------------\r
475 \r
476 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will \r
477 # generate HTML output.\r
478 \r
479 GENERATE_HTML = YES\r
480 \r
481 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. \r
482 # If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
483 # put in front of it. If left blank `html' will be used as the default path.\r
484 \r
485 HTML_OUTPUT = html\r
486 \r
487 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for \r
488 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank \r
489 # doxygen will generate files with .html extension.\r
490 \r
491 HTML_FILE_EXTENSION = .html\r
492 \r
493 # The HTML_HEADER tag can be used to specify a personal HTML header for \r
494 # each generated HTML page. If it is left blank doxygen will generate a \r
495 # standard header.\r
496 \r
497 HTML_HEADER = \r
498 \r
499 # The HTML_FOOTER tag can be used to specify a personal HTML footer for \r
500 # each generated HTML page. If it is left blank doxygen will generate a \r
501 # standard footer.\r
502 \r
503 HTML_FOOTER = \r
504 \r
505 # The HTML_STYLESHEET tag can be used to specify a user defined cascading \r
506 # style sheet that is used by each HTML page. It can be used to \r
507 # fine-tune the look of the HTML output. If the tag is left blank doxygen \r
508 # will generate a default style sheet\r
509 \r
510 HTML_STYLESHEET = \r
511 \r
512 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, \r
513 # files or namespaces will be aligned in HTML using tables. If set to \r
514 # NO a bullet list will be used.\r
515 \r
516 HTML_ALIGN_MEMBERS = YES\r
517 \r
518 # If the GENERATE_HTMLHELP tag is set to YES, additional index files \r
519 # will be generated that can be used as input for tools like the \r
520 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) \r
521 # of the generated HTML documentation.\r
522 \r
523 GENERATE_HTMLHELP = YES\r
524 \r
525 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can \r
526 # be used to specify the file name of the resulting .chm file. You \r
527 # can add a path in front of the file if the result should not be \r
528 # written to the html output dir.\r
529 \r
530 CHM_FILE = GitAPI.chm\r
531 \r
532 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag \r
533 # controls if a separate .chi index file is generated (YES) or that \r
534 # it should be included in the master .chm file (NO).\r
535 \r
536 GENERATE_CHI = NO\r
537 \r
538 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag \r
539 # controls whether a binary table of contents is generated (YES) or a \r
540 # normal table of contents (NO) in the .chm file.\r
541 \r
542 BINARY_TOC = NO\r
543 \r
544 # The TOC_EXPAND flag can be set to YES to add extra items for group members \r
545 # to the contents of the Html help documentation and to the tree view.\r
546 \r
547 TOC_EXPAND = NO\r
548 \r
549 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at \r
550 # top of each HTML page. The value NO (the default) enables the index and \r
551 # the value YES disables it.\r
552 \r
553 DISABLE_INDEX = NO\r
554 \r
555 # This tag can be used to set the number of enum values (range [1..20]) \r
556 # that doxygen will group on one line in the generated HTML documentation.\r
557 \r
558 ENUM_VALUES_PER_LINE = 1\r
559 \r
560 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be\r
561 # generated containing a tree-like index structure (just like the one that \r
562 # is generated for HTML Help). For this to work a browser that supports \r
563 # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+, \r
564 # or Internet explorer 4.0+). Note that for large projects the tree generation \r
565 # can take a very long time. In such cases it is better to disable this feature. \r
566 # Windows users are probably better off using the HTML help feature.\r
567 \r
568 GENERATE_TREEVIEW = NO\r
569 \r
570 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be \r
571 # used to set the initial width (in pixels) of the frame in which the tree \r
572 # is shown.\r
573 \r
574 TREEVIEW_WIDTH = 250\r
575 \r
576 #---------------------------------------------------------------------------\r
577 # configuration options related to the LaTeX output\r
578 #---------------------------------------------------------------------------\r
579 \r
580 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will \r
581 # generate Latex output.\r
582 \r
583 GENERATE_LATEX = NO\r
584 \r
585 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. \r
586 # If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
587 # put in front of it. If left blank `latex' will be used as the default path.\r
588 \r
589 LATEX_OUTPUT = latex\r
590 \r
591 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be \r
592 # invoked. If left blank `latex' will be used as the default command name.\r
593 \r
594 LATEX_CMD_NAME = latex\r
595 \r
596 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to \r
597 # generate index for LaTeX. If left blank `makeindex' will be used as the \r
598 # default command name.\r
599 \r
600 MAKEINDEX_CMD_NAME = makeindex\r
601 \r
602 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact \r
603 # LaTeX documents. This may be useful for small projects and may help to \r
604 # save some trees in general.\r
605 \r
606 COMPACT_LATEX = NO\r
607 \r
608 # The PAPER_TYPE tag can be used to set the paper type that is used \r
609 # by the printer. Possible values are: a4, a4wide, letter, legal and \r
610 # executive. If left blank a4wide will be used.\r
611 \r
612 PAPER_TYPE = a4wide\r
613 \r
614 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX \r
615 # packages that should be included in the LaTeX output.\r
616 \r
617 EXTRA_PACKAGES = \r
618 \r
619 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for \r
620 # the generated latex document. The header should contain everything until \r
621 # the first chapter. If it is left blank doxygen will generate a \r
622 # standard header. Notice: only use this tag if you know what you are doing!\r
623 \r
624 LATEX_HEADER = \r
625 \r
626 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated \r
627 # is prepared for conversion to pdf (using ps2pdf). The pdf file will \r
628 # contain links (just like the HTML output) instead of page references \r
629 # This makes the output suitable for online browsing using a pdf viewer.\r
630 \r
631 PDF_HYPERLINKS = NO\r
632 \r
633 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of \r
634 # plain latex in the generated Makefile. Set this option to YES to get a \r
635 # higher quality PDF documentation.\r
636 \r
637 USE_PDFLATEX = NO\r
638 \r
639 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. \r
640 # command to the generated LaTeX files. This will instruct LaTeX to keep \r
641 # running if errors occur, instead of asking the user for help. \r
642 # This option is also used when generating formulas in HTML.\r
643 \r
644 LATEX_BATCHMODE = NO\r
645 \r
646 #---------------------------------------------------------------------------\r
647 # configuration options related to the RTF output\r
648 #---------------------------------------------------------------------------\r
649 \r
650 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output \r
651 # The RTF output is optimised for Word 97 and may not look very pretty with \r
652 # other RTF readers or editors.\r
653 \r
654 GENERATE_RTF = NO\r
655 \r
656 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. \r
657 # If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
658 # put in front of it. If left blank `rtf' will be used as the default path.\r
659 \r
660 RTF_OUTPUT = rtf\r
661 \r
662 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact \r
663 # RTF documents. This may be useful for small projects and may help to \r
664 # save some trees in general.\r
665 \r
666 COMPACT_RTF = NO\r
667 \r
668 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated \r
669 # will contain hyperlink fields. The RTF 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 WORD or other \r
672 # programs which support those fields. \r
673 # Note: wordpad (write) and others do not support links.\r
674 \r
675 RTF_HYPERLINKS = NO\r
676 \r
677 # Load stylesheet definitions from file. Syntax is similar to doxygen's \r
678 # config file, i.e. a series of assigments. You only have to provide \r
679 # replacements, missing definitions are set to their default value.\r
680 \r
681 RTF_STYLESHEET_FILE = \r
682 \r
683 # Set optional variables used in the generation of an rtf document. \r
684 # Syntax is similar to doxygen's config file.\r
685 \r
686 RTF_EXTENSIONS_FILE = \r
687 \r
688 #---------------------------------------------------------------------------\r
689 # configuration options related to the man page output\r
690 #---------------------------------------------------------------------------\r
691 \r
692 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will \r
693 # generate man pages\r
694 \r
695 GENERATE_MAN = NO\r
696 \r
697 # The MAN_OUTPUT tag is used to specify where the man pages will be put. \r
698 # If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
699 # put in front of it. If left blank `man' will be used as the default path.\r
700 \r
701 MAN_OUTPUT = man\r
702 \r
703 # The MAN_EXTENSION tag determines the extension that is added to \r
704 # the generated man pages (default is the subroutine's section .3)\r
705 \r
706 MAN_EXTENSION = .3\r
707 \r
708 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, \r
709 # then it will generate one additional man file for each entity \r
710 # documented in the real man page(s). These additional files \r
711 # only source the real man page, but without them the man command \r
712 # would be unable to find the correct page. The default is NO.\r
713 \r
714 MAN_LINKS = NO\r
715 \r
716 #---------------------------------------------------------------------------\r
717 # configuration options related to the XML output\r
718 #---------------------------------------------------------------------------\r
719 \r
720 # If the GENERATE_XML tag is set to YES Doxygen will \r
721 # generate an XML file that captures the structure of \r
722 # the code including all documentation. Note that this \r
723 # feature is still experimental and incomplete at the \r
724 # moment.\r
725 \r
726 GENERATE_XML = NO\r
727 \r
728 # The XML_SCHEMA tag can be used to specify an XML schema, \r
729 # which can be used by a validating XML parser to check the \r
730 # syntax of the XML files.\r
731 \r
732 XML_SCHEMA = \r
733 \r
734 # The XML_DTD tag can be used to specify an XML DTD, \r
735 # which can be used by a validating XML parser to check the \r
736 # syntax of the XML files.\r
737 \r
738 XML_DTD = \r
739 \r
740 #---------------------------------------------------------------------------\r
741 # configuration options for the AutoGen Definitions output\r
742 #---------------------------------------------------------------------------\r
743 \r
744 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will \r
745 # generate an AutoGen Definitions (see autogen.sf.net) file \r
746 # that captures the structure of the code including all \r
747 # documentation. Note that this feature is still experimental \r
748 # and incomplete at the moment.\r
749 \r
750 GENERATE_AUTOGEN_DEF = NO\r
751 \r
752 #---------------------------------------------------------------------------\r
753 # configuration options related to the Perl module output\r
754 #---------------------------------------------------------------------------\r
755 \r
756 # If the GENERATE_PERLMOD tag is set to YES Doxygen will \r
757 # generate a Perl module file that captures the structure of \r
758 # the code including all documentation. Note that this \r
759 # feature is still experimental and incomplete at the \r
760 # moment.\r
761 \r
762 GENERATE_PERLMOD = NO\r
763 \r
764 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate \r
765 # the necessary Makefile rules, Perl scripts and LaTeX code to be able \r
766 # to generate PDF and DVI output from the Perl module output.\r
767 \r
768 PERLMOD_LATEX = NO\r
769 \r
770 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be \r
771 # nicely formatted so it can be parsed by a human reader. This is useful \r
772 # if you want to understand what is going on. On the other hand, if this \r
773 # tag is set to NO the size of the Perl module output will be much smaller \r
774 # and Perl will parse it just the same.\r
775 \r
776 PERLMOD_PRETTY = YES\r
777 \r
778 # The names of the make variables in the generated doxyrules.make file \r
779 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. \r
780 # This is useful so different doxyrules.make files included by the same \r
781 # Makefile don't overwrite each other's variables.\r
782 \r
783 PERLMOD_MAKEVAR_PREFIX = \r
784 \r
785 #---------------------------------------------------------------------------\r
786 # Configuration options related to the preprocessor \r
787 #---------------------------------------------------------------------------\r
788 \r
789 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will \r
790 # evaluate all C-preprocessor directives found in the sources and include \r
791 # files.\r
792 \r
793 ENABLE_PREPROCESSING = YES\r
794 \r
795 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro \r
796 # names in the source code. If set to NO (the default) only conditional \r
797 # compilation will be performed. Macro expansion can be done in a controlled \r
798 # way by setting EXPAND_ONLY_PREDEF to YES.\r
799 \r
800 MACRO_EXPANSION = YES\r
801 \r
802 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES \r
803 # then the macro expansion is limited to the macros specified with the \r
804 # PREDEFINED and EXPAND_AS_PREDEFINED tags.\r
805 \r
806 EXPAND_ONLY_PREDEF = NO\r
807 \r
808 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files \r
809 # in the INCLUDE_PATH (see below) will be search if a #include is found.\r
810 \r
811 SEARCH_INCLUDES = YES\r
812 \r
813 # The INCLUDE_PATH tag can be used to specify one or more directories that \r
814 # contain include files that are not input files but should be processed by \r
815 # the preprocessor.\r
816 \r
817 INCLUDE_PATH = \r
818 \r
819 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard \r
820 # patterns (like *.h and *.hpp) to filter out the header-files in the \r
821 # directories. If left blank, the patterns specified with FILE_PATTERNS will \r
822 # be used.\r
823 \r
824 INCLUDE_FILE_PATTERNS = \r
825 \r
826 # The PREDEFINED tag can be used to specify one or more macro names that \r
827 # are defined before the preprocessor is started (similar to the -D option of \r
828 # gcc). The argument of the tag is a list of macros of the form: name \r
829 # or name=definition (no spaces). If the definition and the = are \r
830 # omitted =1 is assumed.\r
831 \r
832 PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS\r
833 \r
834 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then \r
835 # this tag can be used to specify a list of macro names that should be expanded. \r
836 # The macro definition that is found in the sources will be used. \r
837 # Use the PREDEFINED tag if you want to use a different macro definition.\r
838 \r
839 EXPAND_AS_DEFINED = \r
840 \r
841 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then \r
842 # doxygen's preprocessor will remove all function-like macros that are alone \r
843 # on a line, have an all uppercase name, and do not end with a semicolon. Such \r
844 # function macros are typically used for boiler-plate code, and will confuse the \r
845 # parser if not removed.\r
846 \r
847 SKIP_FUNCTION_MACROS = YES\r
848 \r
849 #---------------------------------------------------------------------------\r
850 # Configuration::addtions related to external references \r
851 #---------------------------------------------------------------------------\r
852 \r
853 # The TAGFILES tag can be used to specify one or more tagfiles.\r
854 \r
855 TAGFILES = \r
856 \r
857 # When a file name is specified after GENERATE_TAGFILE, doxygen will create \r
858 # a tag file that is based on the input files it reads.\r
859 \r
860 GENERATE_TAGFILE = \r
861 \r
862 # If the ALLEXTERNALS tag is set to YES all external classes will be listed \r
863 # in the class index. If set to NO only the inherited external classes \r
864 # will be listed.\r
865 \r
866 ALLEXTERNALS = NO\r
867 \r
868 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed \r
869 # in the modules index. If set to NO, only the current project's groups will \r
870 # be listed.\r
871 \r
872 EXTERNAL_GROUPS = YES\r
873 \r
874 # The PERL_PATH should be the absolute path and name of the perl script \r
875 # interpreter (i.e. the result of `which perl').\r
876 \r
877 PERL_PATH = /usr/bin/perl\r
878 \r
879 #---------------------------------------------------------------------------\r
880 # Configuration options related to the dot tool \r
881 #---------------------------------------------------------------------------\r
882 \r
883 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will \r
884 # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or \r
885 # super classes. Setting the tag to NO turns the diagrams off. Note that this \r
886 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is \r
887 # recommended to install and use dot, since it yield more powerful graphs.\r
888 \r
889 CLASS_DIAGRAMS = YES\r
890 \r
891 # If set to YES, the inheritance and collaboration graphs will hide \r
892 # inheritance and usage relations if the target is undocumented \r
893 # or is not a class.\r
894 \r
895 HIDE_UNDOC_RELATIONS = YES\r
896 \r
897 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is \r
898 # available from the path. This tool is part of Graphviz, a graph visualization \r
899 # toolkit from AT&T and Lucent Bell Labs. The other options in this section \r
900 # have no effect if this option is set to NO (the default)\r
901 \r
902 HAVE_DOT = YES\r
903 \r
904 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen \r
905 # will generate a graph for each documented class showing the direct and \r
906 # indirect inheritance relations. Setting this tag to YES will force the \r
907 # the CLASS_DIAGRAMS tag to NO.\r
908 \r
909 CLASS_GRAPH = YES\r
910 \r
911 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen \r
912 # will generate a graph for each documented class showing the direct and \r
913 # indirect implementation dependencies (inheritance, containment, and \r
914 # class references variables) of the class with other documented classes.\r
915 \r
916 COLLABORATION_GRAPH = YES\r
917 \r
918 # If set to YES, the inheritance and collaboration graphs will show the \r
919 # relations between templates and their instances.\r
920 \r
921 TEMPLATE_RELATIONS = YES\r
922 \r
923 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT \r
924 # tags are set to YES then doxygen will generate a graph for each documented \r
925 # file showing the direct and indirect include dependencies of the file with \r
926 # other documented files.\r
927 \r
928 INCLUDE_GRAPH = YES\r
929 \r
930 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and \r
931 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each \r
932 # documented header file showing the documented files that directly or \r
933 # indirectly include this file.\r
934 \r
935 INCLUDED_BY_GRAPH = YES\r
936 \r
937 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen \r
938 # will graphical hierarchy of all classes instead of a textual one.\r
939 \r
940 GRAPHICAL_HIERARCHY = YES\r
941 \r
942 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images \r
943 # generated by dot. Possible values are png, jpg, or gif\r
944 # If left blank png will be used.\r
945 \r
946 DOT_IMAGE_FORMAT = png\r
947 \r
948 # The tag DOT_PATH can be used to specify the path where the dot tool can be \r
949 # found. If left blank, it is assumed the dot tool can be found on the path.\r
950 \r
951 DOT_PATH = \r
952 \r
953 # The DOTFILE_DIRS tag can be used to specify one or more directories that \r
954 # contain dot files that are included in the documentation (see the \r
955 # \dotfile command).\r
956 \r
957 DOTFILE_DIRS = \r
958 \r
959 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width \r
960 # (in pixels) of the graphs generated by dot. If a graph becomes larger than \r
961 # this value, doxygen will try to truncate the graph, so that it fits within \r
962 # the specified constraint. Beware that most browsers cannot cope with very \r
963 # large images.\r
964 \r
965 MAX_DOT_GRAPH_WIDTH = 1024\r
966 \r
967 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height \r
968 # (in pixels) of the graphs generated by dot. If a graph becomes larger than \r
969 # this value, doxygen will try to truncate the graph, so that it fits within \r
970 # the specified constraint. Beware that most browsers cannot cope with very \r
971 # large images.\r
972 \r
973 MAX_DOT_GRAPH_HEIGHT = 1024\r
974 \r
975 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will \r
976 # generate a legend page explaining the meaning of the various boxes and \r
977 # arrows in the dot generated graphs.\r
978 \r
979 GENERATE_LEGEND = YES\r
980 \r
981 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will \r
982 # remove the intermedate dot files that are used to generate \r
983 # the various graphs.\r
984 \r
985 DOT_CLEANUP = YES\r
986 \r
987 #---------------------------------------------------------------------------\r
988 # Configuration::addtions related to the search engine \r
989 #---------------------------------------------------------------------------\r
990 \r
991 # The SEARCHENGINE tag specifies whether or not a search engine should be \r
992 # used. If set to NO the values of all tags below this one will be ignored.\r
993 \r
994 SEARCHENGINE = NO\r
995 \r
996 # The CGI_NAME tag should be the name of the CGI script that \r
997 # starts the search engine (doxysearch) with the correct parameters. \r
998 # A script with this name will be generated by doxygen.\r
999 \r
1000 CGI_NAME = search.cgi\r
1001 \r
1002 # The CGI_URL tag should be the absolute URL to the directory where the \r
1003 # cgi binaries are located. See the documentation of your http daemon for \r
1004 # details.\r
1005 \r
1006 CGI_URL = \r
1007 \r
1008 # The DOC_URL tag should be the absolute URL to the directory where the \r
1009 # documentation is located. If left blank the absolute path to the \r
1010 # documentation, with file:// prepended to it, will be used.\r
1011 \r
1012 DOC_URL = \r
1013 \r
1014 # The DOC_ABSPATH tag should be the absolute path to the directory where the \r
1015 # documentation is located. If left blank the directory on the local machine \r
1016 # will be used.\r
1017 \r
1018 DOC_ABSPATH = \r
1019 \r
1020 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary \r
1021 # is installed.\r
1022 \r
1023 BIN_ABSPATH = /usr/local/bin/\r
1024 \r
1025 # The EXT_DOC_PATHS tag can be used to specify one or more paths to \r
1026 # documentation generated for other projects. This allows doxysearch to search \r
1027 # the documentation for these projects as well.\r
1028 \r
1029 EXT_DOC_PATHS = \r