Changeset 99 for NEWT0/trunk


Ignore:
Timestamp:
04/15/07 03:07:54 (5 years ago)
Author:
gnue
Message:

Doxyfile update for doxygen 1.5.2

File:
1 edited

Legend:

Unmodified
Added
Removed
  • NEWT0/trunk/misc/Doxyfile

    r69 r99  
    1 # Doxyfile 1.3.6 
     1# Doxyfile 1.5.2 
     2 
     3# This file describes the settings to be used by the documentation system 
     4# doxygen (www.doxygen.org) for a project 
     5# 
     6# All text after a hash (#) is considered a comment and will be ignored 
     7# The format is: 
     8#       TAG = value [value, ...] 
     9# For lists items can also be appended using: 
     10#       TAG += value [value, ...] 
     11# Values that contain spaces should be placed between quotes (" ") 
    212 
    313#--------------------------------------------------------------------------- 
    414# Project related configuration options 
    515#--------------------------------------------------------------------------- 
     16 
     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. 
     22 
     23DOXYFILE_ENCODING      = UTF-8 
     24 
     25# The PROJECT_NAME tag is a single word (or a sequence of words surrounded  
     26# by quotes) that should identify the project. 
     27 
    628PROJECT_NAME           = NEWT/0 
     29 
     30# The PROJECT_NUMBER tag can be used to enter a project or revision number.  
     31# This could be handy for archiving the generated documentation or  
     32# if some version control system is used. 
     33 
    734PROJECT_NUMBER         =  
     35 
     36# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)  
     37# base path where the generated documentation will be put.  
     38# If a relative path is entered, it will be relative to the location  
     39# where doxygen was started. If left blank the current directory will be used. 
     40 
    841OUTPUT_DIRECTORY       = ../build 
     42 
     43# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create  
     44# 4096 sub-directories (in 2 levels) under the output directory of each output  
     45# format and will distribute the generated files over these directories.  
     46# Enabling this option can be useful when feeding doxygen a huge amount of  
     47# source files, where putting all generated files in the same directory would  
     48# otherwise cause performance problems for the file system. 
     49 
     50CREATE_SUBDIRS         = NO 
     51 
     52# The OUTPUT_LANGUAGE tag is used to specify the language in which all  
     53# documentation generated by doxygen is written. Doxygen will use this  
     54# information to generate all constant output in the proper language.  
     55# The default language is English, other supported languages are:  
     56# 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. 
     61 
    962OUTPUT_LANGUAGE        = Japanese 
    10 USE_WINDOWS_ENCODING   = YES 
     63 
     64# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will  
     65# include brief member descriptions after the members that are listed in  
     66# the file and class documentation (similar to JavaDoc).  
     67# Set to NO to disable this. 
     68 
    1169BRIEF_MEMBER_DESC      = YES 
     70 
     71# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend  
     72# the brief description of a member or function before the detailed description.  
     73# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the  
     74# brief descriptions will be completely suppressed. 
     75 
    1276REPEAT_BRIEF           = YES 
     77 
     78# This tag implements a quasi-intelligent brief description abbreviator  
     79# that is used to form the text in various listings. Each string  
     80# in this list, if found as the leading text of the brief description, will be  
     81# stripped from the text and the result after processing the whole list, is  
     82# used as the annotated text. Otherwise, the brief description is used as-is.  
     83# If left blank, the following values are used ("$name" is automatically  
     84# replaced with the name of the entity): "The $name class" "The $name widget"  
     85# "The $name file" "is" "provides" "specifies" "contains"  
     86# "represents" "a" "an" "the" 
     87 
    1388ABBREVIATE_BRIEF       =  
     89 
     90# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then  
     91# Doxygen will generate a detailed section even if there is only a brief  
     92# description. 
     93 
    1494ALWAYS_DETAILED_SEC    = NO 
     95 
     96# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all  
     97# inherited members of a class in the documentation of that class as if those  
     98# members were ordinary class members. Constructors, destructors and assignment  
     99# operators of the base classes will not be shown. 
     100 
    15101INLINE_INHERITED_MEMB  = NO 
     102 
     103# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full  
     104# path before files name in the file list and in the header files. If set  
     105# to NO the shortest path that makes the file name unique will be used. 
     106 
    16107FULL_PATH_NAMES        = NO 
     108 
     109# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag  
     110# can be used to strip a user-defined part of the path. Stripping is  
     111# only done if one of the specified strings matches the left-hand part of  
     112# the path. The tag can be used to show relative paths in the file list.  
     113# If left blank the directory from which doxygen is run is used as the  
     114# path to strip. 
     115 
    17116STRIP_FROM_PATH        =  
     117 
     118# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of  
     119# the path mentioned in the documentation of a class, which tells  
     120# the reader which header file to include in order to use a class.  
     121# If left blank only the name of the header file containing the class  
     122# definition is used. Otherwise one should specify the include paths that  
     123# are normally passed to the compiler using the -I flag. 
     124 
     125STRIP_FROM_INC_PATH    =  
     126 
     127# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter  
     128# (but less readable) file names. This can be useful is your file systems  
     129# doesn't support long names like on DOS, Mac, or CD-ROM. 
     130 
    18131SHORT_NAMES            = NO 
     132 
     133# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen  
     134# will interpret the first line (until the first dot) of a JavaDoc-style  
     135# comment as the brief description. If set to NO, the JavaDoc  
     136# comments will behave just like the Qt-style comments (thus requiring an  
     137# explicit @brief command for a brief description. 
     138 
    19139JAVADOC_AUTOBRIEF      = NO 
     140 
     141# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen  
     142# treat a multi-line C++ special comment block (i.e. a block of //! or ///  
     143# comments) as a brief description. This used to be the default behaviour.  
     144# The new default is to treat a multi-line C++ comment block as a detailed  
     145# description. Set this tag to YES if you prefer the old behaviour instead. 
     146 
    20147MULTILINE_CPP_IS_BRIEF = NO 
     148 
     149# If the DETAILS_AT_TOP tag is set to YES then Doxygen  
     150# will output the detailed description near the top, like JavaDoc. 
     151# If set to NO, the detailed description appears after the member  
     152# documentation. 
     153 
    21154DETAILS_AT_TOP         = NO 
     155 
     156# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented  
     157# member inherits the documentation from any documented member that it  
     158# re-implements. 
     159 
    22160INHERIT_DOCS           = YES 
     161 
     162# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce  
     163# a new page for each member. If set to NO, the documentation of a member will  
     164# be part of the file/class/namespace that contains it. 
     165 
     166SEPARATE_MEMBER_PAGES  = NO 
     167 
     168# The TAB_SIZE tag can be used to set the number of spaces in a tab.  
     169# Doxygen uses this value to replace tabs by spaces in code fragments. 
     170 
     171TAB_SIZE               = 4 
     172 
     173# This tag can be used to specify a number of aliases that acts  
     174# as commands in the documentation. An alias has the form "name=value".  
     175# For example adding "sideeffect=\par Side Effects:\n" will allow you to  
     176# put the command \sideeffect (or @sideeffect) in the documentation, which  
     177# will result in a user-defined paragraph with heading "Side Effects:".  
     178# You can put \n's in the value part of an alias to insert newlines. 
     179 
     180ALIASES                =  
     181 
     182# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C  
     183# sources only. Doxygen will then generate output that is more tailored for C.  
     184# For instance, some of the names that are used will be different. The list  
     185# of all members will be omitted, etc. 
     186 
     187OPTIMIZE_OUTPUT_FOR_C  = YES 
     188 
     189# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java  
     190# sources only. Doxygen will then generate output that is more tailored for Java.  
     191# For instance, namespaces will be presented as packages, qualified scopes  
     192# will look different, etc. 
     193 
     194OPTIMIZE_OUTPUT_JAVA   = NO 
     195 
     196# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to  
     197# include (a tag file for) the STL sources as input, then you should  
     198# set this tag to YES in order to let doxygen match functions declarations and  
     199# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.  
     200# func(std::string) {}). This also make the inheritance and collaboration  
     201# diagrams that involve STL classes more complete and accurate. 
     202 
     203BUILTIN_STL_SUPPORT    = NO 
     204 
     205# If you use Microsoft's C++/CLI language, you should set this option to YES to 
     206# enable parsing support. 
     207 
     208CPP_CLI_SUPPORT        = NO 
     209 
     210# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC  
     211# tag is set to YES, then doxygen will reuse the documentation of the first  
     212# member in the group (if any) for the other members of the group. By default  
     213# all members of a group must be documented explicitly. 
     214 
    23215DISTRIBUTE_GROUP_DOC   = NO 
    24 TAB_SIZE               = 4 
    25 ALIASES                =  
    26 OPTIMIZE_OUTPUT_FOR_C  = YES 
    27 OPTIMIZE_OUTPUT_JAVA   = NO 
     216 
     217# Set the SUBGROUPING tag to YES (the default) to allow class member groups of  
     218# the same type (for instance a group of public functions) to be put as a  
     219# subgroup of that type (e.g. under the Public Functions section). Set it to  
     220# NO to prevent subgrouping. Alternatively, this can be done per class using  
     221# the \nosubgrouping command. 
     222 
    28223SUBGROUPING            = YES 
     224 
    29225#--------------------------------------------------------------------------- 
    30226# Build related configuration options 
    31227#--------------------------------------------------------------------------- 
     228 
     229# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in  
     230# documentation are documented, even if no documentation was available.  
     231# Private class members and static file members will be hidden unless  
     232# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 
     233 
    32234EXTRACT_ALL            = NO 
     235 
     236# If the EXTRACT_PRIVATE tag is set to YES all private members of a class  
     237# will be included in the documentation. 
     238 
    33239EXTRACT_PRIVATE        = NO 
     240 
     241# If the EXTRACT_STATIC tag is set to YES all static members of a file  
     242# will be included in the documentation. 
     243 
    34244EXTRACT_STATIC         = YES 
     245 
     246# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)  
     247# defined locally in source files will be included in the documentation.  
     248# If set to NO only classes defined in header files are included. 
     249 
    35250EXTRACT_LOCAL_CLASSES  = YES 
     251 
     252# This flag is only useful for Objective-C code. When set to YES local  
     253# methods, which are defined in the implementation section but not in  
     254# the interface are included in the documentation.  
     255# If set to NO (the default) only methods in the interface are included. 
     256 
     257EXTRACT_LOCAL_METHODS  = NO 
     258 
     259# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all  
     260# undocumented members of documented classes, files or namespaces.  
     261# If set to NO (the default) these members will be included in the  
     262# various overviews, but no documentation section is generated.  
     263# This option has no effect if EXTRACT_ALL is enabled. 
     264 
    36265HIDE_UNDOC_MEMBERS     = NO 
     266 
     267# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all  
     268# undocumented classes that are normally visible in the class hierarchy.  
     269# If set to NO (the default) these classes will be included in the various  
     270# overviews. This option has no effect if EXTRACT_ALL is enabled. 
     271 
    37272HIDE_UNDOC_CLASSES     = NO 
     273 
     274# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all  
     275# friend (class|struct|union) declarations.  
     276# If set to NO (the default) these declarations will be included in the  
     277# documentation. 
     278 
    38279HIDE_FRIEND_COMPOUNDS  = NO 
     280 
     281# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any  
     282# documentation blocks found inside the body of a function.  
     283# If set to NO (the default) these blocks will be appended to the  
     284# function's detailed documentation block. 
     285 
    39286HIDE_IN_BODY_DOCS      = NO 
     287 
     288# The INTERNAL_DOCS tag determines if documentation  
     289# that is typed after a \internal command is included. If the tag is set  
     290# to NO (the default) then the documentation will be excluded.  
     291# Set it to YES to include the internal documentation. 
     292 
    40293INTERNAL_DOCS          = NO 
     294 
     295# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate  
     296# file names in lower-case letters. If set to YES upper-case letters are also  
     297# allowed. This is useful if you have classes or files whose names only differ  
     298# in case and if your file system supports case sensitive file names. Windows  
     299# and Mac users are advised to set this option to NO. 
     300 
    41301CASE_SENSE_NAMES       = YES 
     302 
     303# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen  
     304# will show members with their full class and namespace scopes in the  
     305# documentation. If set to YES the scope will be hidden. 
     306 
    42307HIDE_SCOPE_NAMES       = NO 
     308 
     309# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen  
     310# will put a list of the files that are included by a file in the documentation  
     311# of that file. 
     312 
    43313SHOW_INCLUDE_FILES     = YES 
     314 
     315# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]  
     316# is inserted in the documentation for inline members. 
     317 
    44318INLINE_INFO            = YES 
     319 
     320# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen  
     321# will sort the (detailed) documentation of file and class members  
     322# alphabetically by member name. If set to NO the members will appear in  
     323# declaration order. 
     324 
    45325SORT_MEMBER_DOCS       = YES 
     326 
     327# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the  
     328# brief documentation of file, namespace and class members alphabetically  
     329# by member name. If set to NO (the default) the members will appear in  
     330# declaration order. 
     331 
    46332SORT_BRIEF_DOCS        = NO 
     333 
     334# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be  
     335# sorted by fully-qualified names, including namespaces. If set to  
     336# NO (the default), the class list will be sorted only by class name,  
     337# not including the namespace part.  
     338# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 
     339# Note: This option applies only to the class list, not to the  
     340# alphabetical list. 
     341 
    47342SORT_BY_SCOPE_NAME     = NO 
     343 
     344# The GENERATE_TODOLIST tag can be used to enable (YES) or  
     345# disable (NO) the todo list. This list is created by putting \todo  
     346# commands in the documentation. 
     347 
    48348GENERATE_TODOLIST      = YES 
     349 
     350# The GENERATE_TESTLIST tag can be used to enable (YES) or  
     351# disable (NO) the test list. This list is created by putting \test  
     352# commands in the documentation. 
     353 
    49354GENERATE_TESTLIST      = YES 
     355 
     356# The GENERATE_BUGLIST tag can be used to enable (YES) or  
     357# disable (NO) the bug list. This list is created by putting \bug  
     358# commands in the documentation. 
     359 
    50360GENERATE_BUGLIST       = YES 
     361 
     362# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or  
     363# disable (NO) the deprecated list. This list is created by putting  
     364# \deprecated commands in the documentation. 
     365 
    51366GENERATE_DEPRECATEDLIST= YES 
     367 
     368# The ENABLED_SECTIONS tag can be used to enable conditional  
     369# documentation sections, marked by \if sectionname ... \endif. 
     370 
    52371ENABLED_SECTIONS       =  
     372 
     373# The MAX_INITIALIZER_LINES tag determines the maximum number of lines  
     374# the initial value of a variable or define consists of for it to appear in  
     375# the documentation. If the initializer consists of more lines than specified  
     376# here it will be hidden. Use a value of 0 to hide initializers completely.  
     377# The appearance of the initializer of individual variables and defines in the  
     378# documentation can be controlled using \showinitializer or \hideinitializer  
     379# command in the documentation regardless of this setting. 
     380 
    53381MAX_INITIALIZER_LINES  = 30 
     382 
     383# Set the SHOW_USED_FILES tag to NO to disable the list of files generated  
     384# at the bottom of the documentation of classes and structs. If set to YES the  
     385# list will mention the files that were used to generate the documentation. 
     386 
    54387SHOW_USED_FILES        = YES 
     388 
     389# If the sources in your project are distributed over multiple directories  
     390# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy  
     391# in the documentation. The default is NO. 
     392 
     393SHOW_DIRECTORIES       = NO 
     394 
     395# The FILE_VERSION_FILTER tag can be used to specify a program or script that  
     396# doxygen should invoke to get the current version for each file (typically from the  
     397# version control system). Doxygen will invoke the program by executing (via  
     398# popen()) the command <command> <input-file>, where <command> is the value of  
     399# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file  
     400# provided by doxygen. Whatever the program writes to standard output  
     401# is used as the file version. See the manual for examples. 
     402 
     403FILE_VERSION_FILTER    =  
     404 
    55405#--------------------------------------------------------------------------- 
    56406# configuration options related to warning and progress messages 
    57407#--------------------------------------------------------------------------- 
     408 
     409# The QUIET tag can be used to turn on/off the messages that are generated  
     410# by doxygen. Possible values are YES and NO. If left blank NO is used. 
     411 
    58412QUIET                  = NO 
     413 
     414# The WARNINGS tag can be used to turn on/off the warning messages that are  
     415# generated by doxygen. Possible values are YES and NO. If left blank  
     416# NO is used. 
     417 
    59418WARNINGS               = YES 
     419 
     420# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings  
     421# for undocumented members. If EXTRACT_ALL is set to YES then this flag will  
     422# automatically be disabled. 
     423 
    60424WARN_IF_UNDOCUMENTED   = YES 
     425 
     426# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for  
     427# potential errors in the documentation, such as not documenting some  
     428# parameters in a documented function, or documenting parameters that  
     429# don't exist or using markup commands wrongly. 
     430 
    61431WARN_IF_DOC_ERROR      = YES 
     432 
     433# This WARN_NO_PARAMDOC option can be abled to get warnings for  
     434# functions that are documented, but have no documentation for their parameters  
     435# or return value. If set to NO (the default) doxygen will only warn about  
     436# wrong or incomplete parameter documentation, but not about the absence of  
     437# documentation. 
     438 
     439WARN_NO_PARAMDOC       = NO 
     440 
     441# The WARN_FORMAT tag determines the format of the warning messages that  
     442# doxygen can produce. The string should contain the $file, $line, and $text  
     443# tags, which will be replaced by the file and line number from which the  
     444# warning originated and the warning text. Optionally the format may contain  
     445# $version, which will be replaced by the version of the file (if it could  
     446# be obtained via FILE_VERSION_FILTER) 
     447 
    62448WARN_FORMAT            = "$file:$line: $text" 
     449 
     450# The WARN_LOGFILE tag can be used to specify a file to which warning  
     451# and error messages should be written. If left blank the output is written  
     452# to stderr. 
     453 
    63454WARN_LOGFILE           =  
     455 
    64456#--------------------------------------------------------------------------- 
    65457# configuration options related to the input files 
    66458#--------------------------------------------------------------------------- 
     459 
     460# The INPUT tag can be used to specify the files and/or directories that contain  
     461# documented source files. You may enter file names like "myfile.cpp" or  
     462# directories like "/usr/src/myproject". Separate the files or directories  
     463# with spaces. 
     464 
    67465INPUT                  = ../src 
     466 
     467# This tag can be used to specify the character encoding of the source files that  
     468# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default  
     469# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.  
     470# See http://www.gnu.org/software/libiconv for the list of possible encodings. 
     471 
     472INPUT_ENCODING         = UTF-8 
     473 
     474# If the value of the INPUT tag contains directories, you can use the  
     475# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp  
     476# and *.h) to filter out the source-files in the directories. If left  
     477# blank the following patterns are tested:  
     478# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx  
     479# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py 
     480 
    68481FILE_PATTERNS          =  
     482 
     483# The RECURSIVE tag can be used to turn specify whether or not subdirectories  
     484# should be searched for input files as well. Possible values are YES and NO.  
     485# If left blank NO is used. 
     486 
    69487RECURSIVE              = YES 
     488 
     489# The EXCLUDE tag can be used to specify files and/or directories that should  
     490# excluded from the INPUT source files. This way you can easily exclude a  
     491# subdirectory from a directory tree whose root is specified with the INPUT tag. 
     492 
    70493EXCLUDE                =  
     494 
     495# The EXCLUDE_SYMLINKS tag can be used select whether or not files or  
     496# directories that are symbolic links (a Unix filesystem feature) are excluded  
     497# from the input. 
     498 
    71499EXCLUDE_SYMLINKS       = NO 
     500 
     501# If the value of the INPUT tag contains directories, you can use the  
     502# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude  
     503# certain files from those directories. Note that the wildcards are matched  
     504# against the file with absolute path, so to exclude all test directories  
     505# for example use the pattern */test/* 
     506 
    72507EXCLUDE_PATTERNS       =  
     508 
     509# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names  
     510# (namespaces, classes, functions, etc.) that should be excluded from the output.  
     511# The symbol name can be a fully qualified name, a word, or if the wildcard * is used,  
     512# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test 
     513 
     514EXCLUDE_SYMBOLS        =  
     515 
     516# The EXAMPLE_PATH tag can be used to specify one or more files or  
     517# directories that contain example code fragments that are included (see  
     518# the \include command). 
     519 
    73520EXAMPLE_PATH           =  
     521 
     522# If the value of the EXAMPLE_PATH tag contains directories, you can use the  
     523# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp  
     524# and *.h) to filter out the source-files in the directories. If left  
     525# blank all files are included. 
     526 
    74527EXAMPLE_PATTERNS       =  
     528 
     529# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be  
     530# searched for input files to be used with the \include or \dontinclude  
     531# commands irrespective of the value of the RECURSIVE tag.  
     532# Possible values are YES and NO. If left blank NO is used. 
     533 
    75534EXAMPLE_RECURSIVE      = NO 
     535 
     536# The IMAGE_PATH tag can be used to specify one or more files or  
     537# directories that contain image that are included in the documentation (see  
     538# the \image command). 
     539 
    76540IMAGE_PATH             =  
    77 INPUT_FILTER           = "iconv -c -f UTF8 -t SHIFT_JIS" 
     541 
     542# The INPUT_FILTER tag can be used to specify a program that doxygen should  
     543# invoke to filter for each input file. Doxygen will invoke the filter program  
     544# by executing (via popen()) the command <filter> <input-file>, where <filter>  
     545# is the value of the INPUT_FILTER tag, and <input-file> is the name of an  
     546# input file. Doxygen will then use the output that the filter program writes  
     547# to standard output.  If FILTER_PATTERNS is specified, this tag will be  
     548# ignored. 
     549 
     550INPUT_FILTER           = 
     551 
     552# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern  
     553# basis.  Doxygen will compare the file name with each pattern and apply the  
     554# filter if there is a match.  The filters are a list of the form:  
     555# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further  
     556# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER  
     557# is applied to all files. 
     558 
     559FILTER_PATTERNS        =  
     560 
     561# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using  
     562# INPUT_FILTER) will be used to filter the input files when producing source  
     563# files to browse (i.e. when SOURCE_BROWSER is set to YES). 
     564 
    78565FILTER_SOURCE_FILES    = YES 
     566 
    79567#--------------------------------------------------------------------------- 
    80568# configuration options related to source browsing 
    81569#--------------------------------------------------------------------------- 
     570 
     571# If the SOURCE_BROWSER tag is set to YES then a list of source files will  
     572# be generated. Documented entities will be cross-referenced with these sources.  
     573# Note: To get rid of all source code in the generated output, make sure also  
     574# VERBATIM_HEADERS is set to NO. 
     575 
    82576SOURCE_BROWSER         = NO 
     577 
     578# Setting the INLINE_SOURCES tag to YES will include the body  
     579# of functions and classes directly in the documentation. 
     580 
    83581INLINE_SOURCES         = NO 
     582 
     583# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct  
     584# doxygen to hide any special comment blocks from generated source code  
     585# fragments. Normal C and C++ comments will always remain visible. 
     586 
    84587STRIP_CODE_COMMENTS    = YES 
     588 
     589# If the REFERENCED_BY_RELATION tag is set to YES (the default)  
     590# then for each documented function all documented  
     591# functions referencing it will be listed. 
     592 
    85593REFERENCED_BY_RELATION = YES 
     594 
     595# If the REFERENCES_RELATION tag is set to YES (the default)  
     596# then for each documented function all documented entities  
     597# called/used by that function will be listed. 
     598 
    86599REFERENCES_RELATION    = YES 
     600 
     601# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 
     602# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 
     603# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 
     604# link to the source code.  Otherwise they will link to the documentstion. 
     605 
     606REFERENCES_LINK_SOURCE = YES 
     607 
     608# If the USE_HTAGS tag is set to YES then the references to source code  
     609# will point to the HTML generated by the htags(1) tool instead of doxygen  
     610# built-in source browser. The htags tool is part of GNU's global source  
     611# tagging system (see http://www.gnu.org/software/global/global.html). You  
     612# will need version 4.8.6 or higher. 
     613 
     614USE_HTAGS              = NO 
     615 
     616# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen  
     617# will generate a verbatim copy of the header file for each class for  
     618# which an include is specified. Set to NO to disable this. 
     619 
    87620VERBATIM_HEADERS       = YES 
     621 
    88622#--------------------------------------------------------------------------- 
    89623# configuration options related to the alphabetical class index 
    90624#--------------------------------------------------------------------------- 
     625 
     626# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index  
     627# of all compounds will be generated. Enable this if the project  
     628# contains a lot of classes, structs, unions or interfaces. 
     629 
    91630ALPHABETICAL_INDEX     = NO 
     631 
     632# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then  
     633# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns  
     634# in which this list will be split (can be a number in the range [1..20]) 
     635 
    92636COLS_IN_ALPHA_INDEX    = 5 
     637 
     638# In case all classes in a project start with a common prefix, all  
     639# classes will be put under the same header in the alphabetical index.  
     640# The IGNORE_PREFIX tag can be used to specify one or more prefixes that  
     641# should be ignored while generating the index headers. 
     642 
    93643IGNORE_PREFIX          =  
     644 
    94645#--------------------------------------------------------------------------- 
    95646# configuration options related to the HTML output 
    96647#--------------------------------------------------------------------------- 
     648 
     649# If the GENERATE_HTML tag is set to YES (the default) Doxygen will  
     650# generate HTML output. 
     651 
    97652GENERATE_HTML          = YES 
     653 
     654# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.  
     655# If a relative path is entered the value of OUTPUT_DIRECTORY will be  
     656# put in front of it. If left blank `html' will be used as the default path. 
     657 
    98658HTML_OUTPUT            = html 
     659 
     660# The HTML_FILE_EXTENSION tag can be used to specify the file extension for  
     661# each generated HTML page (for example: .htm,.php,.asp). If it is left blank  
     662# doxygen will generate files with .html extension. 
     663 
    99664HTML_FILE_EXTENSION    = .html 
     665 
     666# The HTML_HEADER tag can be used to specify a personal HTML header for  
     667# each generated HTML page. If it is left blank doxygen will generate a  
     668# standard header. 
     669 
    100670HTML_HEADER            =  
     671 
     672# The HTML_FOOTER tag can be used to specify a personal HTML footer for  
     673# each generated HTML page. If it is left blank doxygen will generate a  
     674# standard footer. 
     675 
    101676HTML_FOOTER            =  
     677 
     678# The HTML_STYLESHEET tag can be used to specify a user-defined cascading  
     679# style sheet that is used by each HTML page. It can be used to  
     680# fine-tune the look of the HTML output. If the tag is left blank doxygen  
     681# will generate a default style sheet. Note that doxygen will try to copy  
     682# the style sheet file to the HTML output directory, so don't put your own  
     683# stylesheet in the HTML output directory as well, or it will be erased! 
     684 
    102685HTML_STYLESHEET        =  
     686 
     687# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,  
     688# files or namespaces will be aligned in HTML using tables. If set to  
     689# NO a bullet list will be used. 
     690 
    103691HTML_ALIGN_MEMBERS     = YES 
     692 
     693# If the GENERATE_HTMLHELP tag is set to YES, additional index files  
     694# will be generated that can be used as input for tools like the  
     695# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)  
     696# of the generated HTML documentation. 
     697 
    104698GENERATE_HTMLHELP      = NO 
     699 
     700# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can  
     701# be used to specify the file name of the resulting .chm file. You  
     702# can add a path in front of the file if the result should not be  
     703# written to the html output directory. 
     704 
    105705CHM_FILE               =  
     706 
     707# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can  
     708# be used to specify the location (absolute path including file name) of  
     709# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run  
     710# the HTML help compiler on the generated index.hhp. 
     711 
    106712HHC_LOCATION           =  
     713 
     714# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag  
     715# controls if a separate .chi index file is generated (YES) or that  
     716# it should be included in the master .chm file (NO). 
     717 
    107718GENERATE_CHI           = NO 
     719 
     720# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag  
     721# controls whether a binary table of contents is generated (YES) or a  
     722# normal table of contents (NO) in the .chm file. 
     723 
    108724BINARY_TOC             = NO 
     725 
     726# The TOC_EXPAND flag can be set to YES to add extra items for group members  
     727# to the contents of the HTML help documentation and to the tree view. 
     728 
    109729TOC_EXPAND             = NO 
     730 
     731# The DISABLE_INDEX tag can be used to turn on/off the condensed index at  
     732# top of each HTML page. The value NO (the default) enables the index and  
     733# the value YES disables it. 
     734 
    110735DISABLE_INDEX          = NO 
     736 
     737# This tag can be used to set the number of enum values (range [1..20])  
     738# that doxygen will group on one line in the generated HTML documentation. 
     739 
    111740ENUM_VALUES_PER_LINE   = 4 
     741 
     742# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 
     743# generated containing a tree-like index structure (just like the one that  
     744# is generated for HTML Help). For this to work a browser that supports  
     745# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,  
     746# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are  
     747# probably better off using the HTML help feature. 
     748 
    112749GENERATE_TREEVIEW      = NO 
     750 
     751# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be  
     752# used to set the initial width (in pixels) of the frame in which the tree  
     753# is shown. 
     754 
    113755TREEVIEW_WIDTH         = 250 
     756 
    114757#--------------------------------------------------------------------------- 
    115758# configuration options related to the LaTeX output 
    116759#--------------------------------------------------------------------------- 
     760 
     761# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will  
     762# generate Latex output. 
     763 
    117764GENERATE_LATEX         = NO 
     765 
     766# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.  
     767# If a relative path is entered the value of OUTPUT_DIRECTORY will be  
     768# put in front of it. If left blank `latex' will be used as the default path. 
     769 
    118770LATEX_OUTPUT           = latex 
     771 
     772# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be  
     773# invoked. If left blank `latex' will be used as the default command name. 
     774 
    119775LATEX_CMD_NAME         = latex 
     776 
     777# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to  
     778# generate index for LaTeX. If left blank `makeindex' will be used as the  
     779# default command name. 
     780 
    120781MAKEINDEX_CMD_NAME     = makeindex 
     782 
     783# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact  
     784# LaTeX documents. This may be useful for small projects and may help to  
     785# save some trees in general. 
     786 
    121787COMPACT_LATEX          = NO 
     788 
     789# The PAPER_TYPE tag can be used to set the paper type that is used  
     790# by the printer. Possible values are: a4, a4wide, letter, legal and  
     791# executive. If left blank a4wide will be used. 
     792 
    122793PAPER_TYPE             = a4wide 
     794 
     795# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX  
     796# packages that should be included in the LaTeX output. 
     797 
    123798EXTRA_PACKAGES         =  
     799 
     800# The LATEX_HEADER tag can be used to specify a personal LaTeX header for  
     801# the generated latex document. The header should contain everything until  
     802# the first chapter. If it is left blank doxygen will generate a  
     803# standard header. Notice: only use this tag if you know what you are doing! 
     804 
    124805LATEX_HEADER           =  
     806 
     807# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated  
     808# is prepared for conversion to pdf (using ps2pdf). The pdf file will  
     809# contain links (just like the HTML output) instead of page references  
     810# This makes the output suitable for online browsing using a pdf viewer. 
     811 
    125812PDF_HYPERLINKS         = NO 
     813 
     814# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of  
     815# plain latex in the generated Makefile. Set this option to YES to get a  
     816# higher quality PDF documentation. 
     817 
    126818USE_PDFLATEX           = NO 
     819 
     820# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.  
     821# command to the generated LaTeX files. This will instruct LaTeX to keep  
     822# running if errors occur, instead of asking the user for help.  
     823# This option is also used when generating formulas in HTML. 
     824 
    127825LATEX_BATCHMODE        = NO 
     826 
     827# If LATEX_HIDE_INDICES is set to YES then doxygen will not  
     828# include the index chapters (such as File Index, Compound Index, etc.)  
     829# in the output. 
     830 
    128831LATEX_HIDE_INDICES     = NO 
     832 
    129833#--------------------------------------------------------------------------- 
    130834# configuration options related to the RTF output 
    131835#--------------------------------------------------------------------------- 
     836 
     837# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output  
     838# The RTF output is optimized for Word 97 and may not look very pretty with  
     839# other RTF readers or editors. 
     840 
    132841GENERATE_RTF           = NO 
     842 
     843# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.  
     844# If a relative path is entered the value of OUTPUT_DIRECTORY will be  
     845# put in front of it. If left blank `rtf' will be used as the default path. 
     846 
    133847RTF_OUTPUT             = rtf 
     848 
     849# If the COMPACT_RTF tag is set to YES Doxygen generates more compact  
     850# RTF documents. This may be useful for small projects and may help to  
     851# save some trees in general. 
     852 
    134853COMPACT_RTF            = NO 
     854 
     855# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated  
     856# will contain hyperlink fields. The RTF file will  
     857# contain links (just like the HTML output) instead of page references.  
     858# This makes the output suitable for online browsing using WORD or other  
     859# programs which support those fields.  
     860# Note: wordpad (write) and others do not support links. 
     861 
    135862RTF_HYPERLINKS         = NO 
     863 
     864# Load stylesheet definitions from file. Syntax is similar to doxygen's  
     865# config file, i.e. a series of assignments. You only have to provide  
     866# replacements, missing definitions are set to their default value. 
     867 
    136868RTF_STYLESHEET_FILE    =  
     869 
     870# Set optional variables used in the generation of an rtf document.  
     871# Syntax is similar to doxygen's config file. 
     872 
    137873RTF_EXTENSIONS_FILE    =  
     874 
    138875#--------------------------------------------------------------------------- 
    139876# configuration options related to the man page output 
    140877#--------------------------------------------------------------------------- 
     878 
     879# If the GENERATE_MAN tag is set to YES (the default) Doxygen will  
     880# generate man pages 
     881 
    141882GENERATE_MAN           = NO 
     883 
     884# The MAN_OUTPUT tag is used to specify where the man pages will be put.  
     885# If a relative path is entered the value of OUTPUT_DIRECTORY will be  
     886# put in front of it. If left blank `man' will be used as the default path. 
     887 
    142888MAN_OUTPUT             = man 
     889 
     890# The MAN_EXTENSION tag determines the extension that is added to  
     891# the generated man pages (default is the subroutine's section .3) 
     892 
    143893MAN_EXTENSION          = .3 
     894 
     895# If the MAN_LINKS tag is set to YES and Doxygen generates man output,  
     896# then it will generate one additional man file for each entity  
     897# documented in the real man page(s). These additional files  
     898# only source the real man page, but without them the man command  
     899# would be unable to find the correct page. The default is NO. 
     900 
    144901MAN_LINKS              = NO 
     902 
    145903#--------------------------------------------------------------------------- 
    146904# configuration options related to the XML output 
    147905#--------------------------------------------------------------------------- 
     906 
     907# If the GENERATE_XML tag is set to YES Doxygen will  
     908# generate an XML file that captures the structure of  
     909# the code including all documentation. 
     910 
    148911GENERATE_XML           = NO 
     912 
     913# The XML_OUTPUT tag is used to specify where the XML pages will be put.  
     914# If a relative path is entered the value of OUTPUT_DIRECTORY will be  
     915# put in front of it. If left blank `xml' will be used as the default path. 
     916 
    149917XML_OUTPUT             = xml 
     918 
     919# The XML_SCHEMA tag can be used to specify an XML schema,  
     920# which can be used by a validating XML parser to check the  
     921# syntax of the XML files. 
     922 
    150923XML_SCHEMA             =  
     924 
     925# The XML_DTD tag can be used to specify an XML DTD,  
     926# which can be used by a validating XML parser to check the  
     927# syntax of the XML files. 
     928 
    151929XML_DTD                =  
     930 
     931# If the XML_PROGRAMLISTING tag is set to YES Doxygen will  
     932# dump the program listings (including syntax highlighting  
     933# and cross-referencing information) to the XML output. Note that  
     934# enabling this will significantly increase the size of the XML output. 
     935 
    152936XML_PROGRAMLISTING     = YES 
     937 
    153938#--------------------------------------------------------------------------- 
    154939# configuration options for the AutoGen Definitions output 
    155940#--------------------------------------------------------------------------- 
     941 
     942# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will  
     943# generate an AutoGen Definitions (see autogen.sf.net) file  
     944# that captures the structure of the code including all  
     945# documentation. Note that this feature is still experimental  
     946# and incomplete at the moment. 
     947 
    156948GENERATE_AUTOGEN_DEF   = NO 
     949 
    157950#--------------------------------------------------------------------------- 
    158951# configuration options related to the Perl module output 
    159952#--------------------------------------------------------------------------- 
     953 
     954# If the GENERATE_PERLMOD tag is set to YES Doxygen will  
     955# generate a Perl module file that captures the structure of  
     956# the code including all documentation. Note that this  
     957# feature is still experimental and incomplete at the  
     958# moment. 
     959 
    160960GENERATE_PERLMOD       = NO 
     961 
     962# If the PERLMOD_LATEX tag is set to YES Doxygen will generate  
     963# the necessary Makefile rules, Perl scripts and LaTeX code to be able  
     964# to generate PDF and DVI output from the Perl module output. 
     965 
    161966PERLMOD_LATEX          = NO 
     967 
     968# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be  
     969# nicely formatted so it can be parsed by a human reader.  This is useful  
     970# if you want to understand what is going on.  On the other hand, if this  
     971# tag is set to NO the size of the Perl module output will be much smaller  
     972# and Perl will parse it just the same. 
     973 
    162974PERLMOD_PRETTY         = YES 
     975 
     976# The names of the make variables in the generated doxyrules.make file  
     977# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.  
     978# This is useful so different doxyrules.make files included by the same  
     979# Makefile don't overwrite each other's variables. 
     980 
    163981PERLMOD_MAKEVAR_PREFIX =  
     982 
    164983#--------------------------------------------------------------------------- 
    165984# Configuration options related to the preprocessor    
    166985#--------------------------------------------------------------------------- 
     986 
     987# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will  
     988# evaluate all C-preprocessor directives found in the sources and include  
     989# files. 
     990 
    167991ENABLE_PREPROCESSING   = YES 
     992 
     993# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro  
     994# names in the source code. If set to NO (the default) only conditional  
     995# compilation will be performed. Macro expansion can be done in a controlled  
     996# way by setting EXPAND_ONLY_PREDEF to YES. 
     997 
    168998MACRO_EXPANSION        = NO 
     999 
     1000# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES  
     1001# then the macro expansion is limited to the macros specified with the  
     1002# PREDEFINED and EXPAND_AS_DEFINED tags. 
     1003 
    1691004EXPAND_ONLY_PREDEF     = NO 
     1005 
     1006# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files  
     1007# in the INCLUDE_PATH (see below) will be search if a #include is found. 
     1008 
    1701009SEARCH_INCLUDES        = YES 
     1010 
     1011# The INCLUDE_PATH tag can be used to specify one or more directories that  
     1012# contain include files that are not input files but should be processed by  
     1013# the preprocessor. 
     1014 
    1711015INCLUDE_PATH           =  
     1016 
     1017# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard  
     1018# patterns (like *.h and *.hpp) to filter out the header-files in the  
     1019# directories. If left blank, the patterns specified with FILE_PATTERNS will  
     1020# be used. 
     1021 
    1721022INCLUDE_FILE_PATTERNS  =  
     1023 
     1024# The PREDEFINED tag can be used to specify one or more macro names that  
     1025# are defined before the preprocessor is started (similar to the -D option of  
     1026# gcc). The argument of the tag is a list of macros of the form: name  
     1027# or name=definition (no spaces). If the definition and the = are  
     1028# omitted =1 is assumed. To prevent a macro definition from being  
     1029# undefined via #undef or recursively expanded use the := operator  
     1030# instead of the = operator. 
     1031 
    1731032PREDEFINED             =  
     1033 
     1034# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then  
     1035# this tag can be used to specify a list of macro names that should be expanded.  
     1036# The macro definition that is found in the sources will be used.  
     1037# Use the PREDEFINED tag if you want to use a different macro definition. 
     1038 
    1741039EXPAND_AS_DEFINED      =  
     1040 
     1041# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then  
     1042# doxygen's preprocessor will remove all function-like macros that are alone  
     1043# on a line, have an all uppercase name, and do not end with a semicolon. Such  
     1044# function macros are typically used for boiler-plate code, and will confuse  
     1045# the parser if not removed. 
     1046 
    1751047SKIP_FUNCTION_MACROS   = YES 
     1048 
    1761049#--------------------------------------------------------------------------- 
    1771050# Configuration::additions related to external references    
    1781051#--------------------------------------------------------------------------- 
     1052 
     1053# The TAGFILES option can be used to specify one or more tagfiles.  
     1054# Optionally an initial location of the external documentation  
     1055# can be added for each tagfile. The format of a tag file without  
     1056# this location is as follows:  
     1057#   TAGFILES = file1 file2 ...  
     1058# Adding location for the tag files is done as follows:  
     1059#   TAGFILES = file1=loc1 "file2 = loc2" ...  
     1060# where "loc1" and "loc2" can be relative or absolute paths or  
     1061# URLs. If a location is present for each tag, the installdox tool  
     1062# does not have to be run to correct the links. 
     1063# Note that each tag file must have a unique name 
     1064# (where the name does NOT include the path) 
     1065# If a tag file is not located in the directory in which doxygen  
     1066# is run, you must also specify the path to the tagfile here. 
     1067 
    1791068TAGFILES               =  
     1069 
     1070# When a file name is specified after GENERATE_TAGFILE, doxygen will create  
     1071# a tag file that is based on the input files it reads. 
     1072 
    1801073GENERATE_TAGFILE       =  
     1074 
     1075# If the ALLEXTERNALS tag is set to YES all external classes will be listed  
     1076# in the class index. If set to NO only the inherited external classes  
     1077# will be listed. 
     1078 
    1811079ALLEXTERNALS           = NO 
     1080 
     1081# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed  
     1082# in the modules index. If set to NO, only the current project's groups will  
     1083# be listed. 
     1084 
    1821085EXTERNAL_GROUPS        = YES 
     1086 
     1087# The PERL_PATH should be the absolute path and name of the perl script  
     1088# interpreter (i.e. the result of `which perl'). 
     1089 
    1831090PERL_PATH              = /usr/bin/perl 
     1091 
    1841092#--------------------------------------------------------------------------- 
    1851093# Configuration options related to the dot tool    
    1861094#--------------------------------------------------------------------------- 
     1095 
     1096# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will  
     1097# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base  
     1098# or super classes. Setting the tag to NO turns the diagrams off. Note that  
     1099# this option is superseded by the HAVE_DOT option below. This is only a  
     1100# fallback. It is recommended to install and use dot, since it yields more  
     1101# powerful graphs. 
     1102 
    1871103CLASS_DIAGRAMS         = YES 
     1104 
     1105# You can define message sequence charts within doxygen comments using the \msc  
     1106# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to  
     1107# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to  
     1108# specify the directory where the mscgen tool resides. If left empty the tool is assumed to  
     1109# be found in the default search path. 
     1110 
     1111MSCGEN_PATH            =  
     1112 
     1113# If set to YES, the inheritance and collaboration graphs will hide  
     1114# inheritance and usage relations if the target is undocumented  
     1115# or is not a class. 
     1116 
    1881117HIDE_UNDOC_RELATIONS   = YES 
     1118 
     1119# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is  
     1120# available from the path. This tool is part of Graphviz, a graph visualization  
     1121# toolkit from AT&T and Lucent Bell Labs. The other options in this section  
     1122# have no effect if this option is set to NO (the default) 
     1123 
    1891124HAVE_DOT               = YES 
     1125 
     1126# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen  
     1127# will generate a graph for each documented class showing the direct and  
     1128# indirect inheritance relations. Setting this tag to YES will force the  
     1129# the CLASS_DIAGRAMS tag to NO. 
     1130 
    1901131CLASS_GRAPH            = YES 
     1132 
     1133# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen  
     1134# will generate a graph for each documented class showing the direct and  
     1135# indirect implementation dependencies (inheritance, containment, and  
     1136# class references variables) of the class with other documented classes. 
     1137 
    1911138COLLABORATION_GRAPH    = YES 
     1139 
     1140# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen  
     1141# will generate a graph for groups, showing the direct groups dependencies 
     1142 
     1143GROUP_GRAPHS           = YES 
     1144 
     1145# If the UML_LOOK tag is set to YES doxygen will generate inheritance and  
     1146# collaboration diagrams in a style similar to the OMG's Unified Modeling  
     1147# Language. 
     1148 
    1921149UML_LOOK               = NO 
     1150 
     1151# If set to YES, the inheritance and collaboration graphs will show the  
     1152# relations between templates and their instances. 
     1153 
    1931154TEMPLATE_RELATIONS     = NO 
     1155 
     1156# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT  
     1157# tags are set to YES then doxygen will generate a graph for each documented  
     1158# file showing the direct and indirect include dependencies of the file with  
     1159# other documented files. 
     1160 
    1941161INCLUDE_GRAPH          = NO 
     1162 
     1163# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and  
     1164# HAVE_DOT tags are set to YES then doxygen will generate a graph for each  
     1165# documented header file showing the documented files that directly or  
     1166# indirectly include this file. 
     1167 
    1951168INCLUDED_BY_GRAPH      = NO 
     1169 
     1170# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will  
     1171# generate a call dependency graph for every global function or class method.  
     1172# Note that enabling this option will significantly increase the time of a run.  
     1173# So in most cases it will be better to enable call graphs for selected  
     1174# functions only using the \callgraph command. 
     1175 
    1961176CALL_GRAPH             = YES 
     1177 
     1178# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will  
     1179# generate a caller dependency graph for every global function or class method.  
     1180# Note that enabling this option will significantly increase the time of a run.  
     1181# So in most cases it will be better to enable caller graphs for selected  
     1182# functions only using the \callergraph command. 
     1183 
     1184CALLER_GRAPH           = NO 
     1185 
     1186# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen  
     1187# will graphical hierarchy of all classes instead of a textual one. 
     1188 
    1971189GRAPHICAL_HIERARCHY    = NO 
     1190 
     1191# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES  
     1192# then doxygen will show the dependencies a directory has on other directories  
     1193# in a graphical way. The dependency relations are determined by the #include 
     1194# relations between the files in the directories. 
     1195 
     1196DIRECTORY_GRAPH        = YES 
     1197 
     1198# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images  
     1199# generated by dot. Possible values are png, jpg, or gif 
     1200# If left blank png will be used. 
     1201 
    1981202DOT_IMAGE_FORMAT       = png 
     1203 
     1204# The tag DOT_PATH can be used to specify the path where the dot tool can be  
     1205# found. If left blank, it is assumed the dot tool can be found in the path. 
     1206 
    1991207DOT_PATH               =  
     1208 
     1209# The DOTFILE_DIRS tag can be used to specify one or more directories that  
     1210# contain dot files that are included in the documentation (see the  
     1211# \dotfile command). 
     1212 
    2001213DOTFILE_DIRS           =  
    201 MAX_DOT_GRAPH_WIDTH    = 1024 
    202 MAX_DOT_GRAPH_HEIGHT   = 1024 
    203 MAX_DOT_GRAPH_DEPTH    = 0 
     1214 
     1215# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of  
     1216# nodes that will be shown in the graph. If the number of nodes in a graph  
     1217# becomes larger than this value, doxygen will truncate the graph, which is  
     1218# visualized by representing a node as a red box. Note that doxygen will always  
     1219# show the root nodes and its direct children regardless of this setting. 
     1220 
     1221DOT_GRAPH_MAX_NODES    = 50 
     1222 
     1223# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent  
     1224# background. This is disabled by default, which results in a white background.  
     1225# Warning: Depending on the platform used, enabling this option may lead to  
     1226# badly anti-aliased labels on the edges of a graph (i.e. they become hard to  
     1227# read). 
     1228 
     1229DOT_TRANSPARENT        = NO 
     1230 
     1231# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output  
     1232# files in one run (i.e. multiple -o and -T options on the command line). This  
     1233# makes dot run faster, but since only newer versions of dot (>1.8.10)  
     1234# support this, this feature is disabled by default. 
     1235 
     1236DOT_MULTI_TARGETS      = NO 
     1237 
     1238# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will  
     1239# generate a legend page explaining the meaning of the various boxes and  
     1240# arrows in the dot generated graphs. 
     1241 
    2041242GENERATE_LEGEND        = YES 
     1243 
     1244# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will  
     1245# remove the intermediate dot files that are used to generate  
     1246# the various graphs. 
     1247 
    2051248DOT_CLEANUP            = YES 
     1249 
    2061250#--------------------------------------------------------------------------- 
    2071251# Configuration::additions related to the search engine    
    2081252#--------------------------------------------------------------------------- 
     1253 
     1254# The SEARCHENGINE tag specifies whether or not a search engine should be  
     1255# used. If set to NO the values of all tags below this one will be ignored. 
     1256 
    2091257SEARCHENGINE           = NO 
Note: See TracChangeset for help on using the changeset viewer.