Revision ac7a4056 Doxyfile

View differences:

Doxyfile
1
# Doxyfile 1.3-rc1
1
# Doxyfile 1.5.6
2 2

  
3 3
# This file describes the settings to be used by the documentation system
4 4
# doxygen (www.doxygen.org) for a project
......
11 11
# Values that contain spaces should be placed between quotes (" ")
12 12

  
13 13
#---------------------------------------------------------------------------
14
# General configuration options
14
# Project related configuration options
15 15
#---------------------------------------------------------------------------
16 16

  
17
# This tag specifies the encoding used for all characters in the config file
18
# that follow. The default is UTF-8 which is also the encoding used for all
19
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20
# iconv built into libc) for the transcoding. See
21
# http://www.gnu.org/software/libiconv for the list of possible encodings.
22

  
23
DOXYFILE_ENCODING      = UTF-8
24

  
17 25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18 26
# by quotes) that should identify the project.
19 27

  
......
32 40

  
33 41
OUTPUT_DIRECTORY       = doxy
34 42

  
43
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44
# 4096 sub-directories (in 2 levels) under the output directory of each output
45
# format and will distribute the generated files over these directories.
46
# Enabling this option can be useful when feeding doxygen a huge amount of
47
# source files, where putting all generated files in the same directory would
48
# otherwise cause performance problems for the file system.
49

  
50
CREATE_SUBDIRS         = NO
51

  
35 52
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
36 53
# documentation generated by doxygen is written. Doxygen will use this
37 54
# information to generate all constant output in the proper language.
38 55
# The default language is English, other supported languages are:
39
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40
# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
41
# (Japanese with english messages), Korean, Norwegian, Polish, Portuguese,
42
# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish and Ukrainian.
56
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57
# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
58
# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
59
# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
60
# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
61
# and Ukrainian.
43 62

  
44 63
OUTPUT_LANGUAGE        = English
45 64

  
......
57 76

  
58 77
REPEAT_BRIEF           = YES
59 78

  
79
# This tag implements a quasi-intelligent brief description abbreviator
80
# that is used to form the text in various listings. Each string
81
# in this list, if found as the leading text of the brief description, will be
82
# stripped from the text and the result after processing the whole list, is
83
# used as the annotated text. Otherwise, the brief description is used as-is.
84
# If left blank, the following values are used ("$name" is automatically
85
# replaced with the name of the entity): "The $name class" "The $name widget"
86
# "The $name file" "is" "provides" "specifies" "contains"
87
# "represents" "a" "an" "the"
88

  
89
ABBREVIATE_BRIEF       =
90

  
60 91
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
61 92
# Doxygen will generate a detailed section even if there is only a brief
62 93
# description.
......
79 110
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
80 111
# can be used to strip a user-defined part of the path. Stripping is
81 112
# only done if one of the specified strings matches the left-hand part of
82
# the path. It is allowed to use relative paths in the argument list.
113
# the path. The tag can be used to show relative paths in the file list.
114
# If left blank the directory from which doxygen is run is used as the
115
# path to strip.
83 116

  
84 117
STRIP_FROM_PATH        = .
85 118

  
119
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
120
# the path mentioned in the documentation of a class, which tells
121
# the reader which header file to include in order to use a class.
122
# If left blank only the name of the header file containing the class
123
# definition is used. Otherwise one should specify the include paths that
124
# are normally passed to the compiler using the -I flag.
125

  
126
STRIP_FROM_INC_PATH    =
127

  
86 128
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
87 129
# (but less readable) file names. This can be useful is your file systems
88 130
# doesn't support long names like on DOS, Mac, or CD-ROM.
......
97 139

  
98 140
JAVADOC_AUTOBRIEF      = YES
99 141

  
142
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143
# interpret the first line (until the first dot) of a Qt-style
144
# comment as the brief description. If set to NO, the comments
145
# will behave just like regular Qt-style comments (thus requiring
146
# an explicit \brief command for a brief description.)
147

  
148
QT_AUTOBRIEF           = NO
149

  
100 150
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
101 151
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
102 152
# comments) as a brief description. This used to be the default behaviour.
......
118 168

  
119 169
INHERIT_DOCS           = YES
120 170

  
171
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
172
# a new page for each member. If set to NO, the documentation of a member will
173
# be part of the file/class/namespace that contains it.
174

  
175
SEPARATE_MEMBER_PAGES  = NO
176

  
121 177
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
122 178
# Doxygen uses this value to replace tabs by spaces in code fragments.
123 179

  
......
146 202

  
147 203
OPTIMIZE_OUTPUT_JAVA   = NO
148 204

  
205
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
206
# sources only. Doxygen will then generate output that is more tailored for
207
# Fortran.
208

  
209
OPTIMIZE_FOR_FORTRAN   = NO
210

  
211
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
212
# sources. Doxygen will then generate output that is tailored for
213
# VHDL.
214

  
215
OPTIMIZE_OUTPUT_VHDL   = NO
216

  
217
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
218
# to include (a tag file for) the STL sources as input, then you should
219
# set this tag to YES in order to let doxygen match functions declarations and
220
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
221
# func(std::string) {}). This also make the inheritance and collaboration
222
# diagrams that involve STL classes more complete and accurate.
223

  
224
BUILTIN_STL_SUPPORT    = NO
225

  
226
# If you use Microsoft's C++/CLI language, you should set this option to YES to
227
# enable parsing support.
228

  
229
CPP_CLI_SUPPORT        = NO
230

  
231
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
232
# Doxygen will parse them like normal C++ but will assume all classes use public
233
# instead of private inheritance when no explicit protection keyword is present.
234

  
235
SIP_SUPPORT            = NO
236

  
237
# For Microsoft's IDL there are propget and propput attributes to indicate getter
238
# and setter methods for a property. Setting this option to YES (the default)
239
# will make doxygen to replace the get and set methods by a property in the
240
# documentation. This will only work if the methods are indeed getting or
241
# setting a simple type. If this is not the case, or you want to show the
242
# methods anyway, you should set this option to NO.
243

  
244
IDL_PROPERTY_SUPPORT   = YES
245

  
246
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
247
# tag is set to YES, then doxygen will reuse the documentation of the first
248
# member in the group (if any) for the other members of the group. By default
249
# all members of a group must be documented explicitly.
250

  
251
DISTRIBUTE_GROUP_DOC   = NO
252

  
253
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
254
# the same type (for instance a group of public functions) to be put as a
255
# subgroup of that type (e.g. under the Public Functions section). Set it to
256
# NO to prevent subgrouping. Alternatively, this can be done per class using
257
# the \nosubgrouping command.
258

  
259
SUBGROUPING            = YES
260

  
261
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
262
# is documented as struct, union, or enum with the name of the typedef. So
263
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
264
# with name TypeT. When disabled the typedef will appear as a member of a file,
265
# namespace, or class. And the struct will be named TypeS. This can typically
266
# be useful for C code in case the coding convention dictates that all compound
267
# types are typedef'ed and only the typedef is referenced, never the tag name.
268

  
269
TYPEDEF_HIDES_STRUCT   = NO
270

  
271
#---------------------------------------------------------------------------
272
# Build related configuration options
273
#---------------------------------------------------------------------------
274

  
149 275
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
150 276
# documentation are documented, even if no documentation was available.
151 277
# Private class members and static file members will be hidden unless
......
169 295

  
170 296
EXTRACT_LOCAL_CLASSES  = YES
171 297

  
298
# This flag is only useful for Objective-C code. When set to YES local
299
# methods, which are defined in the implementation section but not in
300
# the interface are included in the documentation.
301
# If set to NO (the default) only methods in the interface are included.
302

  
303
EXTRACT_LOCAL_METHODS  = NO
304

  
305
# If this flag is set to YES, the members of anonymous namespaces will be
306
# extracted and appear in the documentation as a namespace called
307
# 'anonymous_namespace{file}', where file will be replaced with the base
308
# name of the file that contains the anonymous namespace. By default
309
# anonymous namespace are hidden.
310

  
311
EXTRACT_ANON_NSPACES   = NO
312

  
172 313
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
173 314
# undocumented members of documented classes, files or namespaces.
174 315
# If set to NO (the default) these members will be included in the
......
209 350
# file names in lower-case letters. If set to YES upper-case letters are also
210 351
# allowed. This is useful if you have classes or files whose names only differ
211 352
# in case and if your file system supports case sensitive file names. Windows
212
# users are adviced to set this option to NO.
353
# and Mac users are advised to set this option to NO.
213 354

  
214 355
CASE_SENSE_NAMES       = YES
215 356

  
......
237 378

  
238 379
SORT_MEMBER_DOCS       = YES
239 380

  
240
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
241
# tag is set to YES, then doxygen will reuse the documentation of the first
242
# member in the group (if any) for the other members of the group. By default
243
# all members of a group must be documented explicitly.
381
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
382
# brief documentation of file, namespace and class members alphabetically
383
# by member name. If set to NO (the default) the members will appear in
384
# declaration order.
244 385

  
245
DISTRIBUTE_GROUP_DOC   = NO
386
SORT_BRIEF_DOCS        = NO
387

  
388
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
389
# hierarchy of group names into alphabetical order. If set to NO (the default)
390
# the group names will appear in their defined order.
391

  
392
SORT_GROUP_NAMES       = NO
393

  
394
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
395
# sorted by fully-qualified names, including namespaces. If set to
396
# NO (the default), the class list will be sorted only by class name,
397
# not including the namespace part.
398
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
399
# Note: This option applies only to the class list, not to the
400
# alphabetical list.
401

  
402
SORT_BY_SCOPE_NAME     = NO
246 403

  
247 404
# The GENERATE_TODOLIST tag can be used to enable (YES) or
248 405
# disable (NO) the todo list. This list is created by putting \todo
......
289 446

  
290 447
SHOW_USED_FILES        = YES
291 448

  
449
# If the sources in your project are distributed over multiple directories
450
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
451
# in the documentation. The default is NO.
452

  
453
SHOW_DIRECTORIES       = NO
454

  
455
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
456
# This will remove the Files entry from the Quick Index and from the
457
# Folder Tree View (if specified). The default is YES.
458

  
459
SHOW_FILES             = YES
460

  
461
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
462
# Namespaces page.  This will remove the Namespaces entry from the Quick Index
463
# and from the Folder Tree View (if specified). The default is YES.
464

  
465
SHOW_NAMESPACES        = YES
466

  
467
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
468
# doxygen should invoke to get the current version for each file (typically from
469
# the version control system). Doxygen will invoke the program by executing (via
470
# popen()) the command <command> <input-file>, where <command> is the value of
471
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
472
# provided by doxygen. Whatever the program writes to standard output
473
# is used as the file version. See the manual for examples.
474

  
475
FILE_VERSION_FILTER    =
476

  
292 477
#---------------------------------------------------------------------------
293 478
# configuration options related to warning and progress messages
294 479
#---------------------------------------------------------------------------
......
310 495

  
311 496
WARN_IF_UNDOCUMENTED   = YES
312 497

  
498
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
499
# potential errors in the documentation, such as not documenting some
500
# parameters in a documented function, or documenting parameters that
501
# don't exist or using markup commands wrongly.
502

  
503
WARN_IF_DOC_ERROR      = YES
504

  
505
# This WARN_NO_PARAMDOC option can be abled to get warnings for
506
# functions that are documented, but have no documentation for their parameters
507
# or return value. If set to NO (the default) doxygen will only warn about
508
# wrong or incomplete parameter documentation, but not about the absence of
509
# documentation.
510

  
511
WARN_NO_PARAMDOC       = NO
512

  
313 513
# The WARN_FORMAT tag determines the format of the warning messages that
314 514
# doxygen can produce. The string should contain the $file, $line, and $text
315 515
# tags, which will be replaced by the file and line number from which the
316
# warning originated and the warning text.
516
# warning originated and the warning text. Optionally the format may contain
517
# $version, which will be replaced by the version of the file (if it could
518
# be obtained via FILE_VERSION_FILTER)
317 519

  
318 520
WARN_FORMAT            = "$file:$line: $text"
319 521

  
......
334 536

  
335 537
INPUT                  =
336 538

  
539
# This tag can be used to specify the character encoding of the source files
540
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
541
# also the default input encoding. Doxygen uses libiconv (or the iconv built
542
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
543
# the list of possible encodings.
544

  
545
INPUT_ENCODING         = UTF-8
546

  
337 547
# If the value of the INPUT tag contains directories, you can use the
338 548
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
339 549
# and *.h) to filter out the source-files in the directories. If left
340 550
# blank the following patterns are tested:
341
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
342
# *.h++ *.idl *.odl
551
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
552
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
343 553

  
344 554
FILE_PATTERNS          =
345 555

  
......
363 573

  
364 574
# If the value of the INPUT tag contains directories, you can use the
365 575
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
366
# certain files from those directories.
576
# certain files from those directories. Note that the wildcards are matched
577
# against the file with absolute path, so to exclude all test directories
578
# for example use the pattern */test/*
367 579

  
368 580
EXCLUDE_PATTERNS       = *.svn *.git
369 581

  
582
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
583
# (namespaces, classes, functions, etc.) that should be excluded from the
584
# output. The symbol name can be a fully qualified name, a word, or if the
585
# wildcard * is used, a substring. Examples: ANamespace, AClass,
586
# AClass::ANamespace, ANamespace::*Test
587

  
588
EXCLUDE_SYMBOLS        =
589

  
370 590
# The EXAMPLE_PATH tag can be used to specify one or more files or
371 591
# directories that contain example code fragments that are included (see
372 592
# the \include command).
......
398 618
# by executing (via popen()) the command <filter> <input-file>, where <filter>
399 619
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
400 620
# input file. Doxygen will then use the output that the filter program writes
401
# to standard output.
621
# to standard output.  If FILTER_PATTERNS is specified, this tag will be
622
# ignored.
402 623

  
403 624
INPUT_FILTER           =
404 625

  
626
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
627
# basis.  Doxygen will compare the file name with each pattern and apply the
628
# filter if there is a match.  The filters are a list of the form:
629
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
630
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
631
# is applied to all files.
632

  
633
FILTER_PATTERNS        =
634

  
405 635
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
406 636
# INPUT_FILTER) will be used to filter the input files when producing source
407 637
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
......
414 644

  
415 645
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
416 646
# be generated. Documented entities will be cross-referenced with these sources.
647
# Note: To get rid of all source code in the generated output, make sure also
648
# VERBATIM_HEADERS is set to NO.
417 649

  
418 650
SOURCE_BROWSER         = YES
419 651

  
......
428 660

  
429 661
STRIP_CODE_COMMENTS    = YES
430 662

  
431
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
663
# If the REFERENCED_BY_RELATION tag is set to YES
432 664
# then for each documented function all documented
433 665
# functions referencing it will be listed.
434 666

  
435 667
REFERENCED_BY_RELATION = YES
436 668

  
437
# If the REFERENCES_RELATION tag is set to YES (the default)
669
# If the REFERENCES_RELATION tag is set to YES
438 670
# then for each documented function all documented entities
439 671
# called/used by that function will be listed.
440 672

  
441 673
REFERENCES_RELATION    = NO
442 674

  
675
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
676
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
677
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
678
# link to the source code.  Otherwise they will link to the documentstion.
679

  
680
REFERENCES_LINK_SOURCE = YES
681

  
682
# If the USE_HTAGS tag is set to YES then the references to source code
683
# will point to the HTML generated by the htags(1) tool instead of doxygen
684
# built-in source browser. The htags tool is part of GNU's global source
685
# tagging system (see http://www.gnu.org/software/global/global.html). You
686
# will need version 4.8.6 or higher.
687

  
688
USE_HTAGS              = NO
689

  
443 690
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
444 691
# will generate a verbatim copy of the header file for each class for
445 692
# which an include is specified. Set to NO to disable this.
......
505 752
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
506 753
# style sheet that is used by each HTML page. It can be used to
507 754
# fine-tune the look of the HTML output. If the tag is left blank doxygen
508
# will generate a default style sheet
755
# will generate a default style sheet. Note that doxygen will try to copy
756
# the style sheet file to the HTML output directory, so don't put your own
757
# stylesheet in the HTML output directory as well, or it will be erased!
509 758

  
510 759
HTML_STYLESHEET        =
511 760

  
......
522 771

  
523 772
GENERATE_HTMLHELP      = NO
524 773

  
774
# If the GENERATE_DOCSET tag is set to YES, additional index files
775
# will be generated that can be used as input for Apple's Xcode 3
776
# integrated development environment, introduced with OSX 10.5 (Leopard).
777
# To create a documentation set, doxygen will generate a Makefile in the
778
# HTML output directory. Running make will produce the docset in that
779
# directory and running "make install" will install the docset in
780
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
781
# it at startup.
782

  
783
GENERATE_DOCSET        = NO
784

  
785
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
786
# feed. A documentation feed provides an umbrella under which multiple
787
# documentation sets from a single provider (such as a company or product suite)
788
# can be grouped.
789

  
790
DOCSET_FEEDNAME        = "Doxygen generated docs"
791

  
792
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
793
# should uniquely identify the documentation set bundle. This should be a
794
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
795
# will append .docset to the name.
796

  
797
DOCSET_BUNDLE_ID       = org.doxygen.Project
798

  
799
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
800
# documentation will contain sections that can be hidden and shown after the
801
# page has loaded. For this to work a browser that supports
802
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
803
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
804

  
805
HTML_DYNAMIC_SECTIONS  = NO
806

  
525 807
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
526 808
# be used to specify the file name of the resulting .chm file. You
527 809
# can add a path in front of the file if the result should not be
......
542 824

  
543 825
GENERATE_CHI           = NO
544 826

  
827
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
828
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
829
# content.
830

  
831
CHM_INDEX_ENCODING     =
832

  
545 833
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
546 834
# controls whether a binary table of contents is generated (YES) or a
547 835
# normal table of contents (NO) in the .chm file.
......
564 852

  
565 853
ENUM_VALUES_PER_LINE   = 4
566 854

  
567
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
568
# generated containing a tree-like index structure (just like the one that
855
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
856
# structure should be generated to display hierarchical information.
857
# If the tag value is set to FRAME, a side panel will be generated
858
# containing a tree-like index structure (just like the one that
569 859
# is generated for HTML Help). For this to work a browser that supports
570
# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
571
# or Internet explorer 4.0+). Note that for large projects the tree generation
572
# can take a very long time. In such cases it is better to disable this feature.
573
# Windows users are probably better off using the HTML help feature.
860
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
861
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
862
# probably better off using the HTML help feature. Other possible values
863
# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
864
# and Class Hiererachy pages using a tree view instead of an ordered list;
865
# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
866
# disables this behavior completely. For backwards compatibility with previous
867
# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
868
# respectively.
574 869

  
575 870
GENERATE_TREEVIEW      = NO
576 871

  
......
580 875

  
581 876
TREEVIEW_WIDTH         = 250
582 877

  
878
# Use this tag to change the font size of Latex formulas included
879
# as images in the HTML documentation. The default is 10. Note that
880
# when you change the font size after a successful doxygen run you need
881
# to manually remove any form_*.png images from the HTML output directory
882
# to force them to be regenerated.
883

  
884
FORMULA_FONTSIZE       = 10
885

  
583 886
#---------------------------------------------------------------------------
584 887
# configuration options related to the LaTeX output
585 888
#---------------------------------------------------------------------------
......
650 953

  
651 954
LATEX_BATCHMODE        = NO
652 955

  
956
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
957
# include the index chapters (such as File Index, Compound Index, etc.)
958
# in the output.
959

  
960
LATEX_HIDE_INDICES     = NO
961

  
653 962
#---------------------------------------------------------------------------
654 963
# configuration options related to the RTF output
655 964
#---------------------------------------------------------------------------
......
726 1035

  
727 1036
# If the GENERATE_XML tag is set to YES Doxygen will
728 1037
# generate an XML file that captures the structure of
729
# the code including all documentation. Note that this
730
# feature is still experimental and incomplete at the
731
# moment.
1038
# the code including all documentation.
732 1039

  
733 1040
GENERATE_XML           = NO
734 1041

  
1042
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1043
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1044
# put in front of it. If left blank `xml' will be used as the default path.
1045

  
1046
XML_OUTPUT             = xml
1047

  
735 1048
# The XML_SCHEMA tag can be used to specify an XML schema,
736 1049
# which can be used by a validating XML parser to check the
737 1050
# syntax of the XML files.
......
744 1057

  
745 1058
XML_DTD                =
746 1059

  
1060
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1061
# dump the program listings (including syntax highlighting
1062
# and cross-referencing information) to the XML output. Note that
1063
# enabling this will significantly increase the size of the XML output.
1064

  
1065
XML_PROGRAMLISTING     = YES
1066

  
747 1067
#---------------------------------------------------------------------------
748 1068
# configuration options for the AutoGen Definitions output
749 1069
#---------------------------------------------------------------------------
......
808 1128

  
809 1129
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
810 1130
# then the macro expansion is limited to the macros specified with the
811
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
1131
# PREDEFINED and EXPAND_AS_DEFINED tags.
812 1132

  
813 1133
EXPAND_ONLY_PREDEF     = YES
814 1134

  
......
834 1154
# are defined before the preprocessor is started (similar to the -D option of
835 1155
# gcc). The argument of the tag is a list of macros of the form: name
836 1156
# or name=definition (no spaces). If the definition and the = are
837
# omitted =1 is assumed.
1157
# omitted =1 is assumed. To prevent a macro definition from being
1158
# undefined via #undef or recursively expanded use the := operator
1159
# instead of the = operator.
838 1160

  
839 1161
PREDEFINED             = __attribute__(x)="" "RENAME(x)=x ## _TMPL" "DEF(x)=x ## _TMPL" \
840 1162
                         HAVE_AV_CONFIG_H HAVE_MMX HAVE_MMX2 HAVE_AMD3DNOW \
