binreloc wasnt working with cmake.
[blender-staging.git] / intern / ghost / doc / ghost_interface.cfg
1 #---------------------------------------------------------------------------
2 # General configuration options
3 #---------------------------------------------------------------------------
4
5 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
6 # by quotes) that should identify the project. 
7 PROJECT_NAME = "GHOST (Generic Handy Operating System Toolkit)"
8
9 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
10 # This could be handy for archiving the generated documentation or 
11 # if some version control system is used.
12 PROJECT_NUMBER = 1.0
13
14 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
15 # base path where the generated documentation will be put. 
16 # If a relative path is entered, it will be relative to the location 
17 # where doxygen was started. If left blank the current directory will be used.
18 OUTPUT_DIRECTORY = ./interface
19
20 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
21 # documentation generated by doxygen is written. Doxygen will use this 
22 # information to generate all constant output in the proper language. 
23 # The default language is English, other supported languages are: 
24 # Dutch, French, Italian, Czech, Swedish, German, Finnish, Japanese, 
25 # Korean, Hungarian, Norwegian, Spanish, Romanian, Russian, Croatian, 
26 # Polish, Portuguese and Slovene.
27 OUTPUT_LANGUAGE = English
28
29 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
30 # documentation are documented, even if no documentation was available. 
31 # Private class members and static file members will be hidden unless 
32 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 
33 EXTRACT_ALL = YES
34
35 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
36 # will be included in the documentation. 
37 EXTRACT_PRIVATE = NO
38
39 # If the EXTRACT_STATIC tag is set to YES all static members of a file 
40 # will be included in the documentation. 
41 EXTRACT_STATIC = YES
42
43 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
44 # undocumented members of documented classes, files or namespaces. 
45 # If set to NO (the default) these members will be included in the 
46 # various overviews, but no documentation section is generated. 
47 # This option has no effect if EXTRACT_ALL is enabled. 
48 HIDE_UNDOC_MEMBERS = NO
49
50 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
51 # undocumented classes that are normally visible in the class hierarchy. 
52 # If set to NO (the default) these class will be included in the various 
53 # overviews. This option has no effect if EXTRACT_ALL is enabled. 
54 HIDE_UNDOC_CLASSES = NO
55
56 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
57 # include brief member descriptions after the members that are listed in 
58 # the file and class documentation (similar to JavaDoc). 
59 # Set to NO to disable this. 
60 BRIEF_MEMBER_DESC = YES
61
62 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
63 # the brief description of a member or function before the detailed description. 
64 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
65 # brief descriptions will be completely suppressed. 
66 REPEAT_BRIEF = YES
67
68 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
69 # Doxygen will generate a detailed section even if there is only a brief 
70 # description. 
71 ALWAYS_DETAILED_SEC = YES
72
73 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
74 # path before files name in the file list and in the header files. If set 
75 # to NO the shortest path that makes the file name unique will be used. 
76 FULL_PATH_NAMES = NO
77
78 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
79 # can be used to strip a user defined part of the path. Stripping is 
80 # only done if one of the specified strings matches the left-hand part of 
81 # the path. It is allowed to use relative paths in the argument list.
82 STRIP_FROM_PATH = 
83
84 # The INTERNAL_DOCS tag determines if documentation 
85 # that is typed after a \internal command is included. If the tag is set 
86 # to NO (the default) then the documentation will be excluded. 
87 # Set it to YES to include the internal documentation. 
88 INTERNAL_DOCS = NO
89
90 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
91 # generate a class diagram (in Html and LaTeX) for classes with base or 
92 # super classes. Setting the tag to NO turns the diagrams off. 
93 CLASS_DIAGRAMS = YES
94
95 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
96 # be generated. Documented entities will be cross-referenced with these sources. 
97 SOURCE_BROWSER = YES
98
99 # Setting the INLINE_SOURCES tag to YES will include the body 
100 # of functions and classes directly in the documentation. 
101 INLINE_SOURCES = NO
102
103 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
104 # doxygen to hide any special comment blocks from generated source code 
105 # fragments. Normal C and C++ comments will always remain visible. 
106 STRIP_CODE_COMMENTS = YES
107
108 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
109 # file names in lower case letters. If set to YES upper case letters are also 
110 # allowed. This is useful if you have classes or files whose names only differ 
111 # in case and if your file system supports case sensitive file names. Windows 
112 # users are adviced to set this option to NO.
113 CASE_SENSE_NAMES = YES
114
115 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
116 # will show members with their full class and namespace scopes in the 
117 # documentation. If set to YES the scope will be hidden. 
118 HIDE_SCOPE_NAMES = NO
119
120 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
121 # will generate a verbatim copy of the header file for each class for 
122 # which an include is specified. Set to NO to disable this. 
123 VERBATIM_HEADERS = YES
124
125 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
126 # will put list of the files that are included by a file in the documentation 
127 # of that file. 
128 SHOW_INCLUDE_FILES = YES
129
130 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
131 # will interpret the first line (until the first dot) of a JavaDoc-style 
132 # comment as the brief description. If set to NO, the JavaDoc 
133 # comments  will behave just like the Qt-style comments (thus requiring an 
134 # explict @brief command for a brief description. 
135 JAVADOC_AUTOBRIEF = YES
136
137 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
138 # member inherits the documentation from any documented member that it 
139 # reimplements. 
140 INHERIT_DOCS = YES
141
142 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
143 # is inserted in the documentation for inline members. 
144 INLINE_INFO = YES
145
146 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
147 # will sort the (detailed) documentation of file and class members 
148 # alphabetically by member name. If set to NO the members will appear in 
149 # declaration order. 
150 SORT_MEMBER_DOCS = YES
151
152 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
153 # tag is set to YES, then doxygen will reuse the documentation of the first 
154 # member in the group (if any) for the other members of the group. By default 
155 # all members of a group must be documented explicitly.
156 DISTRIBUTE_GROUP_DOC = NO
157
158 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
159 # Doxygen uses this value to replace tabs by spaces in code fragments. 
160 TAB_SIZE = 4
161
162 # The ENABLE_SECTIONS tag can be used to enable conditional 
163 # documentation sections, marked by \if sectionname ... \endif. 
164 ENABLED_SECTION = 
165
166 # The GENERATE_TODOLIST tag can be used to enable (YES) or 
167 # disable (NO) the todo list. This list is created by putting \todo 
168 # commands in the documentation
169 GENERATE_TODOLIST = YES
170
171 # The GENERATE_TESTLIST tag can be used to enable (YES) or 
172 # disable (NO) the test list. This list is created by putting \test 
173 # commands in the documentation.
174 GENERATE_TESTLIST = YES
175
176 # This tag can be used to specify a number of aliases that acts 
177 # as commands in the documentation. An alias has the form "name=value". 
178 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 
179 # put the command \sideeffect (or @sideeffect) in the documentation, which 
180 # will result in a user defined paragraph with heading "Side Effects:". 
181 # You can put \n's in the value part of an alias to insert newlines. 
182 ALIASES = 
183
184 #---------------------------------------------------------------------------
185 # configuration options related to warning and progress messages
186 #---------------------------------------------------------------------------
187
188 # The QUIET tag can be used to turn on/off the messages that are generated 
189 # by doxygen. Possible values are YES and NO. If left blank NO is used. 
190 QUIET = NO
191
192 # The WARNINGS tag can be used to turn on/off the warning messages that are 
193 # generated by doxygen. Possible values are YES and NO. If left blank 
194 # NO is used. 
195 WARNINGS = YES
196
197 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
198 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
199 # automatically be disabled. 
200 WARN_IF_UNDOCUMENTED = YES
201
202 # The WARN_FORMAT tag determines the format of the warning messages that 
203 # doxygen can produce. The string should contain the $file, $line, and $text 
204 # tags, which will be replaced by the file and line number from which the 
205 # warning originated and the warning text. 
206 WARN_FORMAT = "$file:$line: $text"
207
208 # The WARN_LOGFILE tag can be used to specify a file to which warning 
209 # and error messages should be written. If left blank the output is written 
210 # to stderr. 
211 WARN_LOGFILE = 
212
213 #---------------------------------------------------------------------------
214 # configuration options related to the input files
215 #---------------------------------------------------------------------------
216
217 # The INPUT tag can be used to specify the files and/or directories that contain 
218 # documented source files. You may enter file names like "myfile.cpp" or 
219 # directories like "/usr/src/myproject". Separate the files or directories 
220 # with spaces. 
221 INPUT = ..
222
223 # If the value of the INPUT tag contains directories, you can use the 
224 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
225 # and *.h) to filter out the source-files in the directories. If left 
226 # blank all files are included. 
227 FILE_PATTERNS = *.h *.cpp *.c
228
229 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
230 # should be searched for input files as well. Possible values are YES and NO. 
231 # If left blank NO is used. 
232 RECURSIVE = NO
233
234 # The EXCLUDE tag can be used to specify files and/or directories that should 
235 # excluded from the INPUT source files. This way you can easily exclude a 
236 # subdirectory from a directory tree whose root is specified with the INPUT tag. 
237 EXCLUDE = 
238
239 # If the value of the INPUT tag contains directories, you can use the 
240 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
241 # certain files from those directories. 
242 EXCLUDE_PATTERNS = 
243
244 # The EXAMPLE_PATH tag can be used to specify one or more files or 
245 # directories that contain example code fragments that are included (see 
246 # the \include command). 
247 EXAMPLE_PATH = ../test
248
249 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
250 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
251 # and *.h) to filter out the source-files in the directories. If left 
252 # blank all files are included. 
253 EXAMPLE_PATTERNS = *.h *.cpp *.c
254
255 # The IMAGE_PATH tag can be used to specify one or more files or 
256 # directories that contain image that are included in the documentation (see 
257 # the \image command). 
258 IMAGE_PATH = 
259
260 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
261 # invoke to filter for each input file. Doxygen will invoke the filter program 
262 # by executing (via popen()) the command <filter> <input-file>, where <filter> 
263 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
264 # input file. Doxygen will then use the output that the filter program writes 
265 # to standard output. 
266 INPUT_FILTER  = 
267
268 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
269 # INPUT_FILTER) will be used to filter the input files when producing source 
270 # files to browse. 
271 FILTER_SOURCE_FILES = NO
272
273 #---------------------------------------------------------------------------
274 # configuration options related to the alphabetical class index
275 #---------------------------------------------------------------------------
276
277 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
278 # of all compounds will be generated. Enable this if the project 
279 # contains a lot of classes, structs, unions or interfaces. 
280 ALPHABETICAL_INDEX = YES
281
282 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
283 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
284 # in which this list will be split (can be a number in the range [1..20]) 
285 COLS_IN_ALPHA_INDEX = 5
286
287 # In case all classes in a project start with a common prefix, all 
288 # classes will be put under the same header in the alphabetical index. 
289 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
290 # should be ignored while generating the index headers. 
291 IGNORE_PREFIX =
292
293 #---------------------------------------------------------------------------
294 # configuration options related to the HTML output
295 #---------------------------------------------------------------------------
296
297 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
298 # generate HTML output. 
299 GENERATE_HTML = YES
300
301 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
302 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
303 # put in front of it. If left blank `html' will be used as the default path. 
304 HTML_OUTPUT = html
305
306 # The HTML_HEADER tag can be used to specify a personal HTML header for 
307 # each generated HTML page. If it is left blank doxygen will generate a 
308 # standard header.
309 HTML_HEADER = 
310
311 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
312 # each generated HTML page. If it is left blank doxygen will generate a 
313 # standard footer.
314 HTML_FOOTER = 
315
316 # The HTML_STYLESHEET tag can be used to specify a user defined cascading 
317 # style sheet that is used by each HTML page. It can be used to 
318 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
319 # will generate a default style sheet 
320 HTML_STYLESHEET = 
321
322 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
323 # files or namespaces will be aligned in HTML using tables. If set to 
324 # NO a bullet list will be used. 
325 HTML_ALIGN_MEMBERS = YES
326
327 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
328 # will be generated that can be used as input for tools like the 
329 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
330 # of the generated HTML documentation. 
331 GENERATE_HTMLHELP = YES
332
333 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
334 # top of each HTML page. The value NO (the default) enables the index and 
335 # the value YES disables it. 
336 DISABLE_INDEX = NO
337
338 # This tag can be used to set the number of enum values (range [1..20]) 
339 # that doxygen will group on one line in the generated HTML documentation. 
340 ENUM_VALUES_PER_LINE = 4
341
342 # If the GENERATE_TREEVIEW tag is set to YES, a side pannel will be
343 # generated containing a tree-like index structure (just like the one that 
344 # is generated for HTML Help). For this to work a browser that supports 
345 # JavaScript and frames is required (for instance Netscape 4.0+ 
346 # or Internet explorer 4.0+). 
347 GENERATE_TREEVIEW = YES
348
349 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
350 # used to set the initial width (in pixels) of the frame in which the tree 
351 # is shown. 
352 TREEVIEW_WIDTH = 250
353
354 #---------------------------------------------------------------------------
355 # configuration options related to the LaTeX output
356 #---------------------------------------------------------------------------
357
358 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
359 # generate Latex output. 
360 GENERATE_LATEX = NO
361
362 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
363 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
364 # put in front of it. If left blank `latex' will be used as the default path. 
365 LATEX_OUTPUT = latex
366
367 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
368 # LaTeX documents. This may be useful for small projects and may help to 
369 # save some trees in general. 
370 COMPACT_LATEX = NO
371
372 # The PAPER_TYPE tag can be used to set the paper type that is used 
373 # by the printer. Possible values are: a4, a4wide, letter, legal and 
374 # executive. If left blank a4wide will be used. 
375 PAPER_TYPE = a4wide
376
377 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
378 # packages that should be included in the LaTeX output. 
379 EXTRA_PACKAGES = 
380
381 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
382 # the generated latex document. The header should contain everything until 
383 # the first chapter. If it is left blank doxygen will generate a 
384 # standard header. Notice: only use this tag if you know what you are doing! 
385 LATEX_HEADER = 
386
387 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
388 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
389 # contain links (just like the HTML output) instead of page references 
390 # This makes the output suitable for online browsing using a pdf viewer. 
391 PDF_HYPERLINKS = NO
392
393 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
394 # plain latex in the generated Makefile. Set this option to YES to get a 
395 # higher quality PDF documentation. 
396 USE_PDFLATEX = NO
397
398 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
399 # command to the generated LaTeX files. This will instruct LaTeX to keep 
400 # running if errors occur, instead of asking the user for help. 
401 # This option is also used when generating formulas in HTML. 
402 LATEX_BATCHMODE = NO
403
404 #---------------------------------------------------------------------------
405 # configuration options related to the RTF output
406 #---------------------------------------------------------------------------
407
408 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
409 # The RTF output is optimised for Word 97 and may not look very pretty with 
410 # other RTF readers or editors.
411 GENERATE_RTF = NO
412
413 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
414 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
415 # put in front of it. If left blank `rtf' will be used as the default path. 
416 RTF_OUTPUT = rtf
417
418 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
419 # RTF documents. This may be useful for small projects and may help to 
420 # save some trees in general. 
421 COMPACT_RTF = NO
422
423 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
424 # will contain hyperlink fields. The RTF file will 
425 # contain links (just like the HTML output) instead of page references. 
426 # This makes the output suitable for online browsing using a WORD or other. 
427 # programs which support those fields. 
428 # Note: wordpad (write) and others do not support links. 
429 RTF_HYPERLINKS = NO
430
431 # Load stylesheet definitions from file. Syntax is similar to doxygen's 
432 # config file, i.e. a series of assigments. You only have to provide 
433 # replacements, missing definitions are set to their default value. 
434 RTF_STYLESHEET_FILE = 
435
436 #---------------------------------------------------------------------------
437 # configuration options related to the man page output
438 #---------------------------------------------------------------------------
439
440 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
441 # generate man pages 
442 GENERATE_MAN = NO
443
444 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
445 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
446 # put in front of it. If left blank `man' will be used as the default path. 
447 MAN_OUTPUT = man
448
449 # The MAN_EXTENSION tag determines the extension that is added to 
450 # the generated man pages (default is the subroutine's section .3) 
451 MAN_EXTENSION = .3
452
453 #---------------------------------------------------------------------------
454 # configuration options related to the XML output
455 #---------------------------------------------------------------------------
456
457 # If the GENERATE_XML tag is set to YES Doxygen will 
458 # generate an XML file that captures the structure of 
459 # the code including all documentation. Warning: This feature 
460 # is still experimental and very incomplete.
461 GENERATE_XML = NO
462
463 #---------------------------------------------------------------------------
464 # Configuration options related to the preprocessor   
465 #---------------------------------------------------------------------------
466
467 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
468 # evaluate all C-preprocessor directives found in the sources and include 
469 # files. 
470 ENABLE_PREPROCESSING = YES
471
472 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
473 # names in the source code. If set to NO (the default) only conditional 
474 # compilation will be performed. Macro expansion can be done in a controlled 
475 # way by setting EXPAND_ONLY_PREDEF to YES. 
476 MACRO_EXPANSION = NO
477
478 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
479 # then the macro expansion is limited to the macros specified with the 
480 # PREDEFINED and EXPAND_AS_PREDEFINED tags. 
481 EXPAND_ONLY_PREDEF = NO
482
483 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
484 # in the INCLUDE_PATH (see below) will be search if a #include is found. 
485 SEARCH_INCLUDES = YES
486
487 # The INCLUDE_PATH tag can be used to specify one or more directories that 
488 # contain include files that are not input files but should be processed by 
489 # the preprocessor. 
490 INCLUDE_PATH = 
491
492 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
493 # patterns (like *.h and *.hpp) to filter out the header-files in the 
494 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
495 # be used. 
496 INCLUDE_FILE_PATTERNS = 
497
498 # The PREDEFINED tag can be used to specify one or more macro names that 
499 # are defined before the preprocessor is started (similar to the -D option of 
500 # gcc). The argument of the tag is a list of macros of the form: name 
501 # or name=definition (no spaces). If the definition and the = are 
502 # omitted =1 is assumed. 
503 PREDEFINED = 
504
505 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then 
506 # this tag can be used to specify a list of macro names that should be expanded. 
507 # The macro definition that is found in the sources will be used. 
508 # Use the PREDEFINED tag if you want to use a different macro definition. 
509 EXPAND_AS_DEFINED = 
510
511 #---------------------------------------------------------------------------
512 # Configuration::additions related to external references   
513 #---------------------------------------------------------------------------
514
515 # The TAGFILES tag can be used to specify one or more tagfiles. 
516 TAGFILES = 
517
518 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
519 # a tag file that is based on the input files it reads. 
520 GENERATE_TAGFILE = 
521
522 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
523 # in the class index. If set to NO only the inherited external classes 
524 # will be listed. 
525 ALLEXTERNALS = 
526
527 # The PERL_PATH should be the absolute path and name of the perl script 
528 # interpreter (i.e. the result of `which perl'). 
529 PERL_PATH = /usr/bin/perl
530
531 #---------------------------------------------------------------------------
532 # Configuration options related to the dot tool   
533 #---------------------------------------------------------------------------
534
535 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
536 # available from the path. This tool is part of Graphviz, a graph visualization 
537 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
538 # have no effect if this option is set to NO (the default) 
539 HAVE_DOT = YES
540
541 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
542 # will generate a graph for each documented class showing the direct and 
543 # indirect inheritance relations. Setting this tag to YES will force the 
544 # the CLASS_DIAGRAMS tag to NO.
545 CLASS_GRAPH = YES
546
547 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
548 # will generate a graph for each documented class showing the direct and 
549 # indirect implementation dependencies (inheritance, containment, and 
550 # class references variables) of the class with other documented classes. 
551 COLLABORATION_GRAPH = YES
552
553 # If the ENABLE_PREPROCESSING, INCLUDE_GRAPH, and HAVE_DOT tags are set to 
554 # YES then doxygen will generate a graph for each documented file showing 
555 # the direct and indirect include dependencies of the file with other 
556 # documented files. 
557 INCLUDE_GRAPH = YES
558
559 # If the ENABLE_PREPROCESSING, INCLUDED_BY_GRAPH, and HAVE_DOT tags are set to 
560 # YES then doxygen will generate a graph for each documented header file showing 
561 # the documented files that directly or indirectly include this file 
562 INCLUDED_BY_GRAPH = YES
563
564 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
565 # will graphical hierarchy of all classes instead of a textual one. 
566 GRAPHICAL_HIERARCHY = YES
567
568 # The tag DOT_PATH can be used to specify the path where the dot tool can be 
569 # found. If left blank, it is assumed the dot tool can be found on the path. 
570 DOT_PATH = 
571
572 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
573 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 
574 # this value, doxygen will try to truncate the graph, so that it fits within 
575 # the specified constraint. Beware that most browsers cannot cope with very 
576 # large images. 
577 MAX_DOT_GRAPH_WIDTH = 1024
578
579 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
580 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 
581 # this value, doxygen will try to truncate the graph, so that it fits within 
582 # the specified constraint. Beware that most browsers cannot cope with very 
583 # large images. 
584 MAX_DOT_GRAPH_HEIGHT = 1024
585
586 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
587 # generate a legend page explaining the meaning of the various boxes and 
588 # arrows in the dot generated graphs. 
589 GENERATE_LEGEND = YES
590
591 #---------------------------------------------------------------------------
592 # Configuration::addtions related to the search engine   
593 #---------------------------------------------------------------------------
594
595 # The SEARCHENGINE tag specifies whether or not a search engine should be 
596 # used. If set to NO the values of all tags below this one will be ignored. 
597 SEARCHENGINE = NO
598
599 # The CGI_NAME tag should be the name of the CGI script that 
600 # starts the search engine (doxysearch) with the correct parameters. 
601 # A script with this name will be generated by doxygen. 
602 CGI_NAME= search.cgi
603
604 # The CGI_URL tag should be the absolute URL to the directory where the 
605 # cgi binaries are located. See the documentation of your http daemon for 
606 # details. 
607 CGI_URL= 
608
609 # The DOC_URL tag should be the absolute URL to the directory where the 
610 # documentation is located. If left blank the absolute path to the 
611 # documentation, with file:// prepended to it, will be used. 
612 DOC_URL= 
613
614 # The DOC_ABSPATH tag should be the absolute path to the directory where the 
615 # documentation is located. If left blank the directory on the local machine 
616 # will be used. 
617 DOC_ABSPATH= 
618
619 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary 
620 # is installed. 
621 BIN_ABSPATH= /bin
622
623 # The EXT_DOC_PATHS tag can be used to specify one or more paths to 
624 # documentation generated for other projects. This allows doxysearch to search 
625 # the documentation for these projects as well. 
626 EXT_DOC_PATHS=