31
31
# This could be handy for archiving the generated documentation or
32
32
# if some version control system is used.
34
PROJECT_NUMBER = "version 0.4"
34
PROJECT_NUMBER = "version 0.5"
36
36
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37
37
# base path where the generated documentation will be put.
54
54
# information to generate all constant output in the proper language.
55
55
# The default language is English, other supported languages are:
56
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, Serbian-Cyrilic, Slovak, Slovene,
61
# Spanish, Swedish, and Ukrainian.
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.
63
63
OUTPUT_LANGUAGE = English
203
203
# Java. For instance, namespaces will be presented as packages, qualified
204
204
# scopes will look different, etc.
206
OPTIMIZE_OUTPUT_JAVA = NO
206
OPTIMIZE_OUTPUT_JAVA = YES
208
208
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
209
209
# sources only. Doxygen will then generate output that is more tailored for
218
218
OPTIMIZE_OUTPUT_VHDL = NO
220
# Doxygen selects the parser to use depending on the extension of the files it parses.
221
# With this tag you can assign which parser to use for a given extension.
222
# Doxygen has a built-in mapping, but you can override or extend it using this tag.
223
# The format is ext=language, where ext is a file extension, and language is one of
224
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
225
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
226
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
227
# use: inc=Fortran f=C
220
# Doxygen selects the parser to use depending on the extension of the files it
221
# parses. With this tag you can assign which parser to use for a given extension.
222
# Doxygen has a built-in mapping, but you can override or extend it using this
223
# tag. The format is ext=language, where ext is a file extension, and language
224
# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
225
# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
226
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
227
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
228
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
229
230
EXTENSION_MAPPING =
397
398
SHOW_INCLUDE_FILES = YES
400
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
401
# will list include files with double quotes in the documentation
402
# rather than with sharp brackets.
404
FORCE_LOCAL_INCLUDES = NO
399
406
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
400
407
# is inserted in the documentation for inline members.
416
423
SORT_BRIEF_DOCS = NO
425
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
426
# will sort the (brief and detailed) documentation of class members so that
427
# constructors and destructors are listed first. If set to NO (the default)
428
# the constructors will appear in the respective orders defined by
429
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
430
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
431
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
433
SORT_MEMBERS_CTORS_1ST = NO
418
435
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
419
436
# hierarchy of group names into alphabetical order. If set to NO (the default)
420
437
# the group names will appear in their defined order.
505
522
FILE_VERSION_FILTER =
507
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
508
# doxygen. The layout file controls the global structure of the generated output files
509
# in an output format independent way. The create the layout file that represents
510
# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
511
# file name after the option, if omitted DoxygenLayout.xml will be used as the name
512
# of the layout file.
524
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
525
# by doxygen. The layout file controls the global structure of the generated
526
# output files in an output format independent way. The create the layout file
527
# that represents doxygen's defaults, run doxygen with the -l option.
528
# You can optionally specify a file name after the option, if omitted
529
# DoxygenLayout.xml will be used as the name of the layout file.
846
863
HTML_STYLESHEET =
865
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
866
# Doxygen will adjust the colors in the stylesheet and background images
867
# according to this color. Hue is specified as an angle on a colorwheel,
868
# see http://en.wikipedia.org/wiki/Hue for more information.
869
# For instance the value 0 represents red, 60 is yellow, 120 is green,
870
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
871
# The allowed range is 0 to 359.
873
HTML_COLORSTYLE_HUE = 220
875
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
876
# the colors in the HTML output. For a value of 0 the output will use
877
# grayscales only. A value of 255 will produce the most vivid colors.
879
HTML_COLORSTYLE_SAT = 100
881
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
882
# the luminance component of the colors in the HTML output. Values below
883
# 100 gradually make the output lighter, whereas values above 100 make
884
# the output darker. The value divided by 100 is the actual gamma applied,
885
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
886
# and 100 does not change the gamma.
888
HTML_COLORSTYLE_GAMMA = 80
890
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
891
# page will contain the date and time when the page was generated. Setting
892
# this to NO can help when comparing the output of multiple runs.
848
896
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
849
897
# files or namespaces will be aligned in HTML using tables. If set to
850
898
# NO a bullet list will be used.
886
935
DOCSET_BUNDLE_ID = org.doxygen.Project
937
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
938
# the documentation publisher. This should be a reverse domain-name style
939
# string, e.g. com.mycompany.MyDocSet.documentation.
941
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
943
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
945
DOCSET_PUBLISHER_NAME = Publisher
888
947
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
889
948
# will be generated that can be used as input for tools like the
890
949
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
932
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
933
# are set, an additional index file will be generated that can be used as input for
934
# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
935
# HTML documentation.
991
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
992
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
993
# that can be used as input for Qt's qhelpgenerator to generate a
994
# Qt Compressed Help (.qch) of the generated HTML documentation.
937
996
GENERATE_QHP = NO
955
1014
QHP_VIRTUAL_FOLDER = doc
957
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
958
# For more information please see
1016
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1017
# add. For more information please see
959
1018
# http://doc.trolltech.com/qthelpproject.html#custom-filters
961
1020
QHP_CUST_FILTER_NAME =
963
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
964
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
1022
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1023
# custom filter to add. For more information please see
1024
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1025
# Qt Help Project / Custom Filters</a>.
966
1027
QHP_CUST_FILTER_ATTRS =
968
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
1029
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
969
1031
# filter section matches.
970
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
1032
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1033
# Qt Help Project / Filter Attributes</a>.
972
1035
QHP_SECT_FILTER_ATTRS =
1044
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1045
# will be generated, which together with the HTML files, form an Eclipse help
1046
# plugin. To install this plugin and make it available under the help contents
1047
# menu in Eclipse, the contents of the directory containing the HTML and XML
1048
# files needs to be copied into the plugins directory of eclipse. The name of
1049
# the directory within the plugins directory should be the same as
1050
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1053
GENERATE_ECLIPSEHELP = NO
1055
# A unique identifier for the eclipse help plugin. When installing the plugin
1056
# the directory name containing the HTML and XML files should also have
1059
ECLIPSE_DOC_ID = org.doxygen.Project
981
1061
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
982
1062
# top of each HTML page. The value NO (the default) enables the index and
983
1063
# the value YES disables it.
992
1072
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
993
1073
# structure should be generated to display hierarchical information.
994
# If the tag value is set to FRAME, a side panel will be generated
1074
# If the tag value is set to YES, a side panel will be generated
995
1075
# containing a tree-like index structure (just like the one that
996
1076
# is generated for HTML Help). For this to work a browser that supports
997
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
998
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
999
# probably better off using the HTML help feature. Other possible values
1000
# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
1001
# and Class Hierarchy pages using a tree view instead of an ordered list;
1002
# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
1003
# disables this behavior completely. For backwards compatibility with previous
1004
# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
1007
GENERATE_TREEVIEW = NONE
1077
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1078
# Windows users are probably better off using the HTML help feature.
1080
GENERATE_TREEVIEW = NO
1082
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1083
# and Class Hierarchy pages using a tree view instead of an ordered list.
1085
USE_INLINE_TREES = NO
1009
1087
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1010
1088
# used to set the initial width (in pixels) of the frame in which the tree
1013
1091
TREEVIEW_WIDTH = 250
1093
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1094
# links to external symbols imported via tag files in a separate window.
1096
EXT_LINKS_IN_WINDOW = NO
1015
1098
# Use this tag to change the font size of Latex formulas included
1016
1099
# as images in the HTML documentation. The default is 10. Note that
1017
1100
# when you change the font size after a successful doxygen run you need
1021
1104
FORMULA_FONTSIZE = 10
1106
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1107
# generated for formulas are transparent PNGs. Transparent PNGs are
1108
# not supported properly for IE 6.0, but are supported on all modern browsers.
1109
# Note that when changing this option you need to delete any form_*.png files
1110
# in the HTML output before the changes have effect.
1112
FORMULA_TRANSPARENT = YES
1114
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1115
# for the HTML output. The underlying search engine uses javascript
1116
# and DHTML and should work on any modern browser. Note that when using
1117
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1118
# (GENERATE_DOCSET) there is already a search function so this one should
1119
# typically be disabled. For large projects the javascript based search engine
1120
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1124
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1125
# implemented using a PHP enabled web server instead of at the web client
1126
# using Javascript. Doxygen will generate the search PHP script and index
1127
# file to put on the web server. The advantage of the server
1128
# based approach is that it scales better to large projects and allows
1129
# full text search. The disadvances is that it is more difficult to setup
1130
# and does not have live searching capabilities.
1132
SERVER_BASED_SEARCH = NO
1023
1134
#---------------------------------------------------------------------------
1024
1135
# configuration options related to the LaTeX output
1025
1136
#---------------------------------------------------------------------------
1036
1147
LATEX_OUTPUT = latex
1038
1149
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1039
# invoked. If left blank `latex' will be used as the default command name.
1150
# invoked. If left blank `latex' will be used as the default command name.
1151
# Note that when enabling USE_PDFLATEX this option is only used for
1152
# generating bitmaps for formulas in the HTML output, but not in the
1153
# Makefile that is written to the output directory.
1041
1155
LATEX_CMD_NAME = latex
1097
1211
LATEX_HIDE_INDICES = NO
1213
# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1214
# source code with syntax highlighting in the LaTeX output.
1215
# Note that which sources are shown also depends on other settings
1216
# such as SOURCE_BROWSER.
1218
LATEX_SOURCE_CODE = NO
1099
1220
#---------------------------------------------------------------------------
1100
1221
# configuration options related to the RTF output
1101
1222
#---------------------------------------------------------------------------
1247
1368
PERLMOD_MAKEVAR_PREFIX =
1249
1370
#---------------------------------------------------------------------------
1250
# Configuration options related to the preprocessor
1371
# Configuration options related to the preprocessor
1251
1372
#---------------------------------------------------------------------------
1253
1374
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1313
1434
SKIP_FUNCTION_MACROS = YES
1315
1436
#---------------------------------------------------------------------------
1316
# Configuration::additions related to external references
1437
# Configuration::additions related to external references
1317
1438
#---------------------------------------------------------------------------
1319
1440
# The TAGFILES option can be used to specify one or more tagfiles.
1356
1477
PERL_PATH = /usr/bin/perl
1358
1479
#---------------------------------------------------------------------------
1359
# Configuration options related to the dot tool
1480
# Configuration options related to the dot tool
1360
1481
#---------------------------------------------------------------------------
1362
1483
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1514
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1515
# allowed to run in parallel. When set to 0 (the default) doxygen will
1516
# base this on the number of processors available in the system. You can set it
1517
# explicitly to a value larger than 0 to get control over the balance
1518
# between CPU load and processing speed.
1393
1522
# By default doxygen will write a font called FreeSans.ttf to the output
1394
1523
# directory and reference it in all dot files that doxygen generates. This
1395
1524
# font does not include all possible unicode characters however, so when you need
1548
1677
# the various graphs.
1550
1679
DOT_CLEANUP = YES
1552
#---------------------------------------------------------------------------
1553
# Options related to the search engine
1554
#---------------------------------------------------------------------------
1556
# The SEARCHENGINE tag specifies whether or not a search engine should be
1557
# used. If set to NO the values of all tags below this one will be ignored.