Project

General

Profile

Revision 1385

Added by Kevin Woo over 14 years ago

Updated and removed deprecated doxygen stuff from the doxygen config file.

View differences:

Doxyfile
1
# Doxyfile 1.4.7
1
# Doxyfile 1.5.9
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
......
14 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

  
......
45 53
# documentation generated by doxygen is written. Doxygen will use this 
46 54
# information to generate all constant output in the proper language. 
47 55
# The default language is English, other supported languages are: 
48
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, 
49
# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, 
50
# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, 
51
# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 
52
# Swedish, and Ukrainian.
56
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
57
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 
58
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 
59
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 
60
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, 
61
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
53 62

  
54 63
OUTPUT_LANGUAGE        = English
55 64

  
56
# This tag can be used to specify the encoding used in the generated output. 
57
# The encoding is not always determined by the language that is chosen, 
58
# but also whether or not the output is meant for Windows or non-Windows users. 
59
# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 
60
# forces the Windows encoding (this is the default for the Windows binary), 
61
# whereas setting the tag to NO uses a Unix-style encoding (the default for 
62
# all platforms other than Windows).
63

  
64
USE_WINDOWS_ENCODING   = NO
65

  
66 65
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
67 66
# include brief member descriptions after the members that are listed in 
68 67
# the file and class documentation (similar to JavaDoc). 
......
135 134
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
136 135
# will interpret the first line (until the first dot) of a JavaDoc-style 
137 136
# comment as the brief description. If set to NO, the JavaDoc 
138
# comments will behave just like the Qt-style comments (thus requiring an 
139
# explicit @brief command for a brief description.
137
# comments will behave just like regular Qt-style comments 
138
# (thus requiring an explicit @brief command for a brief description.)
140 139

  
141 140
JAVADOC_AUTOBRIEF      = NO
142 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

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

  
149 156
MULTILINE_CPP_IS_BRIEF = NO
150 157

  
151
# If the DETAILS_AT_TOP tag is set to YES then Doxygen 
152
# will output the detailed description near the top, like JavaDoc.
153
# If set to NO, the detailed description appears after the member 
154
# documentation.
155

  
156
DETAILS_AT_TOP         = NO
157

  
158 158
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
159 159
# member inherits the documentation from any documented member that it 
160 160
# re-implements.
......
189 189
OPTIMIZE_OUTPUT_FOR_C  = YES
190 190

  
191 191
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
192
# sources only. Doxygen will then generate output that is more tailored for Java. 
193
# For instance, namespaces will be presented as packages, qualified scopes 
194
# will look different, etc.
192
# sources only. Doxygen will then generate output that is more tailored for 
193
# Java. For instance, namespaces will be presented as packages, qualified 
194
# scopes will look different, etc.
195 195

  
196 196
OPTIMIZE_OUTPUT_JAVA   = NO
197 197

  
198
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 
199
# include (a tag file for) the STL sources as input, then you should 
198
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 
199
# sources only. Doxygen will then generate output that is more tailored for 
200
# Fortran.
201

  
202
OPTIMIZE_FOR_FORTRAN   = NO
203

  
204
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 
205
# sources. Doxygen will then generate output that is tailored for 
206
# VHDL.
207

  
208
OPTIMIZE_OUTPUT_VHDL   = NO
209

  
210
# Doxygen selects the parser to use depending on the extension of the files it parses. 
211
# With this tag you can assign which parser to use for a given extension. 
212
# Doxygen has a built-in mapping, but you can override or extend it using this tag. 
213
# The format is ext=language, where ext is a file extension, and language is one of 
214
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, 
215
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat 
216
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), 
217
# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
218

  
219
EXTENSION_MAPPING      = 
220

  
221
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 
222
# to include (a tag file for) the STL sources as input, then you should 
200 223
# set this tag to YES in order to let doxygen match functions declarations and 
201 224
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
202 225
# func(std::string) {}). This also make the inheritance and collaboration 
......
204 227

  
205 228
BUILTIN_STL_SUPPORT    = NO
206 229

  
230
# If you use Microsoft's C++/CLI language, you should set this option to YES to 
231
# enable parsing support.
232

  
233
CPP_CLI_SUPPORT        = NO
234

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

  
239
SIP_SUPPORT            = NO
240

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

  
248
IDL_PROPERTY_SUPPORT   = YES
249

  
207 250
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
208 251
# tag is set to YES, then doxygen will reuse the documentation of the first 
209 252
# member in the group (if any) for the other members of the group. By default 
......
219 262

  
220 263
SUBGROUPING            = YES
221 264

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

  
273
TYPEDEF_HIDES_STRUCT   = NO
274

  
275
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 
276
# determine which symbols to keep in memory and which to flush to disk. 
277
# When the cache is full, less often used symbols will be written to disk. 
278
# For small to medium size projects (<1000 input files) the default value is 
279
# probably good enough. For larger projects a too small cache size can cause 
280
# doxygen to be busy swapping symbols to and from disk most of the time 
281
# causing a significant performance penality. 
282
# If the system has enough physical memory increasing the cache will improve the 
283
# performance by keeping more symbols in memory. Note that the value works on 
284
# a logarithmic scale so increasing the size by one will rougly double the 
285
# memory usage. The cache size is given by this formula: 
286
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 
287
# corresponding to a cache size of 2^16 = 65536 symbols
288

  
289
SYMBOL_CACHE_SIZE      = 0
290

  
222 291
#---------------------------------------------------------------------------
223 292
# Build related configuration options
224 293
#---------------------------------------------------------------------------
......
253 322

  
254 323
EXTRACT_LOCAL_METHODS  = NO
255 324

  
325
# If this flag is set to YES, the members of anonymous namespaces will be 
326
# extracted and appear in the documentation as a namespace called 
327
# 'anonymous_namespace{file}', where file will be replaced with the base 
328
# name of the file that contains the anonymous namespace. By default 
329
# anonymous namespace are hidden.
330

  
331
EXTRACT_ANON_NSPACES   = NO
332

  
256 333
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
257 334
# undocumented members of documented classes, files or namespaces. 
258 335
# If set to NO (the default) these members will be included in the 
......
328 405

  
329 406
SORT_BRIEF_DOCS        = NO
330 407

  
408
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 
409
# hierarchy of group names into alphabetical order. If set to NO (the default) 
410
# the group names will appear in their defined order.
411

  
412
SORT_GROUP_NAMES       = NO
413

  
331 414
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
332 415
# sorted by fully-qualified names, including namespaces. If set to 
333 416
# NO (the default), the class list will be sorted only by class name, 
334 417
# not including the namespace part. 
335
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
418
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 
336 419
# Note: This option applies only to the class list, not to the 
337 420
# alphabetical list.
338 421

  
......
389 472

  
390 473
SHOW_DIRECTORIES       = NO
391 474

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

  
479
SHOW_FILES             = YES
480

  
481
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 
482
# Namespaces page. 
483
# This will remove the Namespaces entry from the Quick Index 
484
# and from the Folder Tree View (if specified). The default is YES.
485

  
486
SHOW_NAMESPACES        = YES
487

  
392 488
# The FILE_VERSION_FILTER tag can be used to specify a program or script that 
393
# doxygen should invoke to get the current version for each file (typically from the 
394
# version control system). Doxygen will invoke the program by executing (via 
489
# doxygen should invoke to get the current version for each file (typically from 
490
# the version control system). Doxygen will invoke the program by executing (via 
395 491
# popen()) the command <command> <input-file>, where <command> is the value of 
396 492
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
397 493
# provided by doxygen. Whatever the program writes to standard output 
......
399 495

  
400 496
FILE_VERSION_FILTER    = 
401 497

  
498
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by 
499
# doxygen. The layout file controls the global structure of the generated output files 
500
# in an output format independent way. The create the layout file that represents 
501
# doxygen's defaults, run doxygen with the -l option. You can optionally specify a 
502
# file name after the option, if omitted DoxygenLayout.xml will be used as the name 
503
# of the layout file.
504

  
505
LAYOUT_FILE            = 
506

  
402 507
#---------------------------------------------------------------------------
403 508
# configuration options related to warning and progress messages
404 509
#---------------------------------------------------------------------------
......
461 566

  
462 567
INPUT                  = 
463 568

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

  
575
INPUT_ENCODING         = UTF-8
576

  
464 577
# If the value of the INPUT tag contains directories, you can use the 
465 578
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
466 579
# and *.h) to filter out the source-files in the directories. If left 
467 580
# blank the following patterns are tested: 
468 581
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
469
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
582
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
470 583

  
471 584
FILE_PATTERNS          = 
472 585

  
......
496 609

  
497 610
EXCLUDE_PATTERNS       = 
498 611

  
612
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
613
# (namespaces, classes, functions, etc.) that should be excluded from the 
614
# output. The symbol name can be a fully qualified name, a word, or if the 
615
# wildcard * is used, a substring. Examples: ANamespace, AClass, 
616
# AClass::ANamespace, ANamespace::*Test
617

  
618
EXCLUDE_SYMBOLS        = 
619

  
499 620
# The EXAMPLE_PATH tag can be used to specify one or more files or 
500 621
# directories that contain example code fragments that are included (see 
501 622
# the \include command).
......
527 648
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
528 649
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
529 650
# input file. Doxygen will then use the output that the filter program writes 
530
# to standard output.  If FILTER_PATTERNS is specified, this tag will be 
651
# to standard output. 
652
# If FILTER_PATTERNS is specified, this tag will be 
531 653
# ignored.
532 654

  
533 655
INPUT_FILTER           = 
534 656

  
535 657
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
536
# basis.  Doxygen will compare the file name with each pattern and apply the 
537
# filter if there is a match.  The filters are a list of the form: 
658
# basis. 
659
# Doxygen will compare the file name with each pattern and apply the 
660
# filter if there is a match. 
661
# The filters are a list of the form: 
538 662
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
539 663
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
540 664
# is applied to all files.
......
569 693

  
570 694
STRIP_CODE_COMMENTS    = YES
571 695

  
572
# If the REFERENCED_BY_RELATION tag is set to YES (the default) 
696
# If the REFERENCED_BY_RELATION tag is set to YES 
573 697
# then for each documented function all documented 
574 698
# functions referencing it will be listed.
575 699

  
576 700
REFERENCED_BY_RELATION = YES
577 701

  
578
# If the REFERENCES_RELATION tag is set to YES (the default) 
702
# If the REFERENCES_RELATION tag is set to YES 
579 703
# then for each documented function all documented entities 
580 704
# called/used by that function will be listed.
581 705

  
582 706
REFERENCES_RELATION    = YES
583 707

  
584
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
585
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
586
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
587
# link to the source code.  Otherwise they will link to the documentstion.
708
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 
709
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 
710
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 
711
# link to the source code. 
712
# Otherwise they will link to the documentation.
588 713

  
589 714
REFERENCES_LINK_SOURCE = YES
590 715

  
......
673 798

  
674 799
HTML_ALIGN_MEMBERS     = YES
675 800

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

  
807
HTML_DYNAMIC_SECTIONS  = NO
808

  
809
# If the GENERATE_DOCSET tag is set to YES, additional index files 
810
# will be generated that can be used as input for Apple's Xcode 3 
811
# integrated development environment, introduced with OSX 10.5 (Leopard). 
812
# To create a documentation set, doxygen will generate a Makefile in the 
813
# HTML output directory. Running make will produce the docset in that 
814
# directory and running "make install" will install the docset in 
815
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
816
# it at startup. 
817
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
818

  
819
GENERATE_DOCSET        = NO
820

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

  
826
DOCSET_FEEDNAME        = "Doxygen generated docs"
827

  
828
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
829
# should uniquely identify the documentation set bundle. This should be a 
830
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
831
# will append .docset to the name.
832

  
833
DOCSET_BUNDLE_ID       = org.doxygen.Project
834

  
676 835
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
677 836
# will be generated that can be used as input for tools like the 
678
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
837
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
679 838
# of the generated HTML documentation.
680 839

  
681 840
GENERATE_HTMLHELP      = NO
......
700 859

  
701 860
GENERATE_CHI           = NO
702 861

  
862
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 
863
# is used to encode HtmlHelp index (hhk), content (hhc) and project file 
864
# content.
865

  
866
CHM_INDEX_ENCODING     = 
867

  
703 868
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
704 869
# controls whether a binary table of contents is generated (YES) or a 
705 870
# normal table of contents (NO) in the .chm file.
......
711 876

  
712 877
TOC_EXPAND             = NO
713 878

  
879
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 
880
# are set, an additional index file will be generated that can be used as input for 
881
# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated 
882
# HTML documentation.
883

  
884
GENERATE_QHP           = NO
885

  
886
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 
887
# be used to specify the file name of the resulting .qch file. 
888
# The path specified is relative to the HTML output folder.
889

  
890
QCH_FILE               = 
891

  
892
# The QHP_NAMESPACE tag specifies the namespace to use when generating 
893
# Qt Help Project output. For more information please see 
894
# http://doc.trolltech.com/qthelpproject.html#namespace
895

  
896
QHP_NAMESPACE          = 
897

  
898
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 
899
# Qt Help Project output. For more information please see 
900
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
901

  
902
QHP_VIRTUAL_FOLDER     = doc
903

  
904
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. 
905
# For more information please see 
906
# http://doc.trolltech.com/qthelpproject.html#custom-filters
907

  
908
QHP_CUST_FILTER_NAME   = 
909

  
910
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 
911
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
912

  
913
QHP_CUST_FILTER_ATTRS  = 
914

  
915
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 
916
# filter section matches. 
917
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
918

  
919
QHP_SECT_FILTER_ATTRS  = 
920

  
921
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 
922
# be used to specify the location of Qt's qhelpgenerator. 
923
# If non-empty doxygen will try to run qhelpgenerator on the generated 
924
# .qhp file.
925

  
926
QHG_LOCATION           = 
927

  
714 928
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
715 929
# top of each HTML page. The value NO (the default) enables the index and 
716 930
# the value YES disables it.
......
722 936

  
723 937
ENUM_VALUES_PER_LINE   = 4
724 938

  
725
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
726
# generated containing a tree-like index structure (just like the one that 
939
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 
940
# structure should be generated to display hierarchical information. 
941
# If the tag value is set to FRAME, a side panel will be generated 
942
# containing a tree-like index structure (just like the one that 
727 943
# is generated for HTML Help). For this to work a browser that supports 
728 944
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
729 945
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
730
# probably better off using the HTML help feature.
946
# probably better off using the HTML help feature. Other possible values 
947
# for this tag are: HIERARCHIES, which will generate the Groups, Directories, 
948
# and Class Hierarchy pages using a tree view instead of an ordered list; 
949
# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which 
950
# disables this behavior completely. For backwards compatibility with previous 
951
# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE 
952
# respectively.
731 953

  
732 954
GENERATE_TREEVIEW      = NO
733 955

  
......
737 959

  
738 960
TREEVIEW_WIDTH         = 250
739 961

  
962
# Use this tag to change the font size of Latex formulas included 
963
# as images in the HTML documentation. The default is 10. Note that 
964
# when you change the font size after a successful doxygen run you need 
965
# to manually remove any form_*.png images from the HTML output directory 
966
# to force them to be regenerated.
967

  
968
FORMULA_FONTSIZE       = 10
969

  
740 970
#---------------------------------------------------------------------------
741 971
# configuration options related to the LaTeX output
742 972
#---------------------------------------------------------------------------
......
813 1043

  
814 1044
LATEX_HIDE_INDICES     = NO
815 1045

  
1046
# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
1047

  
1048
LATEX_SOURCE_CODE      = NO
1049

  
816 1050
#---------------------------------------------------------------------------
817 1051
# configuration options related to the RTF output
818 1052
#---------------------------------------------------------------------------
......
949 1183
PERLMOD_LATEX          = NO
950 1184

  
951 1185
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
952
# nicely formatted so it can be parsed by a human reader.  This is useful 
953
# if you want to understand what is going on.  On the other hand, if this 
1186
# nicely formatted so it can be parsed by a human reader. 
1187
# This is useful 
1188
# if you want to understand what is going on. 
1189
# On the other hand, if this 
954 1190
# tag is set to NO the size of the Perl module output will be much smaller 
955 1191
# and Perl will parse it just the same.
956 1192

  
......
1037 1273
# Optionally an initial location of the external documentation 
1038 1274
# can be added for each tagfile. The format of a tag file without 
1039 1275
# this location is as follows: 
1040
#   TAGFILES = file1 file2 ... 
1276
#  
1277
# TAGFILES = file1 file2 ... 
1041 1278
# Adding location for the tag files is done as follows: 
1042
#   TAGFILES = file1=loc1 "file2 = loc2" ... 
1279
#  
1280
# TAGFILES = file1=loc1 "file2 = loc2" ... 
1043 1281
# where "loc1" and "loc2" can be relative or absolute paths or 
1044 1282
# URLs. If a location is present for each tag, the installdox tool 
1045
# does not have to be run to correct the links.
1046
# Note that each tag file must have a unique name
1047
# (where the name does NOT include the path)
1283
# does not have to be run to correct the links. 
1284
# Note that each tag file must have a unique name 
1285
# (where the name does NOT include the path) 
1048 1286
# If a tag file is not located in the directory in which doxygen 
1049 1287
# is run, you must also specify the path to the tagfile here.
1050 1288

  
......
1085 1323

  
1086 1324
CLASS_DIAGRAMS         = YES
1087 1325

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

  
1333
MSCGEN_PATH            = 
1334

  
1088 1335
# If set to YES, the inheritance and collaboration graphs will hide 
1089 1336
# inheritance and usage relations if the target is undocumented 
1090 1337
# or is not a class.
......
1098 1345

  
1099 1346
HAVE_DOT               = NO
1100 1347

  
1348
# By default doxygen will write a font called FreeSans.ttf to the output 
1349
# directory and reference it in all dot files that doxygen generates. This 
1350
# font does not include all possible unicode characters however, so when you need 
1351
# these (or just want a differently looking font) you can specify the font name 
1352
# using DOT_FONTNAME. You need need to make sure dot is able to find the font, 
1353
# which can be done by putting it in a standard location or by setting the 
1354
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 
1355
# containing the font.
1356

  
1357
DOT_FONTNAME           = FreeSans
1358

  
1359
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 
1360
# The default size is 10pt.
1361

  
1362
DOT_FONTSIZE           = 10
1363

  
1364
# By default doxygen will tell dot to use the output directory to look for the 
1365
# FreeSans.ttf font (which doxygen will put there itself). If you specify a 
1366
# different font using DOT_FONTNAME you can set the path where dot 
1367
# can find it using this tag.
1368

  
1369
DOT_FONTPATH           = 
1370

  
1101 1371
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1102 1372
# will generate a graph for each documented class showing the direct and 
1103 1373
# indirect inheritance relations. Setting this tag to YES will force the 
......
1142 1412

  
1143 1413
INCLUDED_BY_GRAPH      = YES
1144 1414

  
1145
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
1146
# generate a call dependency graph for every global function or class method. 
1147
# Note that enabling this option will significantly increase the time of a run. 
1148
# So in most cases it will be better to enable call graphs for selected 
1149
# functions only using the \callgraph command.
1415
# If the CALL_GRAPH and HAVE_DOT options are set to YES then 
1416
# doxygen will generate a call dependency graph for every global function 
1417
# or class method. Note that enabling this option will significantly increase 
1418
# the time of a run. So in most cases it will be better to enable call graphs 
1419
# for selected functions only using the \callgraph command.
1150 1420

  
1151 1421
CALL_GRAPH             = NO
1152 1422

  
1153
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
1154
# generate a caller dependency graph for every global function or class method. 
1155
# Note that enabling this option will significantly increase the time of a run. 
1156
# So in most cases it will be better to enable caller graphs for selected 
1157
# functions only using the \callergraph command.
1423
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 
1424
# doxygen will generate a caller dependency graph for every global function 
1425
# or class method. Note that enabling this option will significantly increase 
1426
# the time of a run. So in most cases it will be better to enable caller 
1427
# graphs for selected functions only using the \callergraph command.
1158 1428

  
1159 1429
CALLER_GRAPH           = NO
1160 1430

  
......
1165 1435

  
1166 1436
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
1167 1437
# then doxygen will show the dependencies a directory has on other directories 
1168
# in a graphical way. The dependency relations are determined by the #include
1438
# in a graphical way. The dependency relations are determined by the #include 
1169 1439
# relations between the files in the directories.
1170 1440

  
1171 1441
DIRECTORY_GRAPH        = YES
1172 1442

  
1173 1443
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
1174
# generated by dot. Possible values are png, jpg, or gif
1444
# generated by dot. Possible values are png, jpg, or gif 
1175 1445
# If left blank png will be used.
1176 1446

  
1177 1447
DOT_IMAGE_FORMAT       = png
......
1187 1457

  
1188 1458
DOTFILE_DIRS           = 
1189 1459

  
1190
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
1191
# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
1192
# this value, doxygen will try to truncate the graph, so that it fits within 
1193
# the specified constraint. Beware that most browsers cannot cope with very 
1194
# large images.
1460
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
1461
# nodes that will be shown in the graph. If the number of nodes in a graph 
1462
# becomes larger than this value, doxygen will truncate the graph, which is 
1463
# visualized by representing a node as a red box. Note that doxygen if the 
1464
# number of direct children of the root node in a graph is already larger than 
1465
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 
1466
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1195 1467

  
1196
MAX_DOT_GRAPH_WIDTH    = 1024
1468
DOT_GRAPH_MAX_NODES    = 50
1197 1469

  
1198
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
1199
# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
1200
# this value, doxygen will try to truncate the graph, so that it fits within 
1201
# the specified constraint. Beware that most browsers cannot cope with very 
1202
# large images.
1203

  
1204
MAX_DOT_GRAPH_HEIGHT   = 1024
1205

  
1206 1470
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
1207 1471
# graphs generated by dot. A depth value of 3 means that only nodes reachable 
1208 1472
# from the root by following a path via at most 3 edges will be shown. Nodes 
1209 1473
# that lay further from the root node will be omitted. Note that setting this 
1210 1474
# option to 1 or 2 may greatly reduce the computation time needed for large 
1211
# code bases. Also note that a graph may be further truncated if the graph's 
1212
# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH 
1213
# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), 
1214
# the graph is not depth-constrained.
1475
# code bases. Also note that the size of a graph can be further restricted by 
1476
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1215 1477

  
1216 1478
MAX_DOT_GRAPH_DEPTH    = 0
1217 1479

  
1218 1480
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
1219
# background. This is disabled by default, which results in a white background. 
1220
# Warning: Depending on the platform used, enabling this option may lead to 
1221
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 
1222
# read).
1481
# background. This is disabled by default, because dot on Windows does not 
1482
# seem to support this out of the box. Warning: Depending on the platform used, 
1483
# enabling this option may lead to badly anti-aliased labels on the edges of 
1484
# a graph (i.e. they become hard to read).
1223 1485

  
1224 1486
DOT_TRANSPARENT        = NO
1225 1487

  
......
1243 1505
DOT_CLEANUP            = YES
1244 1506

  
1245 1507
#---------------------------------------------------------------------------
1246
# Configuration::additions related to the search engine   
1508
# Options related to the search engine
1247 1509
#---------------------------------------------------------------------------
1248 1510

  
1249 1511
# The SEARCHENGINE tag specifies whether or not a search engine should be 

Also available in: Unified diff