Changeset 1576


Ignore:
Timestamp:
2008-10-01 16:50:58 (6 years ago)
Author:
drobilla
Message:

Update ingen doxygen file to be all new and modern and updatey and such.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/ingen/doc/reference.doxygen.in

    r1575 r1576  
    1 # Doxyfile 1.3.8 
     1# Doxyfile 1.5.6 
    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  
     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 
     23DOXYFILE_ENCODING      = UTF-8 
     24 
    1725# The PROJECT_NAME tag is a single word (or a sequence of words surrounded  
    1826# by quotes) that should identify the project. 
     
    3644# 4096 sub-directories (in 2 levels) under the output directory of each output  
    3745# format and will distribute the generated files over these directories.  
    38 # Enabling this option can be useful when feeding doxygen a huge amount of source  
    39 # files, where putting all generated files in the same directory would otherwise  
    40 # cause performance problems for the file system. 
     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. 
    4149 
    4250CREATE_SUBDIRS         = NO 
     
    4654# information to generate all constant output in the proper language.  
    4755# 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, 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. 
    5362 
    5463OUTPUT_LANGUAGE        = English 
    55  
    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 
    6564 
    6665# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will  
     
    8180# that is used to form the text in various listings. Each string  
    8281# in this list, if found as the leading text of the brief description, will be  
    83 # stripped from the text and the result after processing the whole list, is used  
    84 # as the annotated text. Otherwise, the brief description is used as-is. If left  
    85 # blank, the following values are used ("$name" is automatically replaced with the  
    86 # name of the entity): "The $name class" "The $name widget" "The $name file"  
    87 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the" 
     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" 
    8888 
    8989ABBREVIATE_BRIEF       =  
     
    9595ALWAYS_DETAILED_SEC    = NO 
    9696 
    97 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited  
    98 # members of a class in the documentation of that class as if those members were  
    99 # ordinary class members. Constructors, destructors and assignment operators of  
    100 # the base classes will not be shown. 
     97# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all  
     98# inherited members of a class in the documentation of that class as if those  
     99# members were ordinary class members. Constructors, destructors and assignment  
     100# operators of the base classes will not be shown. 
    101101 
    102102INLINE_INHERITED_MEMB  = NO 
     
    135135# will interpret the first line (until the first dot) of a JavaDoc-style  
    136136# comment as the brief description. If set to NO, the JavaDoc  
    137 # comments will behave just like the Qt-style comments (thus requiring an  
    138 # 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.) 
    139139 
    140140JAVADOC_AUTOBRIEF      = YES 
     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 
     148QT_AUTOBRIEF           = NO 
    141149 
    142150# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen  
     
    161169INHERIT_DOCS           = YES 
    162170 
    163 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC  
    164 # tag is set to YES, then doxygen will reuse the documentation of the first  
    165 # member in the group (if any) for the other members of the group. By default  
    166 # all members of a group must be documented explicitly. 
    167  
    168 DISTRIBUTE_GROUP_DOC   = NO 
     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 
     175SEPARATE_MEMBER_PAGES  = NO 
    169176 
    170177# The TAB_SIZE tag can be used to set the number of spaces in a tab.  
     
    180187# You can put \n's in the value part of an alias to insert newlines. 
    181188 
    182 ALIASES                = 
    183  
    184 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources  
    185 # only. Doxygen will then generate output that is more tailored for C.  
     189ALIASES                =  
     190 
     191# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C  
     192# sources only. Doxygen will then generate output that is more tailored for C.  
    186193# For instance, some of the names that are used will be different. The list  
    187194# of all members will be omitted, etc. 
     
    189196OPTIMIZE_OUTPUT_FOR_C  = NO 
    190197 
    191 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources  
    192 # 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. 
     198# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java  
     199# sources only. Doxygen will then generate output that is more tailored for  
     200# Java. For instance, namespaces will be presented as packages, qualified  
     201# scopes will look different, etc. 
    195202 
    196203OPTIMIZE_OUTPUT_JAVA   = NO 
     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 
     209OPTIMIZE_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 
     215OPTIMIZE_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 
     224BUILTIN_STL_SUPPORT    = YES 
     225 
     226# If you use Microsoft's C++/CLI language, you should set this option to YES to 
     227# enable parsing support. 
     228 
     229CPP_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 
     235SIP_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 
     244IDL_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 
     251DISTRIBUTE_GROUP_DOC   = NO 
    197252 
    198253# Set the SUBGROUPING tag to YES (the default) to allow class member groups of  
     
    204259SUBGROUPING            = YES 
    205260 
     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 
     269TYPEDEF_HIDES_STRUCT   = NO 
     270 
    206271#--------------------------------------------------------------------------- 
    207272# Build related configuration options 
     
    237302 
    238303EXTRACT_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 
     311EXTRACT_ANON_NSPACES   = NO 
    239312 
    240313# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all  
     
    312385 
    313386SORT_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 
     392SORT_GROUP_NAMES       = NO 
    314393 
    315394# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be  
     
    368447SHOW_USED_FILES        = YES 
    369448 
     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 
     453SHOW_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 
     459SHOW_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 
     465SHOW_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 
     475FILE_VERSION_FILTER    =  
     476 
    370477#--------------------------------------------------------------------------- 
    371478# configuration options related to warning and progress messages 
     
    396503WARN_IF_DOC_ERROR      = YES 
    397504 
     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 
     511WARN_NO_PARAMDOC       = NO 
     512 
    398513# The WARN_FORMAT tag determines the format of the warning messages that  
    399514# doxygen can produce. The string should contain the $file, $line, and $text  
    400515# tags, which will be replaced by the file and line number from which the  
    401 # 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) 
    402519 
    403520WARN_FORMAT            = "$file:$line: $text" 
     
    418535# with spaces. 
    419536 
    420 INPUT = @INGEN_SRCDIR@ 
     537INPUT                  = @INGEN_SRCDIR@ 
     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 
     545INPUT_ENCODING         = UTF-8 
    421546 
    422547# If the value of the INPUT tag contains directories, you can use the  
     
    424549# and *.h) to filter out the source-files in the directories. If left  
    425550# blank the following patterns are tested:  
    426 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp  
    427 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm 
     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 
    428553 
    429554FILE_PATTERNS          =  
     
    441566EXCLUDE                =  
    442567 
    443 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories  
    444 # that are symbolic links (a Unix filesystem feature) are excluded from the input. 
     568# The EXCLUDE_SYMLINKS tag can be used select whether or not files or  
     569# directories that are symbolic links (a Unix filesystem feature) are excluded  
     570# from the input. 
    445571 
    446572EXCLUDE_SYMLINKS       = NO 
     
    448574# If the value of the INPUT tag contains directories, you can use the  
    449575# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude  
    450 # 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/* 
    451579 
    452580EXCLUDE_PATTERNS       =  
     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 
     588EXCLUDE_SYMBOLS        =  
    453589 
    454590# The EXAMPLE_PATH tag can be used to specify one or more files or  
     
    525661STRIP_CODE_COMMENTS    = YES 
    526662 
    527 # If the REFERENCED_BY_RELATION tag is set to YES (the default)  
     663# If the REFERENCED_BY_RELATION tag is set to YES  
    528664# then for each documented function all documented  
    529665# functions referencing it will be listed. 
     
    531667REFERENCED_BY_RELATION = YES 
    532668 
    533 # If the REFERENCES_RELATION tag is set to YES (the default)  
     669# If the REFERENCES_RELATION tag is set to YES  
    534670# then for each documented function all documented entities  
    535671# called/used by that function will be listed. 
    536672 
    537673REFERENCES_RELATION    = YES 
     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 
     680REFERENCES_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 
     688USE_HTAGS              = NO 
    538689 
    539690# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen  
     
    616767# If the GENERATE_HTMLHELP tag is set to YES, additional index files  
    617768# will be generated that can be used as input for tools like the  
    618 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)  
     769# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)  
    619770# of the generated HTML documentation. 
    620771 
    621772GENERATE_HTMLHELP      = NO 
     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 
     783GENERATE_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 
     790DOCSET_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 
     797DOCSET_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 
     805HTML_DYNAMIC_SECTIONS  = NO 
    622806 
    623807# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can  
     
    641825GENERATE_CHI           = NO 
    642826 
     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 
     831CHM_INDEX_ENCODING     =  
     832 
    643833# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag  
    644834# controls whether a binary table of contents is generated (YES) or a  
     
    663853ENUM_VALUES_PER_LINE   = 4 
    664854 
    665 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 
    666 # 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  
    667859# is generated for HTML Help). For this to work a browser that supports  
    668860# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,  
    669861# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are  
    670 # probably better off using the HTML help feature. 
     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. 
    671869 
    672870GENERATE_TREEVIEW      = NO 
     
    677875 
    678876TREEVIEW_WIDTH         = 250 
     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 
     884FORMULA_FONTSIZE       = 10 
    679885 
    680886#--------------------------------------------------------------------------- 
     
    9231129# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES  
    9241130# then the macro expansion is limited to the macros specified with the  
    925 # PREDEFINED and EXPAND_AS_PREDEFINED tags. 
     1131# PREDEFINED and EXPAND_AS_DEFINED tags. 
    9261132 
    9271133EXPAND_ONLY_PREDEF     = NO 
     
    9491155# gcc). The argument of the tag is a list of macros of the form: name  
    9501156# or name=definition (no spaces). If the definition and the = are  
    951 # 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. 
    9521160 
    9531161PREDEFINED             =  
     
    9631171# doxygen's preprocessor will remove all function-like macros that are alone  
    9641172# on a line, have an all uppercase name, and do not end with a semicolon. Such  
    965 # function macros are typically used for boiler-plate code, and will confuse the  
    966 # parser if not removed. 
     1173# function macros are typically used for boiler-plate code, and will confuse  
     1174# the parser if not removed. 
    9671175 
    9681176SKIP_FUNCTION_MACROS   = YES 
     
    10161224 
    10171225# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will  
    1018 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or  
    1019 # super classes. Setting the tag to NO turns the diagrams off. Note that this  
    1020 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is  
    1021 # recommended to install and use dot, since it yields more powerful graphs. 
     1226# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base  
     1227# or super classes. Setting the tag to NO turns the diagrams off. Note that  
     1228# this option is superseded by the HAVE_DOT option below. This is only a  
     1229# fallback. It is recommended to install and use dot, since it yields more  
     1230# powerful graphs. 
    10221231 
    10231232CLASS_DIAGRAMS         = YES 
     1233 
     1234# You can define message sequence charts within doxygen comments using the \msc  
     1235# command. Doxygen will then run the mscgen tool (see  
     1236# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the  
     1237# documentation. The MSCGEN_PATH tag allows you to specify the directory where  
     1238# the mscgen tool resides. If left empty the tool is assumed to be found in the  
     1239# default search path. 
     1240 
     1241MSCGEN_PATH            =  
    10241242 
    10251243# If set to YES, the inheritance and collaboration graphs will hide  
     
    10361254HAVE_DOT               = YES 
    10371255 
     1256# By default doxygen will write a font called FreeSans.ttf to the output  
     1257# directory and reference it in all dot files that doxygen generates. This  
     1258# font does not include all possible unicode characters however, so when you need  
     1259# these (or just want a differently looking font) you can specify the font name  
     1260# using DOT_FONTNAME. You need need to make sure dot is able to find the font,  
     1261# which can be done by putting it in a standard location or by setting the  
     1262# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory  
     1263# containing the font. 
     1264 
     1265DOT_FONTNAME           = FreeSans 
     1266 
     1267# By default doxygen will tell dot to use the output directory to look for the  
     1268# FreeSans.ttf font (which doxygen will put there itself). If you specify a  
     1269# different font using DOT_FONTNAME you can set the path where dot  
     1270# can find it using this tag. 
     1271 
     1272DOT_FONTPATH           =  
     1273 
    10381274# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen  
    10391275# will generate a graph for each documented class showing the direct and  
     
    10501286COLLABORATION_GRAPH    = YES 
    10511287 
     1288# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen  
     1289# will generate a graph for groups, showing the direct groups dependencies 
     1290 
     1291GROUP_GRAPHS           = YES 
     1292 
    10521293# If the UML_LOOK tag is set to YES doxygen will generate inheritance and  
    10531294# collaboration diagrams in a style similar to the OMG's Unified Modeling  
     
    10751316INCLUDED_BY_GRAPH      = YES 
    10761317 
    1077 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will  
    1078 # generate a call dependency graph for every global function or class method.  
    1079 # Note that enabling this option will significantly increase the time of a run.  
    1080 # So in most cases it will be better to enable call graphs for selected  
    1081 # functions only using the \callgraph command. 
     1318# If the CALL_GRAPH and HAVE_DOT options are set to YES then  
     1319# doxygen will generate a call dependency graph for every global function  
     1320# or class method. Note that enabling this option will significantly increase  
     1321# the time of a run. So in most cases it will be better to enable call graphs  
     1322# for selected functions only using the \callgraph command. 
    10821323 
    10831324CALL_GRAPH             = NO 
     1325 
     1326# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then  
     1327# doxygen will generate a caller dependency graph for every global function  
     1328# or class method. Note that enabling this option will significantly increase  
     1329# the time of a run. So in most cases it will be better to enable caller  
     1330# graphs for selected functions only using the \callergraph command. 
     1331 
     1332CALLER_GRAPH           = NO 
    10841333 
    10851334# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen  
     
    10871336 
    10881337GRAPHICAL_HIERARCHY    = YES 
     1338 
     1339# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES  
     1340# then doxygen will show the dependencies a directory has on other directories  
     1341# in a graphical way. The dependency relations are determined by the #include 
     1342# relations between the files in the directories. 
     1343 
     1344DIRECTORY_GRAPH        = YES 
    10891345 
    10901346# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images  
     
    10951351 
    10961352# The tag DOT_PATH can be used to specify the path where the dot tool can be  
    1097 # found. If left blank, it is assumed the dot tool can be found on the path. 
     1353# found. If left blank, it is assumed the dot tool can be found in the path. 
    10981354 
    10991355DOT_PATH               =  
     
    11051361DOTFILE_DIRS           =  
    11061362 
    1107 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width  
    1108 # (in pixels) of the graphs generated by dot. If a graph becomes larger than  
    1109 # this value, doxygen will try to truncate the graph, so that it fits within  
    1110 # the specified constraint. Beware that most browsers cannot cope with very  
    1111 # large images. 
    1112  
    1113 MAX_DOT_GRAPH_WIDTH    = 1024 
    1114  
    1115 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height  
    1116 # (in pixels) of the graphs generated by dot. If a graph becomes larger than  
    1117 # this value, doxygen will try to truncate the graph, so that it fits within  
    1118 # the specified constraint. Beware that most browsers cannot cope with very  
    1119 # large images. 
    1120  
    1121 MAX_DOT_GRAPH_HEIGHT   = 1024 
     1363# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of  
     1364# nodes that will be shown in the graph. If the number of nodes in a graph  
     1365# becomes larger than this value, doxygen will truncate the graph, which is  
     1366# visualized by representing a node as a red box. Note that doxygen if the  
     1367# number of direct children of the root node in a graph is already larger than  
     1368# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note  
     1369# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 
     1370 
     1371DOT_GRAPH_MAX_NODES    = 50 
    11221372 
    11231373# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the  
    11241374# graphs generated by dot. A depth value of 3 means that only nodes reachable  
    1125 # from the root by following a path via at most 3 edges will be shown. Nodes that  
    1126 # lay further from the root node will be omitted. Note that setting this option to  
    1127 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also  
    1128 # note that a graph may be further truncated if the graph's image dimensions are  
    1129 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).  
    1130 # If 0 is used for the depth value (the default), the graph is not depth-constrained. 
     1375# from the root by following a path via at most 3 edges will be shown. Nodes  
     1376# that lay further from the root node will be omitted. Note that setting this  
     1377# option to 1 or 2 may greatly reduce the computation time needed for large  
     1378# code bases. Also note that the size of a graph can be further restricted by  
     1379# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 
    11311380 
    11321381MAX_DOT_GRAPH_DEPTH    = 0 
     1382 
     1383# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent  
     1384# background. This is enabled by default, which results in a transparent  
     1385# background. Warning: Depending on the platform used, enabling this option  
     1386# may lead to badly anti-aliased labels on the edges of a graph (i.e. they  
     1387# become hard to read). 
     1388 
     1389DOT_TRANSPARENT        = YES 
     1390 
     1391# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output  
     1392# files in one run (i.e. multiple -o and -T options on the command line). This  
     1393# makes dot run faster, but since only newer versions of dot (>1.8.10)  
     1394# support this, this feature is disabled by default. 
     1395 
     1396DOT_MULTI_TARGETS      = NO 
    11331397 
    11341398# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will  
Note: See TracChangeset for help on using the changeset viewer.