/[escript]/trunk/pyvisi/Doxyfile
ViewVC logotype

Contents of /trunk/pyvisi/Doxyfile

Parent Directory Parent Directory | Revision Log Revision Log


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

  ViewVC Help
Powered by ViewVC 1.1.26