Changeset 3472 for libcaca/trunk


Ignore:
Timestamp:
May 19, 2009, 2:52:02 AM (10 years ago)
Author:
Sam Hocevar
Message:

Update the Doxygen configuration file to version 1.5.9.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • libcaca/trunk/doc/doxygen.cfg.in

    r2824 r3472  
    1 # Doxyfile 1.5.3-20071008
     1# Doxyfile 1.5.9
    22
    33# This file describes the settings to be used by the documentation system
     
    1515#---------------------------------------------------------------------------
    1616
    17 # This tag specifies the encoding used for all characters in the config file that
    18 # follow. The default is UTF-8 which is also the encoding used for all text before
    19 # the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
    20 # libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
    21 # possible encodings.
     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.
    2222
    2323DOXYFILE_ENCODING      = UTF-8
     
    5555# The default language is English, other supported languages are:
    5656# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
    57 # Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
    58 # Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
    59 # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
    60 # Serbian, Slovak, Slovene, 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.
    6162
    6263OUTPUT_LANGUAGE        = English
     
    155156MULTILINE_CPP_IS_BRIEF = NO
    156157
    157 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
    158 # will output the detailed description near the top, like JavaDoc.
    159 # If set to NO, the detailed description appears after the member
    160 # documentation.
    161 
    162 DETAILS_AT_TOP         = NO
    163 
    164158# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
    165159# member inherits the documentation from any documented member that it
     
    196190
    197191# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
    198 # sources only. Doxygen will then generate output that is more tailored for Java.
    199 # For instance, namespaces will be presented as packages, qualified scopes
    200 # 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.
    201195
    202196OPTIMIZE_OUTPUT_JAVA   = NO
    203197
    204 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
    205 # 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
     202OPTIMIZE_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
     208OPTIMIZE_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
     219EXTENSION_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
    206223# set this tag to YES in order to let doxygen match functions declarations and
    207224# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
     
    211228BUILTIN_STL_SUPPORT    = NO
    212229
    213 # If you use Microsoft's C++/CLI language, you should set this option to YES to
     230# If you use Microsoft's C++/CLI language, you should set this option to YES to 
    214231# enable parsing support.
    215232
     
    221238
    222239SIP_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
     248IDL_PROPERTY_SUPPORT   = YES
    223249
    224250# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
     
    237263SUBGROUPING            = YES
    238264
     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
     273TYPEDEF_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
     289SYMBOL_CACHE_SIZE      = 0
     290
    239291#---------------------------------------------------------------------------
    240292# Build related configuration options
     
    271323EXTRACT_LOCAL_METHODS  = NO
    272324
    273 # If this flag is set to YES, the members of anonymous namespaces will be extracted
    274 # and appear in the documentation as a namespace called 'anonymous_namespace{file}',
    275 # where file will be replaced with the base name of the file that contains the anonymous
    276 # namespace. By default anonymous namespace are hidden.
     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.
    277330
    278331EXTRACT_ANON_NSPACES   = NO
     
    353406SORT_BRIEF_DOCS        = NO
    354407
     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
     412SORT_GROUP_NAMES       = NO
     413
    355414# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
    356415# sorted by fully-qualified names, including namespaces. If set to
    357416# NO (the default), the class list will be sorted only by class name,
    358417# not including the namespace part.
    359 # 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. 
    360419# Note: This option applies only to the class list, not to the
    361420# alphabetical list.
     
    414473SHOW_DIRECTORIES       = NO
    415474
     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
     479SHOW_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
     486SHOW_NAMESPACES        = YES
     487
    416488# The FILE_VERSION_FILTER tag can be used to specify a program or script that
    417 # doxygen should invoke to get the current version for each file (typically from the
    418 # 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
    419491# popen()) the command <command> <input-file>, where <command> is the value of
    420492# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
     
    423495
    424496FILE_VERSION_FILTER    =
     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
     505LAYOUT_FILE            =
    425506
    426507#---------------------------------------------------------------------------
     
    489570                         @top_srcdir@/ruby
    490571
    491 # This tag can be used to specify the character encoding of the source files that
    492 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
    493 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
    494 # See http://www.gnu.org/software/libiconv for the list of possible encodings.
     572# This tag can be used to specify the character encoding of the source files
     573# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
     574# also the default input encoding. Doxygen uses libiconv (or the iconv built
     575# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
     576# the list of possible encodings.
    495577
    496578INPUT_ENCODING         = UTF-8
     
    501583# blank the following patterns are tested:
    502584# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
    503 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
     585# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
    504586
    505587FILE_PATTERNS          = *.dox \
     
    539621
    540622# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
    541 # (namespaces, classes, functions, etc.) that should be excluded from the output.
    542 # The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
    543 # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
     623# (namespaces, classes, functions, etc.) that should be excluded from the
     624# output. The symbol name can be a fully qualified name, a word, or if the
     625# wildcard * is used, a substring. Examples: ANamespace, AClass,
     626# AClass::ANamespace, ANamespace::*Test
    544627
    545628EXCLUDE_SYMBOLS        =
     
    576659# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
    577660# input file. Doxygen will then use the output that the filter program writes
    578 # to standard output.  If FILTER_PATTERNS is specified, this tag will be
     661# to standard output.
     662# If FILTER_PATTERNS is specified, this tag will be
    579663# ignored.
    580664
     
    582666
    583667# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
    584 # basis.  Doxygen will compare the file name with each pattern and apply the
    585 # filter if there is a match.  The filters are a list of the form:
     668# basis.
     669# Doxygen will compare the file name with each pattern and apply the
     670# filter if there is a match.
     671# The filters are a list of the form:
    586672# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
    587673# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
     
    603689# be generated. Documented entities will be cross-referenced with these sources.
    604690# Note: To get rid of all source code in the generated output, make sure also
    605 # VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH
    606 # then you must also enable this option. If you don't then doxygen will produce
    607 # a warning and turn it on anyway
     691# VERBATIM_HEADERS is set to NO.
    608692
    609693SOURCE_BROWSER         = NO
     
    620704STRIP_CODE_COMMENTS    = YES
    621705
    622 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
     706# If the REFERENCED_BY_RELATION tag is set to YES
    623707# then for each documented function all documented
    624708# functions referencing it will be listed.
     
    626710REFERENCED_BY_RELATION = YES
    627711
    628 # If the REFERENCES_RELATION tag is set to YES (the default)
     712# If the REFERENCES_RELATION tag is set to YES
    629713# then for each documented function all documented entities
    630714# called/used by that function will be listed.
     
    632716REFERENCES_RELATION    = YES
    633717
    634 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
    635 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
    636 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
    637 # link to the source code.  Otherwise they will link to the documentstion.
     718# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
     719# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
     720# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
     721# link to the source code.
     722# Otherwise they will link to the documentation.
    638723
    639724REFERENCES_LINK_SOURCE = YES
     
    724809HTML_ALIGN_MEMBERS     = YES
    725810
    726 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
    727 # will be generated that can be used as input for tools like the
    728 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
    729 # of the generated HTML documentation.
    730 
    731 GENERATE_HTMLHELP      = NO
    732 
    733811# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
    734812# documentation will contain sections that can be hidden and shown after the
     
    739817HTML_DYNAMIC_SECTIONS  = NO
    740818
     819# If the GENERATE_DOCSET tag is set to YES, additional index files
     820# will be generated that can be used as input for Apple's Xcode 3
     821# integrated development environment, introduced with OSX 10.5 (Leopard).
     822# To create a documentation set, doxygen will generate a Makefile in the
     823# HTML output directory. Running make will produce the docset in that
     824# directory and running "make install" will install the docset in
     825# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
     826# it at startup.
     827# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
     828
     829GENERATE_DOCSET        = NO
     830
     831# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
     832# feed. A documentation feed provides an umbrella under which multiple
     833# documentation sets from a single provider (such as a company or product suite)
     834# can be grouped.
     835
     836DOCSET_FEEDNAME        = "Doxygen generated docs"
     837
     838# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
     839# should uniquely identify the documentation set bundle. This should be a
     840# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
     841# will append .docset to the name.
     842
     843DOCSET_BUNDLE_ID       = org.doxygen.Project
     844
     845# If the GENERATE_HTMLHELP tag is set to YES, additional index files
     846# will be generated that can be used as input for tools like the
     847# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
     848# of the generated HTML documentation.
     849
     850GENERATE_HTMLHELP      = NO
     851
    741852# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
    742853# be used to specify the file name of the resulting .chm file. You
     
    759870GENERATE_CHI           = NO
    760871
     872# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
     873# is used to encode HtmlHelp index (hhk), content (hhc) and project file
     874# content.
     875
     876CHM_INDEX_ENCODING     =
     877
    761878# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
    762879# controls whether a binary table of contents is generated (YES) or a
     
    770887TOC_EXPAND             = NO
    771888
     889# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
     890# are set, an additional index file will be generated that can be used as input for
     891# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
     892# HTML documentation.
     893
     894GENERATE_QHP           = NO
     895
     896# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
     897# be used to specify the file name of the resulting .qch file.
     898# The path specified is relative to the HTML output folder.
     899
     900QCH_FILE               =
     901
     902# The QHP_NAMESPACE tag specifies the namespace to use when generating
     903# Qt Help Project output. For more information please see
     904# http://doc.trolltech.com/qthelpproject.html#namespace
     905
     906QHP_NAMESPACE          =
     907
     908# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
     909# Qt Help Project output. For more information please see
     910# http://doc.trolltech.com/qthelpproject.html#virtual-folders
     911
     912QHP_VIRTUAL_FOLDER     = doc
     913
     914# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
     915# For more information please see
     916# http://doc.trolltech.com/qthelpproject.html#custom-filters
     917
     918QHP_CUST_FILTER_NAME   =
     919
     920# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
     921# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
     922
     923QHP_CUST_FILTER_ATTRS  =
     924
     925# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
     926# filter section matches.
     927# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
     928
     929QHP_SECT_FILTER_ATTRS  =
     930
     931# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
     932# be used to specify the location of Qt's qhelpgenerator.
     933# If non-empty doxygen will try to run qhelpgenerator on the generated
     934# .qhp file.
     935
     936QHG_LOCATION           =
     937
    772938# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
    773939# top of each HTML page. The value NO (the default) enables the index and
     
    781947ENUM_VALUES_PER_LINE   = 4
    782948
    783 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
    784 # generated containing a tree-like index structure (just like the one that
     949# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
     950# structure should be generated to display hierarchical information.
     951# If the tag value is set to FRAME, a side panel will be generated
     952# containing a tree-like index structure (just like the one that
    785953# is generated for HTML Help). For this to work a browser that supports
    786954# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
    787955# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
    788 # probably better off using the HTML help feature.
     956# probably better off using the HTML help feature. Other possible values
     957# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
     958# and Class Hierarchy pages using a tree view instead of an ordered list;
     959# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
     960# disables this behavior completely. For backwards compatibility with previous
     961# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
     962# respectively.
    789963
    790964GENERATE_TREEVIEW      = NO
     
    795969
    796970TREEVIEW_WIDTH         = 250
     971
     972# Use this tag to change the font size of Latex formulas included
     973# as images in the HTML documentation. The default is 10. Note that
     974# when you change the font size after a successful doxygen run you need
     975# to manually remove any form_*.png images from the HTML output directory
     976# to force them to be regenerated.
     977
     978FORMULA_FONTSIZE       = 10
    797979
    798980#---------------------------------------------------------------------------
     
    8711053
    8721054LATEX_HIDE_INDICES     = YES
     1055
     1056# 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.
     1057
     1058LATEX_SOURCE_CODE      = NO
    8731059
    8741060#---------------------------------------------------------------------------
     
    10081194
    10091195# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
    1010 # nicely formatted so it can be parsed by a human reader.  This is useful
    1011 # if you want to understand what is going on.  On the other hand, if this
     1196# nicely formatted so it can be parsed by a human reader.
     1197# This is useful
     1198# if you want to understand what is going on.
     1199# On the other hand, if this
    10121200# tag is set to NO the size of the Perl module output will be much smaller
    10131201# and Perl will parse it just the same.
     
    10781266# Use the PREDEFINED tag if you want to use a different macro definition.
    10791267
    1080 EXPAND_AS_DEFINED      = __extern __class
     1268EXPAND_AS_DEFINED      = __extern \
     1269                         __class
    10811270
    10821271# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
     
    10961285# can be added for each tagfile. The format of a tag file without
    10971286# this location is as follows:
    1098 #   TAGFILES = file1 file2 ...
     1287
     1288# TAGFILES = file1 file2 ...
    10991289# Adding location for the tag files is done as follows:
    1100 #   TAGFILES = file1=loc1 "file2 = loc2" ...
     1290
     1291# TAGFILES = file1=loc1 "file2 = loc2" ...
    11011292# where "loc1" and "loc2" can be relative or absolute paths or
    11021293# URLs. If a location is present for each tag, the installdox tool
    1103 # does not have to be run to correct the links.
    1104 # Note that each tag file must have a unique name
    1105 # (where the name does NOT include the path)
     1294# does not have to be run to correct the links. 
     1295# Note that each tag file must have a unique name 
     1296# (where the name does NOT include the path) 
    11061297# If a tag file is not located in the directory in which doxygen
    11071298# is run, you must also specify the path to the tagfile here.
     
    11451336
    11461337# You can define message sequence charts within doxygen comments using the \msc
    1147 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
    1148 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
    1149 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to
    1150 # be found in the default search path.
     1338# command. Doxygen will then run the mscgen tool (see
     1339# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
     1340# documentation. The MSCGEN_PATH tag allows you to specify the directory where
     1341# the mscgen tool resides. If left empty the tool is assumed to be found in the
     1342# default search path.
    11511343
    11521344MSCGEN_PATH            =
     
    11651357HAVE_DOT               = NO
    11661358
     1359# By default doxygen will write a font called FreeSans.ttf to the output
     1360# directory and reference it in all dot files that doxygen generates. This
     1361# font does not include all possible unicode characters however, so when you need
     1362# these (or just want a differently looking font) you can specify the font name
     1363# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
     1364# which can be done by putting it in a standard location or by setting the
     1365# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
     1366# containing the font.
     1367
     1368DOT_FONTNAME           = FreeSans
     1369
     1370# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
     1371# The default size is 10pt.
     1372
     1373DOT_FONTSIZE           = 10
     1374
     1375# By default doxygen will tell dot to use the output directory to look for the
     1376# FreeSans.ttf font (which doxygen will put there itself). If you specify a
     1377# different font using DOT_FONTNAME you can set the path where dot
     1378# can find it using this tag.
     1379
     1380DOT_FONTPATH           =
     1381
    11671382# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
    11681383# will generate a graph for each documented class showing the direct and
     
    12091424INCLUDED_BY_GRAPH      = YES
    12101425
    1211 # If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
    1212 # generate a call dependency graph for every global function or class method.
    1213 # Note that enabling this option will significantly increase the time of a run.
    1214 # So in most cases it will be better to enable call graphs for selected
    1215 # functions only using the \callgraph command.
     1426# If the CALL_GRAPH and HAVE_DOT options are set to YES then
     1427# doxygen will generate a call dependency graph for every global function
     1428# or class method. Note that enabling this option will significantly increase
     1429# the time of a run. So in most cases it will be better to enable call graphs
     1430# for selected functions only using the \callgraph command.
    12161431
    12171432CALL_GRAPH             = NO
    12181433
    1219 # If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
    1220 # generate a caller dependency graph for every global function or class method.
    1221 # Note that enabling this option will significantly increase the time of a run.
    1222 # So in most cases it will be better to enable caller graphs for selected
    1223 # functions only using the \callergraph command.
     1434# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
     1435# doxygen will generate a caller dependency graph for every global function
     1436# or class method. Note that enabling this option will significantly increase
     1437# the time of a run. So in most cases it will be better to enable caller
     1438# graphs for selected functions only using the \callergraph command.
    12241439
    12251440CALLER_GRAPH           = NO
     
    12321447# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
    12331448# then doxygen will show the dependencies a directory has on other directories
    1234 # in a graphical way. The dependency relations are determined by the #include
     1449# in a graphical way. The dependency relations are determined by the #include 
    12351450# relations between the files in the directories.
    12361451
     
    12381453
    12391454# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
    1240 # generated by dot. Possible values are png, jpg, or gif
     1455# generated by dot. Possible values are png, jpg, or gif 
    12411456# If left blank png will be used.
    12421457
     
    12541469DOTFILE_DIRS           = .
    12551470
    1256 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
     1471# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
    12571472# nodes that will be shown in the graph. If the number of nodes in a graph
    12581473# becomes larger than this value, doxygen will truncate the graph, which is
    1259 # visualized by representing a node as a red box. Note that doxygen if the number
    1260 # of direct children of the root node in a graph is already larger than
    1261 # MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
     1474# visualized by representing a node as a red box. Note that doxygen if the
     1475# number of direct children of the root node in a graph is already larger than
     1476# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
    12621477# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
    12631478
     
    12751490
    12761491# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
    1277 # background. This is disabled by default, which results in a white background.
    1278 # Warning: Depending on the platform used, enabling this option may lead to
    1279 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
    1280 # read).
     1492# background. This is disabled by default, because dot on Windows does not
     1493# seem to support this out of the box. Warning: Depending on the platform used,
     1494# enabling this option may lead to badly anti-aliased labels on the edges of
     1495# a graph (i.e. they become hard to read).
    12811496
    12821497DOT_TRANSPARENT        = NO
     
    13021517
    13031518#---------------------------------------------------------------------------
    1304 # Configuration::additions related to the search engine   
     1519# Options related to the search engine
    13051520#---------------------------------------------------------------------------
    13061521
Note: See TracChangeset for help on using the changeset viewer.