......
860 1182
#---------------------------------------------------------------------------
861 1183

  
862 1184
# The TAGFILES option can be used to specify one or more tagfiles.
1185
# Optionally an initial location of the external documentation
1186
# can be added for each tagfile. The format of a tag file without
1187
# this location is as follows:
1188
#   TAGFILES = file1 file2 ...
1189
# Adding location for the tag files is done as follows:
1190
#   TAGFILES = file1=loc1 "file2 = loc2" ...
1191
# where "loc1" and "loc2" can be relative or absolute paths or
1192
# URLs. If a location is present for each tag, the installdox tool
1193
# does not have to be run to correct the links.
1194
# Note that each tag file must have a unique name
1195
# (where the name does NOT include the path)
1196
# If a tag file is not located in the directory in which doxygen
1197
# is run, you must also specify the path to the tagfile here.
863 1198

  
864 1199
TAGFILES               =
865 1200

  
......
898 1233

  
899 1234
CLASS_DIAGRAMS         = YES
900 1235

  
1236
# You can define message sequence charts within doxygen comments using the \msc
1237
# command. Doxygen will then run the mscgen tool (see
1238
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1239
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1240
# the mscgen tool resides. If left empty the tool is assumed to be found in the
1241
# default search path.
1242

  
1243
MSCGEN_PATH            =
1244

  
901 1245
# If set to YES, the inheritance and collaboration graphs will hide
902 1246
# inheritance and usage relations if the target is undocumented
903 1247
# or is not a class.
......
911 1255

  
912 1256
HAVE_DOT               = NO
913 1257

  
1258
# By default doxygen will write a font called FreeSans.ttf to the output
1259
# directory and reference it in all dot files that doxygen generates. This
1260
# font does not include all possible unicode characters however, so when you need
1261
# these (or just want a differently looking font) you can specify the font name
1262
# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1263
# which can be done by putting it in a standard location or by setting the
1264
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1265
# containing the font.
1266

  
1267
DOT_FONTNAME           = FreeSans
1268

  
1269
# By default doxygen will tell dot to use the output directory to look for the
1270
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1271
# different font using DOT_FONTNAME you can set the path where dot
1272
# can find it using this tag.
1273

  
1274
DOT_FONTPATH           =
1275

  
914 1276
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
915 1277
# will generate a graph for each documented class showing the direct and
916 1278
# indirect inheritance relations. Setting this tag to YES will force the
......
925 1287

  
926 1288
COLLABORATION_GRAPH    = YES
927 1289

  
1290
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1291
# will generate a graph for groups, showing the direct groups dependencies
1292

  
1293
GROUP_GRAPHS           = YES
1294

  
1295
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1296
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1297
# Language.
1298

  
1299
UML_LOOK               = NO
1300

  
928 1301
# If set to YES, the inheritance and collaboration graphs will show the
929 1302
# relations between templates and their instances.
930 1303

  
......
944 1317

  
945 1318
INCLUDED_BY_GRAPH      = YES
946 1319

  
1320
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1321
# doxygen will generate a call dependency graph for every global function
1322
# or class method. Note that enabling this option will significantly increase
1323
# the time of a run. So in most cases it will be better to enable call graphs
1324
# for selected functions only using the \callgraph command.
1325

  
1326
CALL_GRAPH             = NO
1327

  
1328
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1329
# doxygen will generate a caller dependency graph for every global function
1330
# or class method. Note that enabling this option will significantly increase
1331
# the time of a run. So in most cases it will be better to enable caller
1332
# graphs for selected functions only using the \callergraph command.
1333

  
1334
CALLER_GRAPH           = NO
1335

  
947 1336
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
948 1337
# will graphical hierarchy of all classes instead of a textual one.
949 1338

  
950 1339
GRAPHICAL_HIERARCHY    = YES
951 1340

  
1341
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1342
# then doxygen will show the dependencies a directory has on other directories
1343
# in a graphical way. The dependency relations are determined by the #include
1344
# relations between the files in the directories.
1345

  
1346
DIRECTORY_GRAPH        = YES
1347

  
952 1348
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
953 1349
# generated by dot. Possible values are png, jpg, or gif
954 1350
# If left blank png will be used.
......
966 1362

  
967 1363
DOTFILE_DIRS           =
968 1364

  
969
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
970
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
971
# this value, doxygen will try to truncate the graph, so that it fits within
972
# the specified constraint. Beware that most browsers cannot cope with very
973
# large images.
1365
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1366
# nodes that will be shown in the graph. If the number of nodes in a graph
1367
# becomes larger than this value, doxygen will truncate the graph, which is
1368
# visualized by representing a node as a red box. Note that doxygen if the
1369
# number of direct children of the root node in a graph is already larger than
1370
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1371
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
974 1372

  
975
MAX_DOT_GRAPH_WIDTH    = 1024
1373
DOT_GRAPH_MAX_NODES    = 50
976 1374

  
977
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
978
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
979
# this value, doxygen will try to truncate the graph, so that it fits within
980
# the specified constraint. Beware that most browsers cannot cope with very
981
# large images.
1375
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1376
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1377
# from the root by following a path via at most 3 edges will be shown. Nodes
1378
# that lay further from the root node will be omitted. Note that setting this
1379
# option to 1 or 2 may greatly reduce the computation time needed for large
1380
# code bases. Also note that the size of a graph can be further restricted by
1381
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
982 1382

  
983
MAX_DOT_GRAPH_HEIGHT   = 1024
1383
MAX_DOT_GRAPH_DEPTH    = 0
1384

  
1385
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1386
# background. This is enabled by default, which results in a transparent
1387
# background. Warning: Depending on the platform used, enabling this option
1388
# may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1389
# become hard to read).
1390

  
1391
DOT_TRANSPARENT        = YES
1392

  
1393
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1394
# files in one run (i.e. multiple -o and -T options on the command line). This
1395
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1396
# support this, this feature is disabled by default.
1397

  
1398
DOT_MULTI_TARGETS      = NO
984 1399

  
985 1400
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
986 1401
# generate a legend page explaining the meaning of the various boxes and
......
1002 1417
# used. If set to NO the values of all tags below this one will be ignored.
1003 1418

  
1004 1419
SEARCHENGINE           = NO
1005

  
1006
# The CGI_NAME tag should be the name of the CGI script that
1007
# starts the search engine (doxysearch) with the correct parameters.
1008
# A script with this name will be generated by doxygen.
1009

  
1010
CGI_NAME               = search.cgi
1011

  
1012
# The CGI_URL tag should be the absolute URL to the directory where the
1013
# cgi binaries are located. See the documentation of your http daemon for
1014
# details.
1015

  
1016
CGI_URL                =
1017

  
1018
# The DOC_URL tag should be the absolute URL to the directory where the
1019
# documentation is located. If left blank the absolute path to the
1020
# documentation, with file:// prepended to it, will be used.
1021

  
1022
DOC_URL                =
1023

  
1024
# The DOC_ABSPATH tag should be the absolute path to the directory where the
1025
# documentation is located. If left blank the directory on the local machine
1026
# will be used.
1027

  
1028
DOC_ABSPATH            =
1029

  
1030
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
1031
# is installed.
1032

  
1033
BIN_ABSPATH            = /usr/local/bin/
1034

  
1035
# The EXT_DOC_PATHS tag can be used to specify one or more paths to
1036
# documentation generated for other projects. This allows doxysearch to search
1037
# the documentation for these projects as well.
1038

  
1039
EXT_DOC_PATHS          =

Also available in: Unified diff