1. Summary
  2. Files
  3. Support
  4. Report Spam
  5. Create account
  6. Log in

Changeset 4094

Show
Ignore:
Timestamp:
03/23/12 14:40:10 (14 months ago)
Author:
oscim
Message:

Mise a niveau du Doxyfile du Frontoffice

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • trunk/doc/Frontoffice/Doxyfile

    r3797 r4094  
    1 # Doxyfile 1.5.6 
     1# Doxyfile 1.7.4 
     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  
     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 
    623DOXYFILE_ENCODING      = UTF-8 
    7 PROJECT_NAME           = oscss 
    8 PROJECT_NUMBER         = 2.1.0RC 
    9 OUTPUT_DIRECTORY       = 
     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 
     28PROJECT_NAME           = osCSS 
     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 
     34PROJECT_NUMBER         = 2.1.1RC 
     35 
     36# Using the PROJECT_BRIEF tag one can provide an optional one line description  
     37# for a project that appears at the top of each page and should give viewer  
     38# a quick idea about the purpose of the project. Keep the description short. 
     39 
     40PROJECT_BRIEF          = "e-shop OpenSource Xhtml/Html5 Full Css compliance" 
     41 
     42# With the PROJECT_LOGO tag one can specify an logo or icon that is  
     43# included in the documentation. The maximum height of the logo should not  
     44# exceed 55 pixels and the maximum width should not exceed 200 pixels.  
     45# Doxygen will copy the logo to the output directory. 
     46 
     47PROJECT_LOGO           =  
     48 
     49# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)  
     50# base path where the generated documentation will be put.  
     51# If a relative path is entered, it will be relative to the location  
     52# where doxygen was started. If left blank the current directory will be used. 
     53 
     54OUTPUT_DIRECTORY       =  
     55 
     56# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create  
     57# 4096 sub-directories (in 2 levels) under the output directory of each output  
     58# format and will distribute the generated files over these directories.  
     59# Enabling this option can be useful when feeding doxygen a huge amount of  
     60# source files, where putting all generated files in the same directory would  
     61# otherwise cause performance problems for the file system. 
     62 
    1063CREATE_SUBDIRS         = NO 
     64 
     65# The OUTPUT_LANGUAGE tag is used to specify the language in which all  
     66# documentation generated by doxygen is written. Doxygen will use this  
     67# information to generate all constant output in the proper language.  
     68# The default language is English, other supported languages are:  
     69# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,  
     70# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,  
     71# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English  
     72# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,  
     73# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,  
     74# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 
     75 
    1176OUTPUT_LANGUAGE        = English 
     77 
     78# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will  
     79# include brief member descriptions after the members that are listed in  
     80# the file and class documentation (similar to JavaDoc).  
     81# Set to NO to disable this. 
     82 
    1283BRIEF_MEMBER_DESC      = YES 
     84 
     85# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend  
     86# the brief description of a member or function before the detailed description.  
     87# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the  
     88# brief descriptions will be completely suppressed. 
     89 
    1390REPEAT_BRIEF           = YES 
     91 
     92# This tag implements a quasi-intelligent brief description abbreviator  
     93# that is used to form the text in various listings. Each string  
     94# in this list, if found as the leading text of the brief description, will be  
     95# stripped from the text and the result after processing the whole list, is  
     96# used as the annotated text. Otherwise, the brief description is used as-is.  
     97# If left blank, the following values are used ("$name" is automatically  
     98# replaced with the name of the entity): "The $name class" "The $name widget"  
     99# "The $name file" "is" "provides" "specifies" "contains"  
     100# "represents" "a" "an" "the" 
     101 
    14102ABBREVIATE_BRIEF       = YES 
     103 
     104# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then  
     105# Doxygen will generate a detailed section even if there is only a brief  
     106# description. 
     107 
    15108ALWAYS_DETAILED_SEC    = YES 
     109 
     110# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all  
     111# inherited members of a class in the documentation of that class as if those  
     112# members were ordinary class members. Constructors, destructors and assignment  
     113# operators of the base classes will not be shown. 
     114 
    16115INLINE_INHERITED_MEMB  = NO 
     116 
     117# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full  
     118# path before files name in the file list and in the header files. If set  
     119# to NO the shortest path that makes the file name unique will be used. 
     120 
    17121FULL_PATH_NAMES        = YES 
    18 STRIP_FROM_PATH        = 
    19 STRIP_FROM_INC_PATH    = 
     122 
     123# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag  
     124# can be used to strip a user-defined part of the path. Stripping is  
     125# only done if one of the specified strings matches the left-hand part of  
     126# the path. The tag can be used to show relative paths in the file list.  
     127# If left blank the directory from which doxygen is run is used as the  
     128# path to strip. 
     129 
     130STRIP_FROM_PATH        =  
     131 
     132# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of  
     133# the path mentioned in the documentation of a class, which tells  
     134# the reader which header file to include in order to use a class.  
     135# If left blank only the name of the header file containing the class  
     136# definition is used. Otherwise one should specify the include paths that  
     137# are normally passed to the compiler using the -I flag. 
     138 
     139STRIP_FROM_INC_PATH    =  
     140 
     141# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter  
     142# (but less readable) file names. This can be useful if your file system  
     143# doesn't support long names like on DOS, Mac, or CD-ROM. 
     144 
    20145SHORT_NAMES            = NO 
     146 
     147# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen  
     148# will interpret the first line (until the first dot) of a JavaDoc-style  
     149# comment as the brief description. If set to NO, the JavaDoc  
     150# comments will behave just like regular Qt-style comments  
     151# (thus requiring an explicit @brief command for a brief description.) 
     152 
    21153JAVADOC_AUTOBRIEF      = YES 
     154 
     155# If the QT_AUTOBRIEF tag is set to YES then Doxygen will  
     156# interpret the first line (until the first dot) of a Qt-style  
     157# comment as the brief description. If set to NO, the comments  
     158# will behave just like regular Qt-style comments (thus requiring  
     159# an explicit \brief command for a brief description.) 
     160 
    22161QT_AUTOBRIEF           = NO 
     162 
     163# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen  
     164# treat a multi-line C++ special comment block (i.e. a block of //! or ///  
     165# comments) as a brief description. This used to be the default behaviour.  
     166# The new default is to treat a multi-line C++ comment block as a detailed  
     167# description. Set this tag to YES if you prefer the old behaviour instead. 
     168 
    23169MULTILINE_CPP_IS_BRIEF = NO 
     170 
     171# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented  
     172# member inherits the documentation from any documented member that it  
     173# re-implements. 
     174 
    24175INHERIT_DOCS           = YES 
     176 
     177# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce  
     178# a new page for each member. If set to NO, the documentation of a member will  
     179# be part of the file/class/namespace that contains it. 
     180 
    25181SEPARATE_MEMBER_PAGES  = NO 
     182 
     183# The TAB_SIZE tag can be used to set the number of spaces in a tab.  
     184# Doxygen uses this value to replace tabs by spaces in code fragments. 
     185 
    26186TAB_SIZE               = 8 
    27 ALIASES                = 
     187 
     188# This tag can be used to specify a number of aliases that acts  
     189# as commands in the documentation. An alias has the form "name=value".  
     190# For example adding "sideeffect=\par Side Effects:\n" will allow you to  
     191# put the command \sideeffect (or @sideeffect) in the documentation, which  
     192# will result in a user-defined paragraph with heading "Side Effects:".  
     193# You can put \n's in the value part of an alias to insert newlines. 
     194 
     195ALIASES                =  
     196 
     197# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C  
     198# sources only. Doxygen will then generate output that is more tailored for C.  
     199# For instance, some of the names that are used will be different. The list  
     200# of all members will be omitted, etc. 
     201 
    28202OPTIMIZE_OUTPUT_FOR_C  = NO 
     203 
     204# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java  
     205# sources only. Doxygen will then generate output that is more tailored for  
     206# Java. For instance, namespaces will be presented as packages, qualified  
     207# scopes will look different, etc. 
     208 
    29209OPTIMIZE_OUTPUT_JAVA   = NO 
     210 
     211# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran  
     212# sources only. Doxygen will then generate output that is more tailored for  
     213# Fortran. 
     214 
    30215OPTIMIZE_FOR_FORTRAN   = NO 
     216 
     217# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL  
     218# sources. Doxygen will then generate output that is tailored for  
     219# VHDL. 
     220 
    31221OPTIMIZE_OUTPUT_VHDL   = NO 
     222 
     223# Doxygen selects the parser to use depending on the extension of the files it  
     224# parses. With this tag you can assign which parser to use for a given extension.  
     225# Doxygen has a built-in mapping, but you can override or extend it using this  
     226# tag. The format is ext=language, where ext is a file extension, and language  
     227# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,  
     228# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make  
     229# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C  
     230# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions  
     231# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. 
     232 
     233EXTENSION_MAPPING      =  
     234 
     235# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want  
     236# to include (a tag file for) the STL sources as input, then you should  
     237# set this tag to YES in order to let doxygen match functions declarations and  
     238# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.  
     239# func(std::string) {}). This also makes the inheritance and collaboration  
     240# diagrams that involve STL classes more complete and accurate. 
     241 
    32242BUILTIN_STL_SUPPORT    = NO 
     243 
     244# If you use Microsoft's C++/CLI language, you should set this option to YES to  
     245# enable parsing support. 
     246 
    33247CPP_CLI_SUPPORT        = NO 
     248 
     249# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.  
     250# Doxygen will parse them like normal C++ but will assume all classes use public  
     251# instead of private inheritance when no explicit protection keyword is present. 
     252 
    34253SIP_SUPPORT            = NO 
     254 
     255# For Microsoft's IDL there are propget and propput attributes to indicate getter  
     256# and setter methods for a property. Setting this option to YES (the default)  
     257# will make doxygen replace the get and set methods by a property in the  
     258# documentation. This will only work if the methods are indeed getting or  
     259# setting a simple type. If this is not the case, or you want to show the  
     260# methods anyway, you should set this option to NO. 
     261 
    35262IDL_PROPERTY_SUPPORT   = YES 
     263 
     264# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC  
     265# tag is set to YES, then doxygen will reuse the documentation of the first  
     266# member in the group (if any) for the other members of the group. By default  
     267# all members of a group must be documented explicitly. 
     268 
    36269DISTRIBUTE_GROUP_DOC   = NO 
     270 
     271# Set the SUBGROUPING tag to YES (the default) to allow class member groups of  
     272# the same type (for instance a group of public functions) to be put as a  
     273# subgroup of that type (e.g. under the Public Functions section). Set it to  
     274# NO to prevent subgrouping. Alternatively, this can be done per class using  
     275# the \nosubgrouping command. 
     276 
    37277SUBGROUPING            = YES 
     278 
     279# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and  
     280# unions are shown inside the group in which they are included (e.g. using  
     281# @ingroup) instead of on a separate page (for HTML and Man pages) or  
     282# section (for LaTeX and RTF). 
     283 
     284INLINE_GROUPED_CLASSES = NO 
     285 
     286# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum  
     287# is documented as struct, union, or enum with the name of the typedef. So  
     288# typedef struct TypeS {} TypeT, will appear in the documentation as a struct  
     289# with name TypeT. When disabled the typedef will appear as a member of a file,  
     290# namespace, or class. And the struct will be named TypeS. This can typically  
     291# be useful for C code in case the coding convention dictates that all compound  
     292# types are typedef'ed and only the typedef is referenced, never the tag name. 
     293 
    38294TYPEDEF_HIDES_STRUCT   = NO 
     295 
     296# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to  
     297# determine which symbols to keep in memory and which to flush to disk.  
     298# When the cache is full, less often used symbols will be written to disk.  
     299# For small to medium size projects (<1000 input files) the default value is  
     300# probably good enough. For larger projects a too small cache size can cause  
     301# doxygen to be busy swapping symbols to and from disk most of the time  
     302# causing a significant performance penalty.  
     303# If the system has enough physical memory increasing the cache will improve the  
     304# performance by keeping more symbols in memory. Note that the value works on  
     305# a logarithmic scale so increasing the size by one will roughly double the  
     306# memory usage. The cache size is given by this formula:  
     307# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,  
     308# corresponding to a cache size of 2^16 = 65536 symbols 
     309 
     310SYMBOL_CACHE_SIZE      = 0 
     311 
    39312#--------------------------------------------------------------------------- 
    40313# Build related configuration options 
    41314#--------------------------------------------------------------------------- 
     315 
     316# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in  
     317# documentation are documented, even if no documentation was available.  
     318# Private class members and static file members will be hidden unless  
     319# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 
     320 
    42321EXTRACT_ALL            = YES 
     322 
     323# If the EXTRACT_PRIVATE tag is set to YES all private members of a class  
     324# will be included in the documentation. 
     325 
    43326EXTRACT_PRIVATE        = YES 
     327 
     328# If the EXTRACT_STATIC tag is set to YES all static members of a file  
     329# will be included in the documentation. 
     330 
    44331EXTRACT_STATIC         = YES 
     332 
     333# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)  
     334# defined locally in source files will be included in the documentation.  
     335# If set to NO only classes defined in header files are included. 
     336 
    45337EXTRACT_LOCAL_CLASSES  = YES 
     338 
     339# This flag is only useful for Objective-C code. When set to YES local  
     340# methods, which are defined in the implementation section but not in  
     341# the interface are included in the documentation.  
     342# If set to NO (the default) only methods in the interface are included. 
     343 
    46344EXTRACT_LOCAL_METHODS  = YES 
     345 
     346# If this flag is set to YES, the members of anonymous namespaces will be  
     347# extracted and appear in the documentation as a namespace called  
     348# 'anonymous_namespace{file}', where file will be replaced with the base  
     349# name of the file that contains the anonymous namespace. By default  
     350# anonymous namespaces are hidden. 
     351 
    47352EXTRACT_ANON_NSPACES   = NO 
     353 
     354# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all  
     355# undocumented members of documented classes, files or namespaces.  
     356# If set to NO (the default) these members will be included in the  
     357# various overviews, but no documentation section is generated.  
     358# This option has no effect if EXTRACT_ALL is enabled. 
     359 
    48360HIDE_UNDOC_MEMBERS     = NO 
     361 
     362# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all  
     363# undocumented classes that are normally visible in the class hierarchy.  
     364# If set to NO (the default) these classes will be included in the various  
     365# overviews. This option has no effect if EXTRACT_ALL is enabled. 
     366 
    49367HIDE_UNDOC_CLASSES     = NO 
     368 
     369# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all  
     370# friend (class|struct|union) declarations.  
     371# If set to NO (the default) these declarations will be included in the  
     372# documentation. 
     373 
    50374HIDE_FRIEND_COMPOUNDS  = NO 
     375 
     376# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any  
     377# documentation blocks found inside the body of a function.  
     378# If set to NO (the default) these blocks will be appended to the  
     379# function's detailed documentation block. 
     380 
    51381HIDE_IN_BODY_DOCS      = NO 
     382 
     383# The INTERNAL_DOCS tag determines if documentation  
     384# that is typed after a \internal command is included. If the tag is set  
     385# to NO (the default) then the documentation will be excluded.  
     386# Set it to YES to include the internal documentation. 
     387 
    52388INTERNAL_DOCS          = YES 
     389 
     390# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate  
     391# file names in lower-case letters. If set to YES upper-case letters are also  
     392# allowed. This is useful if you have classes or files whose names only differ  
     393# in case and if your file system supports case sensitive file names. Windows  
     394# and Mac users are advised to set this option to NO. 
     395 
    53396CASE_SENSE_NAMES       = YES 
     397 
     398# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen  
     399# will show members with their full class and namespace scopes in the  
     400# documentation. If set to YES the scope will be hidden. 
     401 
    54402HIDE_SCOPE_NAMES       = NO 
     403 
     404# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen  
     405# will put a list of the files that are included by a file in the documentation  
     406# of that file. 
     407 
    55408SHOW_INCLUDE_FILES     = YES 
     409 
     410# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen  
     411# will list include files with double quotes in the documentation  
     412# rather than with sharp brackets. 
     413 
     414FORCE_LOCAL_INCLUDES   = NO 
     415 
     416# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]  
     417# is inserted in the documentation for inline members. 
     418 
    56419INLINE_INFO            = YES 
     420 
     421# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen  
     422# will sort the (detailed) documentation of file and class members  
     423# alphabetically by member name. If set to NO the members will appear in  
     424# declaration order. 
     425 
    57426SORT_MEMBER_DOCS       = YES 
    58 SORT_BRIEF_DOCS        = NO 
     427 
     428# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the  
     429# brief documentation of file, namespace and class members alphabetically  
     430# by member name. If set to NO (the default) the members will appear in  
     431# declaration order. 
     432 
     433SORT_BRIEF_DOCS        = YES 
     434 
     435# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen  
     436# will sort the (brief and detailed) documentation of class members so that  
     437# constructors and destructors are listed first. If set to NO (the default)  
     438# the constructors will appear in the respective orders defined by  
     439# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.  
     440# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO  
     441# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 
     442 
     443SORT_MEMBERS_CTORS_1ST = NO 
     444 
     445# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the  
     446# hierarchy of group names into alphabetical order. If set to NO (the default)  
     447# the group names will appear in their defined order. 
     448 
    59449SORT_GROUP_NAMES       = YES 
    60 SORT_BY_SCOPE_NAME     = NO 
     450 
     451# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be  
     452# sorted by fully-qualified names, including namespaces. If set to  
     453# NO (the default), the class list will be sorted only by class name,  
     454# not including the namespace part.  
     455# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.  
     456# Note: This option applies only to the class list, not to the  
     457# alphabetical list. 
     458 
     459SORT_BY_SCOPE_NAME     = YES 
     460 
     461# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to  
     462# do proper type resolution of all parameters of a function it will reject a  
     463# match between the prototype and the implementation of a member function even  
     464# if there is only one candidate or it is obvious which candidate to choose  
     465# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen  
     466# will still accept a match between prototype and implementation in such cases. 
     467 
     468STRICT_PROTO_MATCHING  = NO 
     469 
     470# The GENERATE_TODOLIST tag can be used to enable (YES) or  
     471# disable (NO) the todo list. This list is created by putting \todo  
     472# commands in the documentation. 
     473 
    61474GENERATE_TODOLIST      = YES 
     475 
     476# The GENERATE_TESTLIST tag can be used to enable (YES) or  
     477# disable (NO) the test list. This list is created by putting \test  
     478# commands in the documentation. 
     479 
    62480GENERATE_TESTLIST      = YES 
     481 
     482# The GENERATE_BUGLIST tag can be used to enable (YES) or  
     483# disable (NO) the bug list. This list is created by putting \bug  
     484# commands in the documentation. 
     485 
    63486GENERATE_BUGLIST       = YES 
     487 
     488# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or  
     489# disable (NO) the deprecated list. This list is created by putting  
     490# \deprecated commands in the documentation. 
     491 
    64492GENERATE_DEPRECATEDLIST= YES 
    65 ENABLED_SECTIONS       = 
     493 
     494# The ENABLED_SECTIONS tag can be used to enable conditional  
     495# documentation sections, marked by \if sectionname ... \endif. 
     496 
     497ENABLED_SECTIONS       =  
     498 
     499# The MAX_INITIALIZER_LINES tag determines the maximum number of lines  
     500# the initial value of a variable or macro consists of for it to appear in  
     501# the documentation. If the initializer consists of more lines than specified  
     502# here it will be hidden. Use a value of 0 to hide initializers completely.  
     503# The appearance of the initializer of individual variables and macros in the  
     504# documentation can be controlled using \showinitializer or \hideinitializer  
     505# command in the documentation regardless of this setting. 
     506 
    66507MAX_INITIALIZER_LINES  = 30 
     508 
     509# Set the SHOW_USED_FILES tag to NO to disable the list of files generated  
     510# at the bottom of the documentation of classes and structs. If set to YES the  
     511# list will mention the files that were used to generate the documentation. 
     512 
    67513SHOW_USED_FILES        = YES 
     514 
     515# If the sources in your project are distributed over multiple directories  
     516# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy  
     517# in the documentation. The default is NO. 
     518 
    68519SHOW_DIRECTORIES       = YES 
     520 
     521# Set the SHOW_FILES tag to NO to disable the generation of the Files page.  
     522# This will remove the Files entry from the Quick Index and from the  
     523# Folder Tree View (if specified). The default is YES. 
     524 
    69525SHOW_FILES             = YES 
     526 
     527# Set the SHOW_NAMESPACES tag to NO to disable the generation of the  
     528# Namespaces page.  This will remove the Namespaces entry from the Quick Index  
     529# and from the Folder Tree View (if specified). The default is YES. 
     530 
    70531SHOW_NAMESPACES        = NO 
    71 FILE_VERSION_FILTER    = 
     532 
     533# The FILE_VERSION_FILTER tag can be used to specify a program or script that  
     534# doxygen should invoke to get the current version for each file (typically from  
     535# the version control system). Doxygen will invoke the program by executing (via  
     536# popen()) the command <command> <input-file>, where <command> is the value of  
     537# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file  
     538# provided by doxygen. Whatever the program writes to standard output  
     539# is used as the file version. See the manual for examples. 
     540 
     541FILE_VERSION_FILTER    =  
     542 
     543# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed  
     544# by doxygen. The layout file controls the global structure of the generated  
     545# output files in an output format independent way. The create the layout file  
     546# that represents doxygen's defaults, run doxygen with the -l option.  
     547# You can optionally specify a file name after the option, if omitted  
     548# DoxygenLayout.xml will be used as the name of the layout file. 
     549 
     550LAYOUT_FILE            =  
     551 
    72552#--------------------------------------------------------------------------- 
    73553# configuration options related to warning and progress messages 
    74554#--------------------------------------------------------------------------- 
     555 
     556# The QUIET tag can be used to turn on/off the messages that are generated  
     557# by doxygen. Possible values are YES and NO. If left blank NO is used. 
     558 
    75559QUIET                  = NO 
     560 
     561# The WARNINGS tag can be used to turn on/off the warning messages that are  
     562# generated by doxygen. Possible values are YES and NO. If left blank  
     563# NO is used. 
     564 
    76565WARNINGS               = YES 
    77 WARN_IF_UNDOCUMENTED   = YES 
     566 
     567# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings  
     568# for undocumented members. If EXTRACT_ALL is set to YES then this flag will  
     569# automatically be disabled. 
     570 
     571WARN_IF_UNDOCUMENTED   = NO 
     572 
     573# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for  
     574# potential errors in the documentation, such as not documenting some  
     575# parameters in a documented function, or documenting parameters that  
     576# don't exist or using markup commands wrongly. 
     577 
    78578WARN_IF_DOC_ERROR      = YES 
     579 
     580# The WARN_NO_PARAMDOC option can be enabled to get warnings for  
     581# functions that are documented, but have no documentation for their parameters  
     582# or return value. If set to NO (the default) doxygen will only warn about  
     583# wrong or incomplete parameter documentation, but not about the absence of  
     584# documentation. 
     585 
    79586WARN_NO_PARAMDOC       = NO 
     587 
     588# The WARN_FORMAT tag determines the format of the warning messages that  
     589# doxygen can produce. The string should contain the $file, $line, and $text  
     590# tags, which will be replaced by the file and line number from which the  
     591# warning originated and the warning text. Optionally the format may contain  
     592# $version, which will be replaced by the version of the file (if it could  
     593# be obtained via FILE_VERSION_FILTER) 
     594 
    80595WARN_FORMAT            = "$file:$line: $text" 
    81 WARN_LOGFILE           = 
     596 
     597# The WARN_LOGFILE tag can be used to specify a file to which warning  
     598# and error messages should be written. If left blank the output is written  
     599# to stderr. 
     600 
     601WARN_LOGFILE           =  
     602 
    82603#--------------------------------------------------------------------------- 
    83604# configuration options related to the input files 
    84605#--------------------------------------------------------------------------- 
     606 
     607# The INPUT tag can be used to specify the files and/or directories that contain  
     608# documented source files. You may enter file names like "myfile.cpp" or  
     609# directories like "/usr/src/myproject". Separate the files or directories  
     610# with spaces. 
     611 
    85612INPUT                  = ../../catalog/ \ 
    86613                         ../../catalog/includes/ \ 
     
    116643                         ../../catalog/includes/modules/categories/ \ 
    117644                         ../../catalog/includes/modules/home/ \ 
    118                          ../../catalog/includes/modules/checkout_process/ 
     645                         ../../catalog/includes/modules/checkout_process/ \ 
     646                         ../../catalog/includes/classes/drivers/data/ \ 
     647                         ../../catalog/includes/classes/core_page/ \ 
     648                         ../../catalog/common/classes/imgratio_drivers/ \ 
     649                         ../../catalog/common/classes/mailer_drivers/ \ 
     650                         ../../catalog/common/classes/sql_drivers/ \ 
     651                         ../../catalog/common/classes/datatype_drivers/ \ 
     652                         ../../catalog/includes/classes/core_page/overlay/ \ 
     653                         ../../catalog/common/modules/core/password/ 
     654 
     655# This tag can be used to specify the character encoding of the source files  
     656# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is  
     657# also the default input encoding. Doxygen uses libiconv (or the iconv built  
     658# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for  
     659# the list of possible encodings. 
     660 
    119661INPUT_ENCODING         = UTF-8 
     662 
     663# If the value of the INPUT tag contains directories, you can use the  
     664# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp  
     665# and *.h) to filter out the source-files in the directories. If left  
     666# blank the following patterns are tested:  
     667# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh  
     668# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py  
     669# *.f90 *.f *.for *.vhd *.vhdl 
     670 
    120671FILE_PATTERNS          = *.php \ 
    121672                         *.css \ 
     
    123674                         *.inc \ 
    124675                         *.txt 
     676 
     677# The RECURSIVE tag can be used to turn specify whether or not subdirectories  
     678# should be searched for input files as well. Possible values are YES and NO.  
     679# If left blank NO is used. 
     680 
    125681RECURSIVE              = NO 
    126 EXCLUDE                = 
     682 
     683# The EXCLUDE tag can be used to specify files and/or directories that should  
     684# excluded from the INPUT source files. This way you can easily exclude a  
     685# subdirectory from a directory tree whose root is specified with the INPUT tag. 
     686 
     687EXCLUDE                =  
     688 
     689# The EXCLUDE_SYMLINKS tag can be used select whether or not files or  
     690# directories that are symbolic links (a Unix file system feature) are excluded  
     691# from the input. 
     692 
    127693EXCLUDE_SYMLINKS       = NO 
    128 EXCLUDE_PATTERNS       = 
    129 EXCLUDE_SYMBOLS        = 
     694 
     695# If the value of the INPUT tag contains directories, you can use the  
     696# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude  
     697# certain files from those directories. Note that the wildcards are matched  
     698# against the file with absolute path, so to exclude all test directories  
     699# for example use the pattern */test/* 
     700 
     701EXCLUDE_PATTERNS       =  
     702 
     703# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names  
     704# (namespaces, classes, functions, etc.) that should be excluded from the  
     705# output. The symbol name can be a fully qualified name, a word, or if the  
     706# wildcard * is used, a substring. Examples: ANamespace, AClass,  
     707# AClass::ANamespace, ANamespace::*Test 
     708 
     709EXCLUDE_SYMBOLS        =  
     710 
     711# The EXAMPLE_PATH tag can be used to specify one or more files or  
     712# directories that contain example code fragments that are included (see  
     713# the \include command). 
     714 
    130715EXAMPLE_PATH           = /doc/Frontoffice/example/ 
    131 EXAMPLE_PATTERNS       = 
     716 
     717# If the value of the EXAMPLE_PATH tag contains directories, you can use the  
     718# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp  
     719# and *.h) to filter out the source-files in the directories. If left  
     720# blank all files are included. 
     721 
     722EXAMPLE_PATTERNS       =  
     723 
     724# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be  
     725# searched for input files to be used with the \include or \dontinclude  
     726# commands irrespective of the value of the RECURSIVE tag.  
     727# Possible values are YES and NO. If left blank NO is used. 
     728 
    132729EXAMPLE_RECURSIVE      = NO 
    133 IMAGE_PATH             = 
    134 INPUT_FILTER           = 
    135 FILTER_PATTERNS        = 
     730 
     731# The IMAGE_PATH tag can be used to specify one or more files or  
     732# directories that contain image that are included in the documentation (see  
     733# the \image command). 
     734 
     735IMAGE_PATH             =  
     736 
     737# The INPUT_FILTER tag can be used to specify a program that doxygen should  
     738# invoke to filter for each input file. Doxygen will invoke the filter program  
     739# by executing (via popen()) the command <filter> <input-file>, where <filter>  
     740# is the value of the INPUT_FILTER tag, and <input-file> is the name of an  
     741# input file. Doxygen will then use the output that the filter program writes  
     742# to standard output.  If FILTER_PATTERNS is specified, this tag will be  
     743# ignored. 
     744 
     745INPUT_FILTER           =  
     746 
     747# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern  
     748# basis.  Doxygen will compare the file name with each pattern and apply the  
     749# filter if there is a match.  The filters are a list of the form:  
     750# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further  
     751# info on how filters are used. If FILTER_PATTERNS is empty or if  
     752# non of the patterns match the file name, INPUT_FILTER is applied. 
     753 
     754FILTER_PATTERNS        =  
     755 
     756# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using  
     757# INPUT_FILTER) will be used to filter the input files when producing source  
     758# files to browse (i.e. when SOURCE_BROWSER is set to YES). 
     759 
    136760FILTER_SOURCE_FILES    = NO 
     761 
     762# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file  
     763# pattern. A pattern will override the setting for FILTER_PATTERN (if any)  
     764# and it is also possible to disable source filtering for a specific pattern  
     765# using *.ext= (so without naming a filter). This option only has effect when  
     766# FILTER_SOURCE_FILES is enabled. 
     767 
     768FILTER_SOURCE_PATTERNS =  
     769 
    137770#--------------------------------------------------------------------------- 
    138771# configuration options related to source browsing 
    139772#--------------------------------------------------------------------------- 
     773 
     774# If the SOURCE_BROWSER tag is set to YES then a list of source files will  
     775# be generated. Documented entities will be cross-referenced with these sources.  
     776# Note: To get rid of all source code in the generated output, make sure also  
     777# VERBATIM_HEADERS is set to NO. 
     778 
    140779SOURCE_BROWSER         = YES 
     780 
     781# Setting the INLINE_SOURCES tag to YES will include the body  
     782# of functions and classes directly in the documentation. 
     783 
    141784INLINE_SOURCES         = YES 
     785 
     786# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct  
     787# doxygen to hide any special comment blocks from generated source code  
     788# fragments. Normal C and C++ comments will always remain visible. 
     789 
    142790STRIP_CODE_COMMENTS    = YES 
     791 
     792# If the REFERENCED_BY_RELATION tag is set to YES  
     793# then for each documented function all documented  
     794# functions referencing it will be listed. 
     795 
    143796REFERENCED_BY_RELATION = YES 
     797 
     798# If the REFERENCES_RELATION tag is set to YES  
     799# then for each documented function all documented entities  
     800# called/used by that function will be listed. 
     801 
    144802REFERENCES_RELATION    = NO 
     803 
     804# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)  
     805# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from  
     806# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will  
     807# link to the source code.  Otherwise they will link to the documentation. 
     808 
    145809REFERENCES_LINK_SOURCE = YES 
     810 
     811# If the USE_HTAGS tag is set to YES then the references to source code  
     812# will point to the HTML generated by the htags(1) tool instead of doxygen  
     813# built-in source browser. The htags tool is part of GNU's global source  
     814# tagging system (see http://www.gnu.org/software/global/global.html). You  
     815# will need version 4.8.6 or higher. 
     816 
    146817USE_HTAGS              = NO 
     818 
     819# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen  
     820# will generate a verbatim copy of the header file for each class for  
     821# which an include is specified. Set to NO to disable this. 
     822 
    147823VERBATIM_HEADERS       = YES 
     824 
    148825#--------------------------------------------------------------------------- 
    149826# configuration options related to the alphabetical class index 
    150827#--------------------------------------------------------------------------- 
     828 
     829# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index  
     830# of all compounds will be generated. Enable this if the project  
     831# contains a lot of classes, structs, unions or interfaces. 
     832 
    151833ALPHABETICAL_INDEX     = YES 
     834 
     835# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then  
     836# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns  
     837# in which this list will be split (can be a number in the range [1..20]) 
     838 
    152839COLS_IN_ALPHA_INDEX    = 5 
    153 IGNORE_PREFIX          = 
     840 
     841# In case all classes in a project start with a common prefix, all  
     842# classes will be put under the same header in the alphabetical index.  
     843# The IGNORE_PREFIX tag can be used to specify one or more prefixes that  
     844# should be ignored while generating the index headers. 
     845 
     846IGNORE_PREFIX          =  
     847 
    154848#--------------------------------------------------------------------------- 
    155849# configuration options related to the HTML output 
    156850#--------------------------------------------------------------------------- 
     851 
     852# If the GENERATE_HTML tag is set to YES (the default) Doxygen will  
     853# generate HTML output. 
     854 
    157855GENERATE_HTML          = YES 
     856 
     857# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.  
     858# If a relative path is entered the value of OUTPUT_DIRECTORY will be  
     859# put in front of it. If left blank `html' will be used as the default path. 
     860 
    158861HTML_OUTPUT            = html 
     862 
     863# The HTML_FILE_EXTENSION tag can be used to specify the file extension for  
     864# each generated HTML page (for example: .htm,.php,.asp). If it is left blank  
     865# doxygen will generate files with .html extension. 
     866 
    159867HTML_FILE_EXTENSION    = .html 
     868 
     869# The HTML_HEADER tag can be used to specify a personal HTML header for  
     870# each generated HTML page. If it is left blank doxygen will generate a  
     871# standard header. Note that when using a custom header you are responsible  
     872# for the proper inclusion of any scripts and style sheets that doxygen  
     873# needs, which is dependent on the configuration options used.  
     874# It is adviced to generate a default header using "doxygen -w html  
     875# header.html footer.html stylesheet.css YourConfigFile" and then modify  
     876# that header. Note that the header is subject to change so you typically  
     877# have to redo this when upgrading to a newer version of doxygen or when 
     878# changing the value of configuration settings such as GENERATE_TREEVIEW! 
     879 
    160880HTML_HEADER            = ../header.html 
     881 
     882# The HTML_FOOTER tag can be used to specify a personal HTML footer for  
     883# each generated HTML page. If it is left blank doxygen will generate a  
     884# standard footer. 
     885 
    161886HTML_FOOTER            = ../footer.html 
    162 HTML_STYLESHEET        = 
     887 
     888# The HTML_STYLESHEET tag can be used to specify a user-defined cascading  
     889# style sheet that is used by each HTML page. It can be used to  
     890# fine-tune the look of the HTML output. If the tag is left blank doxygen  
     891# will generate a default style sheet. Note that doxygen will try to copy  
     892# the style sheet file to the HTML output directory, so don't put your own  
     893# stylesheet in the HTML output directory as well, or it will be erased! 
     894 
     895HTML_STYLESHEET        =  
     896 
     897# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or  
     898# other source files which should be copied to the HTML output directory. Note  
     899# that these files will be copied to the base HTML output directory. Use the  
     900# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these  
     901# files. In the HTML_STYLESHEET file, use the file name only. Also note that  
     902# the files will be copied as-is; there are no commands or markers available. 
     903 
     904HTML_EXTRA_FILES       =  
     905 
     906# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.  
     907# Doxygen will adjust the colors in the stylesheet and background images  
     908# according to this color. Hue is specified as an angle on a colorwheel,  
     909# see http://en.wikipedia.org/wiki/Hue for more information.  
     910# For instance the value 0 represents red, 60 is yellow, 120 is green,  
     911# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.  
     912# The allowed range is 0 to 359. 
     913 
     914HTML_COLORSTYLE_HUE    = 220 
     915 
     916# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of  
     917# the colors in the HTML output. For a value of 0 the output will use  
     918# grayscales only. A value of 255 will produce the most vivid colors. 
     919 
     920HTML_COLORSTYLE_SAT    = 100 
     921 
     922# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to  
     923# the luminance component of the colors in the HTML output. Values below  
     924# 100 gradually make the output lighter, whereas values above 100 make  
     925# the output darker. The value divided by 100 is the actual gamma applied,  
     926# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,  
     927# and 100 does not change the gamma. 
     928 
     929HTML_COLORSTYLE_GAMMA  = 80 
     930 
     931# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML  
     932# page will contain the date and time when the page was generated. Setting  
     933# this to NO can help when comparing the output of multiple runs. 
     934 
     935HTML_TIMESTAMP         = YES 
     936 
     937# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,  
     938# files or namespaces will be aligned in HTML using tables. If set to  
     939# NO a bullet list will be used. 
     940 
    163941HTML_ALIGN_MEMBERS     = NO 
     942 
     943# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML  
     944# documentation will contain sections that can be hidden and shown after the  
     945# page has loaded. For this to work a browser that supports  
     946# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox  
     947# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 
     948 
     949HTML_DYNAMIC_SECTIONS  = YES 
     950 
     951# If the GENERATE_DOCSET tag is set to YES, additional index files  
     952# will be generated that can be used as input for Apple's Xcode 3  
     953# integrated development environment, introduced with OSX 10.5 (Leopard).  
     954# To create a documentation set, doxygen will generate a Makefile in the  
     955# HTML output directory. Running make will produce the docset in that  
     956# directory and running "make install" will install the docset in  
     957# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find  
     958# it at startup.  
     959# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html  
     960# for more information. 
     961 
     962GENERATE_DOCSET        = NO 
     963 
     964# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the  
     965# feed. A documentation feed provides an umbrella under which multiple  
     966# documentation sets from a single provider (such as a company or product suite)  
     967# can be grouped. 
     968 
     969DOCSET_FEEDNAME        = "Doxygen generated docs" 
     970 
     971# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that  
     972# should uniquely identify the documentation set bundle. This should be a  
     973# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen  
     974# will append .docset to the name. 
     975 
     976DOCSET_BUNDLE_ID       = org.doxygen.Project 
     977 
     978# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify  
     979# the documentation publisher. This should be a reverse domain-name style  
     980# string, e.g. com.mycompany.MyDocSet.documentation. 
     981 
     982DOCSET_PUBLISHER_ID    = org.doxygen.Publisher 
     983 
     984# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 
     985 
     986DOCSET_PUBLISHER_NAME  = Publisher 
     987 
     988# If the GENERATE_HTMLHELP tag is set to YES, additional index files  
     989# will be generated that can be used as input for tools like the  
     990# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)  
     991# of the generated HTML documentation. 
     992 
    164993GENERATE_HTMLHELP      = NO 
    165 GENERATE_DOCSET        = NO 
    166 DOCSET_FEEDNAME        = "Doxygen generated docs" 
    167 DOCSET_BUNDLE_ID       = org.doxygen.Project 
    168 HTML_DYNAMIC_SECTIONS  = YES 
    169 CHM_FILE               = 
    170 HHC_LOCATION           = 
     994 
     995# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can  
     996# be used to specify the file name of the resulting .chm file. You  
     997# can add a path in front of the file if the result should not be  
     998# written to the html output directory. 
     999 
     1000CHM_FILE               =  
     1001 
     1002# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can  
     1003# be used to specify the location (absolute path including file name) of  
     1004# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run  
     1005# the HTML help compiler on the generated index.hhp. 
     1006 
     1007HHC_LOCATION           =  
     1008 
     1009# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag  
     1010# controls if a separate .chi index file is generated (YES) or that  
     1011# it should be included in the master .chm file (NO). 
     1012 
    1711013GENERATE_CHI           = NO 
    172 CHM_INDEX_ENCODING     = 
     1014 
     1015# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING  
     1016# is used to encode HtmlHelp index (hhk), content (hhc) and project file  
     1017# content. 
     1018 
     1019CHM_INDEX_ENCODING     =  
     1020 
     1021# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag  
     1022# controls whether a binary table of contents is generated (YES) or a  
     1023# normal table of contents (NO) in the .chm file. 
     1024 
    1731025BINARY_TOC             = NO 
     1026 
     1027# The TOC_EXPAND flag can be set to YES to add extra items for group members  
     1028# to the contents of the HTML help documentation and to the tree view. 
     1029 
    1741030TOC_EXPAND             = NO 
     1031 
     1032# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and  
     1033# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated  
     1034# that can be used as input for Qt's qhelpgenerator to generate a  
     1035# Qt Compressed Help (.qch) of the generated HTML documentation. 
     1036 
     1037GENERATE_QHP           = NO 
     1038 
     1039# If the QHG_LOCATION tag is specified, the QCH_FILE tag can  
     1040# be used to specify the file name of the resulting .qch file.  
     1041# The path specified is relative to the HTML output folder. 
     1042 
     1043QCH_FILE               =  
     1044 
     1045# The QHP_NAMESPACE tag specifies the namespace to use when generating  
     1046# Qt Help Project output. For more information please see  
     1047# http://doc.trolltech.com/qthelpproject.html#namespace 
     1048 
     1049QHP_NAMESPACE          = org.doxygen.Project 
     1050 
     1051# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating  
     1052# Qt Help Project output. For more information please see  
     1053# http://doc.trolltech.com/qthelpproject.html#virtual-folders 
     1054 
     1055QHP_VIRTUAL_FOLDER     = doc 
     1056 
     1057# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to  
     1058# add. For more information please see  
     1059# http://doc.trolltech.com/qthelpproject.html#custom-filters 
     1060 
     1061QHP_CUST_FILTER_NAME   =  
     1062 
     1063# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the  
     1064# custom filter to add. For more information please see  
     1065# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">  
     1066# Qt Help Project / Custom Filters</a>. 
     1067 
     1068QHP_CUST_FILTER_ATTRS  =  
     1069 
     1070# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this  
     1071# project's  
     1072# filter section matches.  
     1073# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">  
     1074# Qt Help Project / Filter Attributes</a>. 
     1075 
     1076QHP_SECT_FILTER_ATTRS  =  
     1077 
     1078# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can  
     1079# be used to specify the location of Qt's qhelpgenerator.  
     1080# If non-empty doxygen will try to run qhelpgenerator on the generated  
     1081# .qhp file. 
     1082 
     1083QHG_LOCATION           =  
     1084 
     1085# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files   
     1086# will be generated, which together with the HTML files, form an Eclipse help  
     1087# plugin. To install this plugin and make it available under the help contents  
     1088# menu in Eclipse, the contents of the directory containing the HTML and XML  
     1089# files needs to be copied into the plugins directory of eclipse. The name of  
     1090# the directory within the plugins directory should be the same as  
     1091# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before  
     1092# the help appears. 
     1093 
     1094GENERATE_ECLIPSEHELP   = NO 
     1095 
     1096# A unique identifier for the eclipse help plugin. When installing the plugin  
     1097# the directory name containing the HTML and XML files should also have  
     1098# this name. 
     1099 
     1100ECLIPSE_DOC_ID         = org.doxygen.Project 
     1101 
     1102# The DISABLE_INDEX tag can be used to turn on/off the condensed index at  
     1103# top of each HTML page. The value NO (the default) enables the index and  
     1104# the value YES disables it. 
     1105 
    1751106DISABLE_INDEX          = NO 
     1107 
     1108# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values  
     1109# (range [0,1..20]) that doxygen will group on one line in the generated HTML  
     1110# documentation. Note that a value of 0 will completely suppress the enum  
     1111# values from appearing in the overview section. 
     1112 
    1761113ENUM_VALUES_PER_LINE   = 4 
     1114 
     1115# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index  
     1116# structure should be generated to display hierarchical information.  
     1117# If the tag value is set to YES, a side panel will be generated  
     1118# containing a tree-like index structure (just like the one that  
     1119# is generated for HTML Help). For this to work a browser that supports  
     1120# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).  
     1121# Windows users are probably better off using the HTML help feature. 
     1122 
    1771123GENERATE_TREEVIEW      = YES 
     1124 
     1125# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,  
     1126# and Class Hierarchy pages using a tree view instead of an ordered list. 
     1127 
     1128USE_INLINE_TREES       = NO 
     1129 
     1130# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be  
     1131# used to set the initial width (in pixels) of the frame in which the tree  
     1132# is shown. 
     1133 
    1781134TREEVIEW_WIDTH         = 250 
     1135 
     1136# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open  
     1137# links to external symbols imported via tag files in a separate window. 
     1138 
     1139EXT_LINKS_IN_WINDOW    = NO 
     1140 
     1141# Use this tag to change the font size of Latex formulas included  
     1142# as images in the HTML documentation. The default is 10. Note that  
     1143# when you change the font size after a successful doxygen run you need  
     1144# to manually remove any form_*.png images from the HTML output directory  
     1145# to force them to be regenerated. 
     1146 
    1791147FORMULA_FONTSIZE       = 10 
     1148 
     1149# Use the FORMULA_TRANPARENT tag to determine whether or not the images  
     1150# generated for formulas are transparent PNGs. Transparent PNGs are  
     1151# not supported properly for IE 6.0, but are supported on all modern browsers.  
     1152# Note that when changing this option you need to delete any form_*.png files  
     1153# in the HTML output before the changes have effect. 
     1154 
     1155FORMULA_TRANSPARENT    = YES 
     1156 
     1157# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax  
     1158# (see http://www.mathjax.org) which uses client side Javascript for the  
     1159# rendering instead of using prerendered bitmaps. Use this if you do not  
     1160# have LaTeX installed or if you want to formulas look prettier in the HTML  
     1161# output. When enabled you also need to install MathJax separately and  
     1162# configure the path to it using the MATHJAX_RELPATH option. 
     1163 
     1164USE_MATHJAX            = NO 
     1165 
     1166# When MathJax is enabled you need to specify the location relative to the  
     1167# HTML output directory using the MATHJAX_RELPATH option. The destination  
     1168# directory should contain the MathJax.js script. For instance, if the mathjax  
     1169# directory is located at the same level as the HTML output directory, then  
     1170# MATHJAX_RELPATH should be ../mathjax. The default value points to the  
     1171# mathjax.org site, so you can quickly see the result without installing  
     1172# MathJax, but it is strongly recommended to install a local copy of MathJax  
     1173# before deployment. 
     1174 
     1175MATHJAX_RELPATH        = http://www.mathjax.org/mathjax 
     1176 
     1177# When the SEARCHENGINE tag is enabled doxygen will generate a search box  
     1178# for the HTML output. The underlying search engine uses javascript  
     1179# and DHTML and should work on any modern browser. Note that when using  
     1180# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets  
     1181# (GENERATE_DOCSET) there is already a search function so this one should  
     1182# typically be disabled. For large projects the javascript based search engine  
     1183# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 
     1184 
     1185SEARCHENGINE           = YES 
     1186 
     1187# When the SERVER_BASED_SEARCH tag is enabled the search engine will be  
     1188# implemented using a PHP enabled web server instead of at the web client  
     1189# using Javascript. Doxygen will generate the search PHP script and index  
     1190# file to put on the web server. The advantage of the server  
     1191# based approach is that it scales better to large projects and allows  
     1192# full text search. The disadvantages are that it is more difficult to setup  
     1193# and does not have live searching capabilities. 
     1194 
     1195SERVER_BASED_SEARCH    = NO 
     1196 
    1801197#--------------------------------------------------------------------------- 
    1811198# configuration options related to the LaTeX output 
    1821199#--------------------------------------------------------------------------- 
     1200 
     1201# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will  
     1202# generate Latex output. 
     1203 
    1831204GENERATE_LATEX         = NO 
     1205 
     1206# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.  
     1207# If a relative path is entered the value of OUTPUT_DIRECTORY will be  
     1208# put in front of it. If left blank `latex' will be used as the default path. 
     1209 
    1841210LATEX_OUTPUT           = latex 
     1211 
     1212# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be  
     1213# invoked. If left blank `latex' will be used as the default command name.  
     1214# Note that when enabling USE_PDFLATEX this option is only used for  
     1215# generating bitmaps for formulas in the HTML output, but not in the  
     1216# Makefile that is written to the output directory. 
     1217 
    1851218LATEX_CMD_NAME         = latex 
     1219 
     1220# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to  
     1221# generate index for LaTeX. If left blank `makeindex' will be used as the  
     1222# default command name. 
     1223 
    1861224MAKEINDEX_CMD_NAME     = makeindex 
     1225 
     1226# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact  
     1227# LaTeX documents. This may be useful for small projects and may help to  
     1228# save some trees in general. 
     1229 
    1871230COMPACT_LATEX          = NO 
     1231 
     1232# The PAPER_TYPE tag can be used to set the paper type that is used  
     1233# by the printer. Possible values are: a4, letter, legal and  
     1234# executive. If left blank a4wide will be used. 
     1235 
    1881236PAPER_TYPE             = a4wide 
    189 EXTRA_PACKAGES         = 
    190 LATEX_HEADER           = 
     1237 
     1238# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX  
     1239# packages that should be included in the LaTeX output. 
     1240 
     1241EXTRA_PACKAGES         =  
     1242 
     1243# The LATEX_HEADER tag can be used to specify a personal LaTeX header for  
     1244# the generated latex document. The header should contain everything until  
     1245# the first chapter. If it is left blank doxygen will generate a  
     1246# standard header. Notice: only use this tag if you know what you are doing! 
     1247 
     1248LATEX_HEADER           =  
     1249 
     1250# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for  
     1251# the generated latex document. The footer should contain everything after  
     1252# the last chapter. If it is left blank doxygen will generate a  
     1253# standard footer. Notice: only use this tag if you know what you are doing! 
     1254 
     1255LATEX_FOOTER           =  
     1256 
     1257# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated  
     1258# is prepared for conversion to pdf (using ps2pdf). The pdf file will  
     1259# contain links (just like the HTML output) instead of page references  
     1260# This makes the output suitable for online browsing using a pdf viewer. 
     1261 
    1911262PDF_HYPERLINKS         = NO 
     1263 
     1264# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of  
     1265# plain latex in the generated Makefile. Set this option to YES to get a  
     1266# higher quality PDF documentation. 
     1267 
    1921268USE_PDFLATEX           = NO 
     1269 
     1270# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.  
     1271# command to the generated LaTeX files. This will instruct LaTeX to keep  
     1272# running if errors occur, instead of asking the user for help.  
     1273# This option is also used when generating formulas in HTML. 
     1274 
    1931275LATEX_BATCHMODE        = YES 
     1276 
     1277# If LATEX_HIDE_INDICES is set to YES then doxygen will not  
     1278# include the index chapters (such as File Index, Compound Index, etc.)  
     1279# in the output. 
     1280 
    1941281LATEX_HIDE_INDICES     = NO 
     1282 
     1283# If LATEX_SOURCE_CODE is set to YES then doxygen will include  
     1284# source code with syntax highlighting in the LaTeX output.  
     1285# Note that which sources are shown also depends on other settings  
     1286# such as SOURCE_BROWSER. 
     1287 
     1288LATEX_SOURCE_CODE      = NO 
     1289 
    1951290#--------------------------------------------------------------------------- 
    1961291# configuration options related to the RTF output 
    1971292#--------------------------------------------------------------------------- 
     1293 
     1294# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output  
     1295# The RTF output is optimized for Word 97 and may not look very pretty with  
     1296# other RTF readers or editors. 
     1297 
    1981298GENERATE_RTF           = NO 
     1299 
     1300# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.  
     1301# If a relative path is entered the value of OUTPUT_DIRECTORY will be  
     1302# put in front of it. If left blank `rtf' will be used as the default path. 
     1303 
    1991304RTF_OUTPUT             = rtf 
     1305 
     1306# If the COMPACT_RTF tag is set to YES Doxygen generates more compact  
     1307# RTF documents. This may be useful for small projects and may help to  
     1308# save some trees in general. 
     1309 
    2001310COMPACT_RTF            = NO 
     1311 
     1312# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated  
     1313# will contain hyperlink fields. The RTF file will  
     1314# contain links (just like the HTML output) instead of page references.  
     1315# This makes the output suitable for online browsing using WORD or other  
     1316# programs which support those fields.  
     1317# Note: wordpad (write) and others do not support links. 
     1318 
    2011319RTF_HYPERLINKS         = NO 
    202 RTF_STYLESHEET_FILE    = 
    203 RTF_EXTENSIONS_FILE    = 
     1320 
     1321# Load stylesheet definitions from file. Syntax is similar to doxygen's  
     1322# config file, i.e. a series of assignments. You only have to provide  
     1323# replacements, missing definitions are set to their default value. 
     1324 
     1325RTF_STYLESHEET_FILE    =  
     1326 
     1327# Set optional variables used in the generation of an rtf document.  
     1328# Syntax is similar to doxygen's config file. 
     1329 
     1330RTF_EXTENSIONS_FILE    =  
     1331 
    2041332#--------------------------------------------------------------------------- 
    2051333# configuration options related to the man page output 
    2061334#--------------------------------------------------------------------------- 
     1335 
     1336# If the GENERATE_MAN tag is set to YES (the default) Doxygen will  
     1337# generate man pages 
     1338 
    2071339GENERATE_MAN           = NO 
     1340 
     1341# The MAN_OUTPUT tag is used to specify where the man pages will be put.  
     1342# If a relative path is entered the value of OUTPUT_DIRECTORY will be  
     1343# put in front of it. If left blank `man' will be used as the default path. 
     1344 
    2081345MAN_OUTPUT             = man 
     1346 
     1347# The MAN_EXTENSION tag determines the extension that is added to  
     1348# the generated man pages (default is the subroutine's section .3) 
     1349 
    2091350MAN_EXTENSION          = .3 
     1351 
     1352# If the MAN_LINKS tag is set to YES and Doxygen generates man output,  
     1353# then it will generate one additional man file for each entity  
     1354# documented in the real man page(s). These additional files  
     1355# only source the real man page, but without them the man command  
     1356# would be unable to find the correct page. The default is NO. 
     1357 
    2101358MAN_LINKS              = NO 
     1359 
    2111360#--------------------------------------------------------------------------- 
    2121361# configuration options related to the XML output 
    2131362#--------------------------------------------------------------------------- 
     1363 
     1364# If the GENERATE_XML tag is set to YES Doxygen will  
     1365# generate an XML file that captures the structure of  
     1366# the code including all documentation. 
     1367 
    2141368GENERATE_XML           = NO 
     1369 
     1370# The XML_OUTPUT tag is used to specify where the XML pages will be put.  
     1371# If a relative path is entered the value of OUTPUT_DIRECTORY will be  
     1372# put in front of it. If left blank `xml' will be used as the default path. 
     1373 
    2151374XML_OUTPUT             = xml 
    216 XML_SCHEMA             = 
    217 XML_DTD                = 
     1375 
     1376# The XML_SCHEMA tag can be used to specify an XML schema,  
     1377# which can be used by a validating XML parser to check the  
     1378# syntax of the XML files. 
     1379 
     1380XML_SCHEMA             =  
     1381 
     1382# The XML_DTD tag can be used to specify an XML DTD,  
     1383# which can be used by a validating XML parser to check the  
     1384# syntax of the XML files. 
     1385 
     1386XML_DTD                =  
     1387 
     1388# If the XML_PROGRAMLISTING tag is set to YES Doxygen will  
     1389# dump the program listings (including syntax highlighting  
     1390# and cross-referencing information) to the XML output. Note that  
     1391# enabling this will significantly increase the size of the XML output. 
     1392 
    2181393XML_PROGRAMLISTING     = YES 
     1394 
    2191395#--------------------------------------------------------------------------- 
    2201396# configuration options for the AutoGen Definitions output 
    2211397#--------------------------------------------------------------------------- 
     1398 
     1399# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will  
     1400# generate an AutoGen Definitions (see autogen.sf.net) file  
     1401# that captures the structure of the code including all  
     1402# documentation. Note that this feature is still experimental  
     1403# and incomplete at the moment. 
     1404 
    2221405GENERATE_AUTOGEN_DEF   = YES 
     1406 
    2231407#--------------------------------------------------------------------------- 
    2241408# configuration options related to the Perl module output 
    2251409#--------------------------------------------------------------------------- 
     1410 
     1411# If the GENERATE_PERLMOD tag is set to YES Doxygen will  
     1412# generate a Perl module file that captures the structure of  
     1413# the code including all documentation. Note that this  
     1414# feature is still experimental and incomplete at the  
     1415# moment. 
     1416 
    2261417GENERATE_PERLMOD       = NO 
     1418 
     1419# If the PERLMOD_LATEX tag is set to YES Doxygen will generate  
     1420# the necessary Makefile rules, Perl scripts and LaTeX code to be able  
     1421# to generate PDF and DVI output from the Perl module output. 
     1422 
    2271423PERLMOD_LATEX          = NO 
     1424 
     1425# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be  
     1426# nicely formatted so it can be parsed by a human reader.  This is useful  
     1427# if you want to understand what is going on.  On the other hand, if this  
     1428# tag is set to NO the size of the Perl module output will be much smaller  
     1429# and Perl will parse it just the same. 
     1430 
    2281431PERLMOD_PRETTY         = YES 
    229 PERLMOD_MAKEVAR_PREFIX = 
     1432 
     1433# The names of the make variables in the generated doxyrules.make file  
     1434# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.  
     1435# This is useful so different doxyrules.make files included by the same  
     1436# Makefile don't overwrite each other's variables. 
     1437 
     1438PERLMOD_MAKEVAR_PREFIX =  
     1439 
    2301440#--------------------------------------------------------------------------- 
    2311441# Configuration options related to the preprocessor 
    2321442#--------------------------------------------------------------------------- 
     1443 
     1444# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will  
     1445# evaluate all C-preprocessor directives found in the sources and include  
     1446# files. 
     1447 
    2331448ENABLE_PREPROCESSING   = YES 
     1449 
     1450# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro  
     1451# names in the source code. If set to NO (the default) only conditional  
     1452# compilation will be performed. Macro expansion can be done in a controlled  
     1453# way by setting EXPAND_ONLY_PREDEF to YES. 
     1454 
    2341455MACRO_EXPANSION        = NO 
     1456 
     1457# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES  
     1458# then the macro expansion is limited to the macros specified with the  
     1459# PREDEFINED and EXPAND_AS_DEFINED tags. 
     1460 
    2351461EXPAND_ONLY_PREDEF     = NO 
     1462 
     1463# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files  
     1464# pointed to by INCLUDE_PATH will be searched when a #include is found. 
     1465 
    2361466SEARCH_INCLUDES        = YES 
    237 INCLUDE_PATH           = 
    238 INCLUDE_FILE_PATTERNS  = 
    239 PREDEFINED             = 
    240 EXPAND_AS_DEFINED      = 
     1467 
     1468# The INCLUDE_PATH tag can be used to specify one or more directories that  
     1469# contain include files that are not input files but should be processed by  
     1470# the preprocessor. 
     1471 
     1472INCLUDE_PATH           =  
     1473 
     1474# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard  
     1475# patterns (like *.h and *.hpp) to filter out the header-files in the  
     1476# directories. If left blank, the patterns specified with FILE_PATTERNS will  
     1477# be used. 
     1478 
     1479INCLUDE_FILE_PATTERNS  =  
     1480 
     1481# The PREDEFINED tag can be used to specify one or more macro names that  
     1482# are defined before the preprocessor is started (similar to the -D option of  
     1483# gcc). The argument of the tag is a list of macros of the form: name  
     1484# or name=definition (no spaces). If the definition and the = are  
     1485# omitted =1 is assumed. To prevent a macro definition from being  
     1486# undefined via #undef or recursively expanded use the := operator  
     1487# instead of the = operator. 
     1488 
     1489PREDEFINED             =  
     1490 
     1491# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then  
     1492# this tag can be used to specify a list of macro names that should be expanded.  
     1493# The macro definition that is found in the sources will be used.  
     1494# Use the PREDEFINED tag if you want to use a different macro definition that  
     1495# overrules the definition found in the source code. 
     1496 
     1497EXPAND_AS_DEFINED      =  
     1498 
     1499# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then  
     1500# doxygen's preprocessor will remove all references to function-like macros  
     1501# that are alone on a line, have an all uppercase name, and do not end with a  
     1502# semicolon, because these will confuse the parser if not removed. 
     1503 
    2411504SKIP_FUNCTION_MACROS   = YES 
     1505 
    2421506#--------------------------------------------------------------------------- 
    2431507# Configuration::additions related to external references 
    2441508#--------------------------------------------------------------------------- 
    245 TAGFILES               = 
    246 GENERATE_TAGFILE       = 
     1509 
     1510# The TAGFILES option can be used to specify one or more tagfiles.  
     1511# Optionally an initial location of the external documentation  
     1512# can be added for each tagfile. The format of a tag file without  
     1513# this location is as follows:  
     1514#   TAGFILES = file1 file2 ...  
     1515# Adding location for the tag files is done as follows:  
     1516#   TAGFILES = file1=loc1 "file2 = loc2" ...  
     1517# where "loc1" and "loc2" can be relative or absolute paths or  
     1518# URLs. If a location is present for each tag, the installdox tool  
     1519# does not have to be run to correct the links.  
     1520# Note that each tag file must have a unique name  
     1521# (where the name does NOT include the path)  
     1522# If a tag file is not located in the directory in which doxygen  
     1523# is run, you must also specify the path to the tagfile here. 
     1524 
     1525TAGFILES               =  
     1526 
     1527# When a file name is specified after GENERATE_TAGFILE, doxygen will create  
     1528# a tag file that is based on the input files it reads. 
     1529 
     1530GENERATE_TAGFILE       =  
     1531 
     1532# If the ALLEXTERNALS tag is set to YES all external classes will be listed  
     1533# in the class index. If set to NO only the inherited external classes  
     1534# will be listed. 
     1535 
    2471536ALLEXTERNALS           = NO 
     1537 
     1538# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed  
     1539# in the modules index. If set to NO, only the current project's groups will  
     1540# be listed. 
     1541 
    2481542EXTERNAL_GROUPS        = NO 
     1543 
     1544# The PERL_PATH should be the absolute path and name of the perl script  
     1545# interpreter (i.e. the result of `which perl'). 
     1546 
    2491547PERL_PATH              = /usr/bin/perl 
     1548 
    2501549#--------------------------------------------------------------------------- 
    2511550# Configuration options related to the dot tool 
    2521551#--------------------------------------------------------------------------- 
     1552 
     1553# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will  
     1554# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base  
     1555# or super classes. Setting the tag to NO turns the diagrams off. Note that  
     1556# this option also works with HAVE_DOT disabled, but it is recommended to  
     1557# install and use dot, since it yields more powerful graphs. 
     1558 
    2531559CLASS_DIAGRAMS         = NO 
    254 MSCGEN_PATH            = 
     1560 
     1561# You can define message sequence charts within doxygen comments using the \msc  
     1562# command. Doxygen will then run the mscgen tool (see  
     1563# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the  
     1564# documentation. The MSCGEN_PATH tag allows you to specify the directory where  
     1565# the mscgen tool resides. If left empty the tool is assumed to be found in the  
     1566# default search path. 
     1567 
     1568MSCGEN_PATH            =  
     1569 
     1570# If set to YES, the inheritance and collaboration graphs will hide  
     1571# inheritance and usage relations if the target is undocumented  
     1572# or is not a class. 
     1573 
    2551574HIDE_UNDOC_RELATIONS   = NO 
     1575 
     1576# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is  
     1577# available from the path. This tool is part of Graphviz, a graph visualization  
     1578# toolkit from AT&T and Lucent Bell Labs. The other options in this section  
     1579# have no effect if this option is set to NO (the default) 
     1580 
    2561581HAVE_DOT               = NO 
     1582 
     1583# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is  
     1584# allowed to run in parallel. When set to 0 (the default) doxygen will  
     1585# base this on the number of processors available in the system. You can set it  
     1586# explicitly to a value larger than 0 to get control over the balance  
     1587# between CPU load and processing speed. 
     1588 
     1589DOT_NUM_THREADS        = 0 
     1590 
     1591# By default doxygen will write a font called Helvetica to the output  
     1592# directory and reference it in all dot files that doxygen generates.  
     1593# When you want a differently looking font you can specify the font name  
     1594# using DOT_FONTNAME. You need to make sure dot is able to find the font,  
     1595# which can be done by putting it in a standard location or by setting the  
     1596# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory  
     1597# containing the font. 
     1598 
    2571599DOT_FONTNAME           = FreeSans 
    258 DOT_FONTPATH           = 
     1600 
     1601# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.  
     1602# The default size is 10pt. 
     1603 
     1604DOT_FONTSIZE           = 10 
     1605 
     1606# By default doxygen will tell dot to use the output directory to look for the  
     1607# FreeSans.ttf font (which doxygen will put there itself). If you specify a  
     1608# different font using DOT_FONTNAME you can set the path where dot  
     1609# can find it using this tag. 
     1610 
     1611DOT_FONTPATH           =  
     1612 
     1613# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen  
     1614# will generate a graph for each documented class showing the direct and  
     1615# indirect inheritance relations. Setting this tag to YES will force the  
     1616# the CLASS_DIAGRAMS tag to NO. 
     1617 
    2591618CLASS_GRAPH            = YES 
     1619 
     1620# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen  
     1621# will generate a graph for each documented class showing the direct and  
     1622# indirect implementation dependencies (inheritance, containment, and  
     1623# class references variables) of the class with other documented classes. 
     1624 
    2601625COLLABORATION_GRAPH    = YES 
     1626 
     1627# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen  
     1628# will generate a graph for groups, showing the direct groups dependencies 
     1629 
    2611630GROUP_GRAPHS           = YES 
     1631 
     1632# If the UML_LOOK tag is set to YES doxygen will generate inheritance and  
     1633# collaboration diagrams in a style similar to the OMG's Unified Modeling  
     1634# Language. 
     1635 
    2621636UML_LOOK               = NO 
     1637 
     1638# If set to YES, the inheritance and collaboration graphs will show the  
     1639# relations between templates and their instances. 
     1640 
    2631641TEMPLATE_RELATIONS     = NO 
     1642 
     1643# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT  
     1644# tags are set to YES then doxygen will generate a graph for each documented  
     1645# file showing the direct and indirect include dependencies of the file with  
     1646# other documented files. 
     1647 
    2641648INCLUDE_GRAPH          = YES 
     1649 
     1650# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and  
     1651# HAVE_DOT tags are set to YES then doxygen will generate a graph for each  
     1652# documented header file showing the documented files that directly or  
     1653# indirectly include this file. 
     1654 
    2651655INCLUDED_BY_GRAPH      = YES 
     1656 
     1657# If the CALL_GRAPH and HAVE_DOT options are set to YES then  
     1658# doxygen will generate a call dependency graph for every global function  
     1659# or class method. Note that enabling this option will significantly increase  
     1660# the time of a run. So in most cases it will be better to enable call graphs  
     1661# for selected functions only using the \callgraph command. 
     1662 
    2661663CALL_GRAPH             = NO 
     1664 
     1665# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then  
     1666# doxygen will generate a caller dependency graph for every global function  
     1667# or class method. Note that enabling this option will significantly increase  
     1668# the time of a run. So in most cases it will be better to enable caller  
     1669# graphs for selected functions only using the \callergraph command. 
     1670 
    2671671CALLER_GRAPH           = NO 
     1672 
     1673# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen  
     1674# will generate a graphical hierarchy of all classes instead of a textual one. 
     1675 
    2681676GRAPHICAL_HIERARCHY    = YES 
     1677 
     1678# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES  
     1679# then doxygen will show the dependencies a directory has on other directories  
     1680# in a graphical way. The dependency relations are determined by the #include  
     1681# relations between the files in the directories. 
     1682 
    2691683DIRECTORY_GRAPH        = YES 
     1684 
     1685# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images  
     1686# generated by dot. Possible values are svg, png, jpg, or gif.  
     1687# If left blank png will be used. 
     1688 
    2701689DOT_IMAGE_FORMAT       = png 
    271 DOT_PATH               = 
    272 DOTFILE_DIRS           = 
     1690 
     1691# The tag DOT_PATH can be used to specify the path where the dot tool can be  
     1692# found. If left blank, it is assumed the dot tool can be found in the path. 
     1693 
     1694DOT_PATH               =  
     1695 
     1696# The DOTFILE_DIRS tag can be used to specify one or more directories that  
     1697# contain dot files that are included in the documentation (see the  
     1698# \dotfile command). 
     1699 
     1700DOTFILE_DIRS           =  
     1701 
     1702# The MSCFILE_DIRS tag can be used to specify one or more directories that  
     1703# contain msc files that are included in the documentation (see the  
     1704# \mscfile command). 
     1705 
     1706MSCFILE_DIRS           =  
     1707 
     1708# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of  
     1709# nodes that will be shown in the graph. If the number of nodes in a graph  
     1710# becomes larger than this value, doxygen will truncate the graph, which is  
     1711# visualized by representing a node as a red box. Note that doxygen if the  
     1712# number of direct children of the root node in a graph is already larger than  
     1713# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note  
     1714# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 
     1715 
    2731716DOT_GRAPH_MAX_NODES    = 50 
     1717 
     1718# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the  
     1719# graphs generated by dot. A depth value of 3 means that only nodes reachable  
     1720# from the root by following a path via at most 3 edges will be shown. Nodes  
     1721# that lay further from the root node will be omitted. Note that setting this  
     1722# option to 1 or 2 may greatly reduce the computation time needed for large  
     1723# code bases. Also note that the size of a graph can be further restricted by  
     1724# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 
     1725 
    2741726MAX_DOT_GRAPH_DEPTH    = 0 
     1727 
     1728# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent  
     1729# background. This is disabled by default, because dot on Windows does not  
     1730# seem to support this out of the box. Warning: Depending on the platform used,  
     1731# enabling this option may lead to badly anti-aliased labels on the edges of  
     1732# a graph (i.e. they become hard to read). 
     1733 
    2751734DOT_TRANSPARENT        = NO 
     1735 
     1736# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output  
     1737# files in one run (i.e. multiple -o and -T options on the command line). This  
     1738# makes dot run faster, but since only newer versions of dot (>1.8.10)  
     1739# support this, this feature is disabled by default. 
     1740 
    2761741DOT_MULTI_TARGETS      = YES 
     1742 
     1743# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will  
     1744# generate a legend page explaining the meaning of the various boxes and  
     1745# arrows in the dot generated graphs. 
     1746 
    2771747GENERATE_LEGEND        = YES 
     1748 
     1749# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will  
     1750# remove the intermediate dot files that are used to generate  
     1751# the various graphs. 
     1752 
    2781753DOT_CLEANUP            = YES 
    279 #--------------------------------------------------------------------------- 
    280 # Configuration::additions related to the search engine 
    281 #--------------------------------------------------------------------------- 
    282 SEARCHENGINE           = YES