root/trunk/libffado/doc/reference.doxygen.in

Revision 445, 43.3 kB (checked in by pieterpalmers, 16 years ago)

* name change from FreeBoB to FFADO
* replaced tabs by 4 spaces
* got rid of end-of-line spaces
* made all license and copyrights conform

library becomes LGPL, apps become GPL
explicitly state LGPL v2.1 and GPL v2 (don't like v3 draft)

copyrights are 2005-2007 Daniel & Pieter
except for the MotU stuff (C) Jonathan, Pieter

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