1cdf0e10cSrcweir# Doxyfile 1.5.8 2*184e05d2SAndrew Rist# ************************************************************* 3*184e05d2SAndrew Rist# 4*184e05d2SAndrew Rist# Licensed to the Apache Software Foundation (ASF) under one 5*184e05d2SAndrew Rist# or more contributor license agreements. See the NOTICE file 6*184e05d2SAndrew Rist# distributed with this work for additional information 7*184e05d2SAndrew Rist# regarding copyright ownership. The ASF licenses this file 8*184e05d2SAndrew Rist# to you under the Apache License, Version 2.0 (the 9*184e05d2SAndrew Rist# "License"); you may not use this file except in compliance 10*184e05d2SAndrew Rist# with the License. You may obtain a copy of the License at 11*184e05d2SAndrew Rist# 12*184e05d2SAndrew Rist# http://www.apache.org/licenses/LICENSE-2.0 13*184e05d2SAndrew Rist# 14*184e05d2SAndrew Rist# Unless required by applicable law or agreed to in writing, 15*184e05d2SAndrew Rist# software distributed under the License is distributed on an 16*184e05d2SAndrew Rist# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 17*184e05d2SAndrew Rist# KIND, either express or implied. See the License for the 18*184e05d2SAndrew Rist# specific language governing permissions and limitations 19*184e05d2SAndrew Rist# under the License. 20*184e05d2SAndrew Rist# 21*184e05d2SAndrew Rist# ************************************************************* 22cdf0e10cSrcweir 23cdf0e10cSrcweir# This file describes the settings to be used by the documentation system 24cdf0e10cSrcweir# doxygen (www.doxygen.org) for a project 25cdf0e10cSrcweir# 26cdf0e10cSrcweir# All text after a hash (#) is considered a comment and will be ignored 27cdf0e10cSrcweir# The format is: 28cdf0e10cSrcweir# TAG = value [value, ...] 29cdf0e10cSrcweir# For lists items can also be appended using: 30cdf0e10cSrcweir# TAG += value [value, ...] 31cdf0e10cSrcweir# Values that contain spaces should be placed between quotes (" ") 32cdf0e10cSrcweir 33cdf0e10cSrcweir#--------------------------------------------------------------------------- 34cdf0e10cSrcweir# Project related configuration options 35cdf0e10cSrcweir#--------------------------------------------------------------------------- 36cdf0e10cSrcweir 37cdf0e10cSrcweir# This tag specifies the encoding used for all characters in the config file 38cdf0e10cSrcweir# that follow. The default is UTF-8 which is also the encoding used for all 39cdf0e10cSrcweir# text before the first occurrence of this tag. Doxygen uses libiconv (or the 40cdf0e10cSrcweir# iconv built into libc) for the transcoding. See 41cdf0e10cSrcweir# http://www.gnu.org/software/libiconv for the list of possible encodings. 42cdf0e10cSrcweir 43cdf0e10cSrcweirDOXYFILE_ENCODING = UTF-8 44cdf0e10cSrcweir 45cdf0e10cSrcweir# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 46cdf0e10cSrcweir# by quotes) that should identify the project. 47cdf0e10cSrcweir 48cdf0e10cSrcweirPROJECT_NAME = gbuild 49cdf0e10cSrcweir 50cdf0e10cSrcweir# The PROJECT_NUMBER tag can be used to enter a project or revision number. 51cdf0e10cSrcweir# This could be handy for archiving the generated documentation or 52cdf0e10cSrcweir# if some version control system is used. 53cdf0e10cSrcweir 54cdf0e10cSrcweirPROJECT_NUMBER = 55cdf0e10cSrcweir 56cdf0e10cSrcweir# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 57cdf0e10cSrcweir# base path where the generated documentation will be put. 58cdf0e10cSrcweir# If a relative path is entered, it will be relative to the location 59cdf0e10cSrcweir# where doxygen was started. If left blank the current directory will be used. 60cdf0e10cSrcweir 61cdf0e10cSrcweirOUTPUT_DIRECTORY = ./output 62cdf0e10cSrcweir 63cdf0e10cSrcweir# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 64cdf0e10cSrcweir# 4096 sub-directories (in 2 levels) under the output directory of each output 65cdf0e10cSrcweir# format and will distribute the generated files over these directories. 66cdf0e10cSrcweir# Enabling this option can be useful when feeding doxygen a huge amount of 67cdf0e10cSrcweir# source files, where putting all generated files in the same directory would 68cdf0e10cSrcweir# otherwise cause performance problems for the file system. 69cdf0e10cSrcweir 70cdf0e10cSrcweirCREATE_SUBDIRS = NO 71cdf0e10cSrcweir 72cdf0e10cSrcweir# The OUTPUT_LANGUAGE tag is used to specify the language in which all 73cdf0e10cSrcweir# documentation generated by doxygen is written. Doxygen will use this 74cdf0e10cSrcweir# information to generate all constant output in the proper language. 75cdf0e10cSrcweir# The default language is English, other supported languages are: 76cdf0e10cSrcweir# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 77cdf0e10cSrcweir# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, 78cdf0e10cSrcweir# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), 79cdf0e10cSrcweir# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, 80cdf0e10cSrcweir# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, 81cdf0e10cSrcweir# Spanish, Swedish, and Ukrainian. 82cdf0e10cSrcweir 83cdf0e10cSrcweirOUTPUT_LANGUAGE = English 84cdf0e10cSrcweir 85cdf0e10cSrcweir# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 86cdf0e10cSrcweir# include brief member descriptions after the members that are listed in 87cdf0e10cSrcweir# the file and class documentation (similar to JavaDoc). 88cdf0e10cSrcweir# Set to NO to disable this. 89cdf0e10cSrcweir 90cdf0e10cSrcweirBRIEF_MEMBER_DESC = YES 91cdf0e10cSrcweir 92cdf0e10cSrcweir# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 93cdf0e10cSrcweir# the brief description of a member or function before the detailed description. 94cdf0e10cSrcweir# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 95cdf0e10cSrcweir# brief descriptions will be completely suppressed. 96cdf0e10cSrcweir 97cdf0e10cSrcweirREPEAT_BRIEF = YES 98cdf0e10cSrcweir 99cdf0e10cSrcweir# This tag implements a quasi-intelligent brief description abbreviator 100cdf0e10cSrcweir# that is used to form the text in various listings. Each string 101cdf0e10cSrcweir# in this list, if found as the leading text of the brief description, will be 102cdf0e10cSrcweir# stripped from the text and the result after processing the whole list, is 103cdf0e10cSrcweir# used as the annotated text. Otherwise, the brief description is used as-is. 104cdf0e10cSrcweir# If left blank, the following values are used ("$name" is automatically 105cdf0e10cSrcweir# replaced with the name of the entity): "The $name class" "The $name widget" 106cdf0e10cSrcweir# "The $name file" "is" "provides" "specifies" "contains" 107cdf0e10cSrcweir# "represents" "a" "an" "the" 108cdf0e10cSrcweir 109cdf0e10cSrcweirABBREVIATE_BRIEF = 110cdf0e10cSrcweir 111cdf0e10cSrcweir# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 112cdf0e10cSrcweir# Doxygen will generate a detailed section even if there is only a brief 113cdf0e10cSrcweir# description. 114cdf0e10cSrcweir 115cdf0e10cSrcweirALWAYS_DETAILED_SEC = NO 116cdf0e10cSrcweir 117cdf0e10cSrcweir# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 118cdf0e10cSrcweir# inherited members of a class in the documentation of that class as if those 119cdf0e10cSrcweir# members were ordinary class members. Constructors, destructors and assignment 120cdf0e10cSrcweir# operators of the base classes will not be shown. 121cdf0e10cSrcweir 122cdf0e10cSrcweirINLINE_INHERITED_MEMB = YES 123cdf0e10cSrcweir 124cdf0e10cSrcweir# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 125cdf0e10cSrcweir# path before files name in the file list and in the header files. If set 126cdf0e10cSrcweir# to NO the shortest path that makes the file name unique will be used. 127cdf0e10cSrcweir 128cdf0e10cSrcweirFULL_PATH_NAMES = YES 129cdf0e10cSrcweir 130cdf0e10cSrcweir# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 131cdf0e10cSrcweir# can be used to strip a user-defined part of the path. Stripping is 132cdf0e10cSrcweir# only done if one of the specified strings matches the left-hand part of 133cdf0e10cSrcweir# the path. The tag can be used to show relative paths in the file list. 134cdf0e10cSrcweir# If left blank the directory from which doxygen is run is used as the 135cdf0e10cSrcweir# path to strip. 136cdf0e10cSrcweir 137cdf0e10cSrcweirSTRIP_FROM_PATH = 138cdf0e10cSrcweir 139cdf0e10cSrcweir# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 140cdf0e10cSrcweir# the path mentioned in the documentation of a class, which tells 141cdf0e10cSrcweir# the reader which header file to include in order to use a class. 142cdf0e10cSrcweir# If left blank only the name of the header file containing the class 143cdf0e10cSrcweir# definition is used. Otherwise one should specify the include paths that 144cdf0e10cSrcweir# are normally passed to the compiler using the -I flag. 145cdf0e10cSrcweir 146cdf0e10cSrcweirSTRIP_FROM_INC_PATH = 147cdf0e10cSrcweir 148cdf0e10cSrcweir# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 149cdf0e10cSrcweir# (but less readable) file names. This can be useful is your file systems 150cdf0e10cSrcweir# doesn't support long names like on DOS, Mac, or CD-ROM. 151cdf0e10cSrcweir 152cdf0e10cSrcweirSHORT_NAMES = NO 153cdf0e10cSrcweir 154cdf0e10cSrcweir# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 155cdf0e10cSrcweir# will interpret the first line (until the first dot) of a JavaDoc-style 156cdf0e10cSrcweir# comment as the brief description. If set to NO, the JavaDoc 157cdf0e10cSrcweir# comments will behave just like regular Qt-style comments 158cdf0e10cSrcweir# (thus requiring an explicit @brief command for a brief description.) 159cdf0e10cSrcweir 160cdf0e10cSrcweirJAVADOC_AUTOBRIEF = NO 161cdf0e10cSrcweir 162cdf0e10cSrcweir# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 163cdf0e10cSrcweir# interpret the first line (until the first dot) of a Qt-style 164cdf0e10cSrcweir# comment as the brief description. If set to NO, the comments 165cdf0e10cSrcweir# will behave just like regular Qt-style comments (thus requiring 166cdf0e10cSrcweir# an explicit \brief command for a brief description.) 167cdf0e10cSrcweir 168cdf0e10cSrcweirQT_AUTOBRIEF = NO 169cdf0e10cSrcweir 170cdf0e10cSrcweir# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 171cdf0e10cSrcweir# treat a multi-line C++ special comment block (i.e. a block of //! or /// 172cdf0e10cSrcweir# comments) as a brief description. This used to be the default behaviour. 173cdf0e10cSrcweir# The new default is to treat a multi-line C++ comment block as a detailed 174cdf0e10cSrcweir# description. Set this tag to YES if you prefer the old behaviour instead. 175cdf0e10cSrcweir 176cdf0e10cSrcweirMULTILINE_CPP_IS_BRIEF = NO 177cdf0e10cSrcweir 178cdf0e10cSrcweir# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 179cdf0e10cSrcweir# member inherits the documentation from any documented member that it 180cdf0e10cSrcweir# re-implements. 181cdf0e10cSrcweir 182cdf0e10cSrcweirINHERIT_DOCS = YES 183cdf0e10cSrcweir 184cdf0e10cSrcweir# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 185cdf0e10cSrcweir# a new page for each member. If set to NO, the documentation of a member will 186cdf0e10cSrcweir# be part of the file/class/namespace that contains it. 187cdf0e10cSrcweir 188cdf0e10cSrcweirSEPARATE_MEMBER_PAGES = NO 189cdf0e10cSrcweir 190cdf0e10cSrcweir# The TAB_SIZE tag can be used to set the number of spaces in a tab. 191cdf0e10cSrcweir# Doxygen uses this value to replace tabs by spaces in code fragments. 192cdf0e10cSrcweir 193cdf0e10cSrcweirTAB_SIZE = 4 194cdf0e10cSrcweir 195cdf0e10cSrcweir# This tag can be used to specify a number of aliases that acts 196cdf0e10cSrcweir# as commands in the documentation. An alias has the form "name=value". 197cdf0e10cSrcweir# For example adding "sideeffect=\par Side Effects:\n" will allow you to 198cdf0e10cSrcweir# put the command \sideeffect (or @sideeffect) in the documentation, which 199cdf0e10cSrcweir# will result in a user-defined paragraph with heading "Side Effects:". 200cdf0e10cSrcweir# You can put \n's in the value part of an alias to insert newlines. 201cdf0e10cSrcweir 202cdf0e10cSrcweirALIASES = 203cdf0e10cSrcweir 204cdf0e10cSrcweir# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 205cdf0e10cSrcweir# sources only. Doxygen will then generate output that is more tailored for C. 206cdf0e10cSrcweir# For instance, some of the names that are used will be different. The list 207cdf0e10cSrcweir# of all members will be omitted, etc. 208cdf0e10cSrcweir 209cdf0e10cSrcweirOPTIMIZE_OUTPUT_FOR_C = NO 210cdf0e10cSrcweir 211cdf0e10cSrcweir# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 212cdf0e10cSrcweir# sources only. Doxygen will then generate output that is more tailored for 213cdf0e10cSrcweir# Java. For instance, namespaces will be presented as packages, qualified 214cdf0e10cSrcweir# scopes will look different, etc. 215cdf0e10cSrcweir 216cdf0e10cSrcweirOPTIMIZE_OUTPUT_JAVA = NO 217cdf0e10cSrcweir 218cdf0e10cSrcweir# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 219cdf0e10cSrcweir# sources only. Doxygen will then generate output that is more tailored for 220cdf0e10cSrcweir# Fortran. 221cdf0e10cSrcweir 222cdf0e10cSrcweirOPTIMIZE_FOR_FORTRAN = NO 223cdf0e10cSrcweir 224cdf0e10cSrcweir# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 225cdf0e10cSrcweir# sources. Doxygen will then generate output that is tailored for 226cdf0e10cSrcweir# VHDL. 227cdf0e10cSrcweir 228cdf0e10cSrcweirOPTIMIZE_OUTPUT_VHDL = NO 229cdf0e10cSrcweir 230cdf0e10cSrcweir# Doxygen selects the parser to use depending on the extension of the files it parses. 231cdf0e10cSrcweir# With this tag you can assign which parser to use for a given extension. 232cdf0e10cSrcweir# Doxygen has a built-in mapping, but you can override or extend it using this tag. 233cdf0e10cSrcweir# The format is ext=language, where ext is a file extension, and language is one of 234cdf0e10cSrcweir# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, 235cdf0e10cSrcweir# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat 236cdf0e10cSrcweir# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), 237cdf0e10cSrcweir# use: inc=Fortran f=C 238cdf0e10cSrcweir 239cdf0e10cSrcweirEXTENSION_MAPPING = mk=IDL 240cdf0e10cSrcweir 241cdf0e10cSrcweir# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 242cdf0e10cSrcweir# to include (a tag file for) the STL sources as input, then you should 243cdf0e10cSrcweir# set this tag to YES in order to let doxygen match functions declarations and 244cdf0e10cSrcweir# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 245cdf0e10cSrcweir# func(std::string) {}). This also make the inheritance and collaboration 246cdf0e10cSrcweir# diagrams that involve STL classes more complete and accurate. 247cdf0e10cSrcweir 248cdf0e10cSrcweirBUILTIN_STL_SUPPORT = NO 249cdf0e10cSrcweir 250cdf0e10cSrcweir# If you use Microsoft's C++/CLI language, you should set this option to YES to 251cdf0e10cSrcweir# enable parsing support. 252cdf0e10cSrcweir 253cdf0e10cSrcweirCPP_CLI_SUPPORT = NO 254cdf0e10cSrcweir 255cdf0e10cSrcweir# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 256cdf0e10cSrcweir# Doxygen will parse them like normal C++ but will assume all classes use public 257cdf0e10cSrcweir# instead of private inheritance when no explicit protection keyword is present. 258cdf0e10cSrcweir 259cdf0e10cSrcweirSIP_SUPPORT = NO 260cdf0e10cSrcweir 261cdf0e10cSrcweir# For Microsoft's IDL there are propget and propput attributes to indicate getter 262cdf0e10cSrcweir# and setter methods for a property. Setting this option to YES (the default) 263cdf0e10cSrcweir# will make doxygen to replace the get and set methods by a property in the 264cdf0e10cSrcweir# documentation. This will only work if the methods are indeed getting or 265cdf0e10cSrcweir# setting a simple type. If this is not the case, or you want to show the 266cdf0e10cSrcweir# methods anyway, you should set this option to NO. 267cdf0e10cSrcweir 268cdf0e10cSrcweirIDL_PROPERTY_SUPPORT = YES 269cdf0e10cSrcweir 270cdf0e10cSrcweir# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 271cdf0e10cSrcweir# tag is set to YES, then doxygen will reuse the documentation of the first 272cdf0e10cSrcweir# member in the group (if any) for the other members of the group. By default 273cdf0e10cSrcweir# all members of a group must be documented explicitly. 274cdf0e10cSrcweir 275cdf0e10cSrcweirDISTRIBUTE_GROUP_DOC = NO 276cdf0e10cSrcweir 277cdf0e10cSrcweir# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 278cdf0e10cSrcweir# the same type (for instance a group of public functions) to be put as a 279cdf0e10cSrcweir# subgroup of that type (e.g. under the Public Functions section). Set it to 280cdf0e10cSrcweir# NO to prevent subgrouping. Alternatively, this can be done per class using 281cdf0e10cSrcweir# the \nosubgrouping command. 282cdf0e10cSrcweir 283cdf0e10cSrcweirSUBGROUPING = YES 284cdf0e10cSrcweir 285cdf0e10cSrcweir# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 286cdf0e10cSrcweir# is documented as struct, union, or enum with the name of the typedef. So 287cdf0e10cSrcweir# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 288cdf0e10cSrcweir# with name TypeT. When disabled the typedef will appear as a member of a file, 289cdf0e10cSrcweir# namespace, or class. And the struct will be named TypeS. This can typically 290cdf0e10cSrcweir# be useful for C code in case the coding convention dictates that all compound 291cdf0e10cSrcweir# types are typedef'ed and only the typedef is referenced, never the tag name. 292cdf0e10cSrcweir 293cdf0e10cSrcweirTYPEDEF_HIDES_STRUCT = NO 294cdf0e10cSrcweir 295cdf0e10cSrcweir# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 296cdf0e10cSrcweir# determine which symbols to keep in memory and which to flush to disk. 297cdf0e10cSrcweir# When the cache is full, less often used symbols will be written to disk. 298cdf0e10cSrcweir# For small to medium size projects (<1000 input files) the default value is 299cdf0e10cSrcweir# probably good enough. For larger projects a too small cache size can cause 300cdf0e10cSrcweir# doxygen to be busy swapping symbols to and from disk most of the time 301cdf0e10cSrcweir# causing a significant performance penality. 302cdf0e10cSrcweir# If the system has enough physical memory increasing the cache will improve the 303cdf0e10cSrcweir# performance by keeping more symbols in memory. Note that the value works on 304cdf0e10cSrcweir# a logarithmic scale so increasing the size by one will rougly double the 305cdf0e10cSrcweir# memory usage. The cache size is given by this formula: 306cdf0e10cSrcweir# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 307cdf0e10cSrcweir# corresponding to a cache size of 2^16 = 65536 symbols 308cdf0e10cSrcweir 309cdf0e10cSrcweirSYMBOL_CACHE_SIZE = 0 310cdf0e10cSrcweir 311cdf0e10cSrcweir#--------------------------------------------------------------------------- 312cdf0e10cSrcweir# Build related configuration options 313cdf0e10cSrcweir#--------------------------------------------------------------------------- 314cdf0e10cSrcweir 315cdf0e10cSrcweir# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 316cdf0e10cSrcweir# documentation are documented, even if no documentation was available. 317cdf0e10cSrcweir# Private class members and static file members will be hidden unless 318cdf0e10cSrcweir# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 319cdf0e10cSrcweir 320cdf0e10cSrcweirEXTRACT_ALL = YES 321cdf0e10cSrcweir 322cdf0e10cSrcweir# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 323cdf0e10cSrcweir# will be included in the documentation. 324cdf0e10cSrcweir 325cdf0e10cSrcweirEXTRACT_PRIVATE = YES 326cdf0e10cSrcweir 327cdf0e10cSrcweir# If the EXTRACT_STATIC tag is set to YES all static members of a file 328cdf0e10cSrcweir# will be included in the documentation. 329cdf0e10cSrcweir 330cdf0e10cSrcweirEXTRACT_STATIC = YES 331cdf0e10cSrcweir 332cdf0e10cSrcweir# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 333cdf0e10cSrcweir# defined locally in source files will be included in the documentation. 334cdf0e10cSrcweir# If set to NO only classes defined in header files are included. 335cdf0e10cSrcweir 336cdf0e10cSrcweirEXTRACT_LOCAL_CLASSES = YES 337cdf0e10cSrcweir 338cdf0e10cSrcweir# This flag is only useful for Objective-C code. When set to YES local 339cdf0e10cSrcweir# methods, which are defined in the implementation section but not in 340cdf0e10cSrcweir# the interface are included in the documentation. 341cdf0e10cSrcweir# If set to NO (the default) only methods in the interface are included. 342cdf0e10cSrcweir 343cdf0e10cSrcweirEXTRACT_LOCAL_METHODS = NO 344cdf0e10cSrcweir 345cdf0e10cSrcweir# If this flag is set to YES, the members of anonymous namespaces will be 346cdf0e10cSrcweir# extracted and appear in the documentation as a namespace called 347cdf0e10cSrcweir# 'anonymous_namespace{file}', where file will be replaced with the base 348cdf0e10cSrcweir# name of the file that contains the anonymous namespace. By default 349cdf0e10cSrcweir# anonymous namespace are hidden. 350cdf0e10cSrcweir 351cdf0e10cSrcweirEXTRACT_ANON_NSPACES = NO 352cdf0e10cSrcweir 353cdf0e10cSrcweir# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 354cdf0e10cSrcweir# undocumented members of documented classes, files or namespaces. 355cdf0e10cSrcweir# If set to NO (the default) these members will be included in the 356cdf0e10cSrcweir# various overviews, but no documentation section is generated. 357cdf0e10cSrcweir# This option has no effect if EXTRACT_ALL is enabled. 358cdf0e10cSrcweir 359cdf0e10cSrcweirHIDE_UNDOC_MEMBERS = NO 360cdf0e10cSrcweir 361cdf0e10cSrcweir# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 362cdf0e10cSrcweir# undocumented classes that are normally visible in the class hierarchy. 363cdf0e10cSrcweir# If set to NO (the default) these classes will be included in the various 364cdf0e10cSrcweir# overviews. This option has no effect if EXTRACT_ALL is enabled. 365cdf0e10cSrcweir 366cdf0e10cSrcweirHIDE_UNDOC_CLASSES = NO 367cdf0e10cSrcweir 368cdf0e10cSrcweir# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 369cdf0e10cSrcweir# friend (class|struct|union) declarations. 370cdf0e10cSrcweir# If set to NO (the default) these declarations will be included in the 371cdf0e10cSrcweir# documentation. 372cdf0e10cSrcweir 373cdf0e10cSrcweirHIDE_FRIEND_COMPOUNDS = NO 374cdf0e10cSrcweir 375cdf0e10cSrcweir# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 376cdf0e10cSrcweir# documentation blocks found inside the body of a function. 377cdf0e10cSrcweir# If set to NO (the default) these blocks will be appended to the 378cdf0e10cSrcweir# function's detailed documentation block. 379cdf0e10cSrcweir 380cdf0e10cSrcweirHIDE_IN_BODY_DOCS = NO 381cdf0e10cSrcweir 382cdf0e10cSrcweir# The INTERNAL_DOCS tag determines if documentation 383cdf0e10cSrcweir# that is typed after a \internal command is included. If the tag is set 384cdf0e10cSrcweir# to NO (the default) then the documentation will be excluded. 385cdf0e10cSrcweir# Set it to YES to include the internal documentation. 386cdf0e10cSrcweir 387cdf0e10cSrcweirINTERNAL_DOCS = NO 388cdf0e10cSrcweir 389cdf0e10cSrcweir# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 390cdf0e10cSrcweir# file names in lower-case letters. If set to YES upper-case letters are also 391cdf0e10cSrcweir# allowed. This is useful if you have classes or files whose names only differ 392cdf0e10cSrcweir# in case and if your file system supports case sensitive file names. Windows 393cdf0e10cSrcweir# and Mac users are advised to set this option to NO. 394cdf0e10cSrcweir 395cdf0e10cSrcweirCASE_SENSE_NAMES = YES 396cdf0e10cSrcweir 397cdf0e10cSrcweir# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 398cdf0e10cSrcweir# will show members with their full class and namespace scopes in the 399cdf0e10cSrcweir# documentation. If set to YES the scope will be hidden. 400cdf0e10cSrcweir 401cdf0e10cSrcweirHIDE_SCOPE_NAMES = NO 402cdf0e10cSrcweir 403cdf0e10cSrcweir# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 404cdf0e10cSrcweir# will put a list of the files that are included by a file in the documentation 405cdf0e10cSrcweir# of that file. 406cdf0e10cSrcweir 407cdf0e10cSrcweirSHOW_INCLUDE_FILES = YES 408cdf0e10cSrcweir 409cdf0e10cSrcweir# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 410cdf0e10cSrcweir# is inserted in the documentation for inline members. 411cdf0e10cSrcweir 412cdf0e10cSrcweirINLINE_INFO = YES 413cdf0e10cSrcweir 414cdf0e10cSrcweir# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 415cdf0e10cSrcweir# will sort the (detailed) documentation of file and class members 416cdf0e10cSrcweir# alphabetically by member name. If set to NO the members will appear in 417cdf0e10cSrcweir# declaration order. 418cdf0e10cSrcweir 419cdf0e10cSrcweirSORT_MEMBER_DOCS = YES 420cdf0e10cSrcweir 421cdf0e10cSrcweir# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 422cdf0e10cSrcweir# brief documentation of file, namespace and class members alphabetically 423cdf0e10cSrcweir# by member name. If set to NO (the default) the members will appear in 424cdf0e10cSrcweir# declaration order. 425cdf0e10cSrcweir 426cdf0e10cSrcweirSORT_BRIEF_DOCS = NO 427cdf0e10cSrcweir 428cdf0e10cSrcweir# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 429cdf0e10cSrcweir# hierarchy of group names into alphabetical order. If set to NO (the default) 430cdf0e10cSrcweir# the group names will appear in their defined order. 431cdf0e10cSrcweir 432cdf0e10cSrcweirSORT_GROUP_NAMES = NO 433cdf0e10cSrcweir 434cdf0e10cSrcweir# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 435cdf0e10cSrcweir# sorted by fully-qualified names, including namespaces. If set to 436cdf0e10cSrcweir# NO (the default), the class list will be sorted only by class name, 437cdf0e10cSrcweir# not including the namespace part. 438cdf0e10cSrcweir# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 439cdf0e10cSrcweir# Note: This option applies only to the class list, not to the 440cdf0e10cSrcweir# alphabetical list. 441cdf0e10cSrcweir 442cdf0e10cSrcweirSORT_BY_SCOPE_NAME = NO 443cdf0e10cSrcweir 444cdf0e10cSrcweir# The GENERATE_TODOLIST tag can be used to enable (YES) or 445cdf0e10cSrcweir# disable (NO) the todo list. This list is created by putting \todo 446cdf0e10cSrcweir# commands in the documentation. 447cdf0e10cSrcweir 448cdf0e10cSrcweirGENERATE_TODOLIST = YES 449cdf0e10cSrcweir 450cdf0e10cSrcweir# The GENERATE_TESTLIST tag can be used to enable (YES) or 451cdf0e10cSrcweir# disable (NO) the test list. This list is created by putting \test 452cdf0e10cSrcweir# commands in the documentation. 453cdf0e10cSrcweir 454cdf0e10cSrcweirGENERATE_TESTLIST = YES 455cdf0e10cSrcweir 456cdf0e10cSrcweir# The GENERATE_BUGLIST tag can be used to enable (YES) or 457cdf0e10cSrcweir# disable (NO) the bug list. This list is created by putting \bug 458cdf0e10cSrcweir# commands in the documentation. 459cdf0e10cSrcweir 460cdf0e10cSrcweirGENERATE_BUGLIST = YES 461cdf0e10cSrcweir 462cdf0e10cSrcweir# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 463cdf0e10cSrcweir# disable (NO) the deprecated list. This list is created by putting 464cdf0e10cSrcweir# \deprecated commands in the documentation. 465cdf0e10cSrcweir 466cdf0e10cSrcweirGENERATE_DEPRECATEDLIST= YES 467cdf0e10cSrcweir 468cdf0e10cSrcweir# The ENABLED_SECTIONS tag can be used to enable conditional 469cdf0e10cSrcweir# documentation sections, marked by \if sectionname ... \endif. 470cdf0e10cSrcweir 471cdf0e10cSrcweirENABLED_SECTIONS = 472cdf0e10cSrcweir 473cdf0e10cSrcweir# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 474cdf0e10cSrcweir# the initial value of a variable or define consists of for it to appear in 475cdf0e10cSrcweir# the documentation. If the initializer consists of more lines than specified 476cdf0e10cSrcweir# here it will be hidden. Use a value of 0 to hide initializers completely. 477cdf0e10cSrcweir# The appearance of the initializer of individual variables and defines in the 478cdf0e10cSrcweir# documentation can be controlled using \showinitializer or \hideinitializer 479cdf0e10cSrcweir# command in the documentation regardless of this setting. 480cdf0e10cSrcweir 481cdf0e10cSrcweirMAX_INITIALIZER_LINES = 30 482cdf0e10cSrcweir 483cdf0e10cSrcweir# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 484cdf0e10cSrcweir# at the bottom of the documentation of classes and structs. If set to YES the 485cdf0e10cSrcweir# list will mention the files that were used to generate the documentation. 486cdf0e10cSrcweir 487cdf0e10cSrcweirSHOW_USED_FILES = YES 488cdf0e10cSrcweir 489cdf0e10cSrcweir# If the sources in your project are distributed over multiple directories 490cdf0e10cSrcweir# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 491cdf0e10cSrcweir# in the documentation. The default is NO. 492cdf0e10cSrcweir 493cdf0e10cSrcweirSHOW_DIRECTORIES = NO 494cdf0e10cSrcweir 495cdf0e10cSrcweir# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 496cdf0e10cSrcweir# This will remove the Files entry from the Quick Index and from the 497cdf0e10cSrcweir# Folder Tree View (if specified). The default is YES. 498cdf0e10cSrcweir 499cdf0e10cSrcweirSHOW_FILES = YES 500cdf0e10cSrcweir 501cdf0e10cSrcweir# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 502cdf0e10cSrcweir# Namespaces page. 503cdf0e10cSrcweir# This will remove the Namespaces entry from the Quick Index 504cdf0e10cSrcweir# and from the Folder Tree View (if specified). The default is YES. 505cdf0e10cSrcweir 506cdf0e10cSrcweirSHOW_NAMESPACES = YES 507cdf0e10cSrcweir 508cdf0e10cSrcweir# The FILE_VERSION_FILTER tag can be used to specify a program or script that 509cdf0e10cSrcweir# doxygen should invoke to get the current version for each file (typically from 510cdf0e10cSrcweir# the version control system). Doxygen will invoke the program by executing (via 511cdf0e10cSrcweir# popen()) the command <command> <input-file>, where <command> is the value of 512cdf0e10cSrcweir# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 513cdf0e10cSrcweir# provided by doxygen. Whatever the program writes to standard output 514cdf0e10cSrcweir# is used as the file version. See the manual for examples. 515cdf0e10cSrcweir 516cdf0e10cSrcweirFILE_VERSION_FILTER = 517cdf0e10cSrcweir 518cdf0e10cSrcweir# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by 519cdf0e10cSrcweir# doxygen. The layout file controls the global structure of the generated output files 520cdf0e10cSrcweir# in an output format independent way. The create the layout file that represents 521cdf0e10cSrcweir# doxygen's defaults, run doxygen with the -l option. You can optionally specify a 522cdf0e10cSrcweir# file name after the option, if omitted DoxygenLayout.xml will be used as the name 523cdf0e10cSrcweir# of the layout file. 524cdf0e10cSrcweir 525cdf0e10cSrcweirLAYOUT_FILE = 526cdf0e10cSrcweir 527cdf0e10cSrcweir#--------------------------------------------------------------------------- 528cdf0e10cSrcweir# configuration options related to warning and progress messages 529cdf0e10cSrcweir#--------------------------------------------------------------------------- 530cdf0e10cSrcweir 531cdf0e10cSrcweir# The QUIET tag can be used to turn on/off the messages that are generated 532cdf0e10cSrcweir# by doxygen. Possible values are YES and NO. If left blank NO is used. 533cdf0e10cSrcweir 534cdf0e10cSrcweirQUIET = NO 535cdf0e10cSrcweir 536cdf0e10cSrcweir# The WARNINGS tag can be used to turn on/off the warning messages that are 537cdf0e10cSrcweir# generated by doxygen. Possible values are YES and NO. If left blank 538cdf0e10cSrcweir# NO is used. 539cdf0e10cSrcweir 540cdf0e10cSrcweirWARNINGS = YES 541cdf0e10cSrcweir 542cdf0e10cSrcweir# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 543cdf0e10cSrcweir# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 544cdf0e10cSrcweir# automatically be disabled. 545cdf0e10cSrcweir 546cdf0e10cSrcweirWARN_IF_UNDOCUMENTED = YES 547cdf0e10cSrcweir 548cdf0e10cSrcweir# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 549cdf0e10cSrcweir# potential errors in the documentation, such as not documenting some 550cdf0e10cSrcweir# parameters in a documented function, or documenting parameters that 551cdf0e10cSrcweir# don't exist or using markup commands wrongly. 552cdf0e10cSrcweir 553cdf0e10cSrcweirWARN_IF_DOC_ERROR = YES 554cdf0e10cSrcweir 555cdf0e10cSrcweir# This WARN_NO_PARAMDOC option can be abled to get warnings for 556cdf0e10cSrcweir# functions that are documented, but have no documentation for their parameters 557cdf0e10cSrcweir# or return value. If set to NO (the default) doxygen will only warn about 558cdf0e10cSrcweir# wrong or incomplete parameter documentation, but not about the absence of 559cdf0e10cSrcweir# documentation. 560cdf0e10cSrcweir 561cdf0e10cSrcweirWARN_NO_PARAMDOC = NO 562cdf0e10cSrcweir 563cdf0e10cSrcweir# The WARN_FORMAT tag determines the format of the warning messages that 564cdf0e10cSrcweir# doxygen can produce. The string should contain the $file, $line, and $text 565cdf0e10cSrcweir# tags, which will be replaced by the file and line number from which the 566cdf0e10cSrcweir# warning originated and the warning text. Optionally the format may contain 567cdf0e10cSrcweir# $version, which will be replaced by the version of the file (if it could 568cdf0e10cSrcweir# be obtained via FILE_VERSION_FILTER) 569cdf0e10cSrcweir 570cdf0e10cSrcweirWARN_FORMAT = "$file:$line: $text" 571cdf0e10cSrcweir 572cdf0e10cSrcweir# The WARN_LOGFILE tag can be used to specify a file to which warning 573cdf0e10cSrcweir# and error messages should be written. If left blank the output is written 574cdf0e10cSrcweir# to stderr. 575cdf0e10cSrcweir 576cdf0e10cSrcweirWARN_LOGFILE = 577cdf0e10cSrcweir 578cdf0e10cSrcweir#--------------------------------------------------------------------------- 579cdf0e10cSrcweir# configuration options related to the input files 580cdf0e10cSrcweir#--------------------------------------------------------------------------- 581cdf0e10cSrcweir 582cdf0e10cSrcweir# The INPUT tag can be used to specify the files and/or directories that contain 583cdf0e10cSrcweir# documented source files. You may enter file names like "myfile.cpp" or 584cdf0e10cSrcweir# directories like "/usr/src/myproject". Separate the files or directories 585cdf0e10cSrcweir# with spaces. 586cdf0e10cSrcweir 587cdf0e10cSrcweirINPUT = solenv/gbuild 588cdf0e10cSrcweir 589cdf0e10cSrcweir# This tag can be used to specify the character encoding of the source files 590cdf0e10cSrcweir# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 591cdf0e10cSrcweir# also the default input encoding. Doxygen uses libiconv (or the iconv built 592cdf0e10cSrcweir# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 593cdf0e10cSrcweir# the list of possible encodings. 594cdf0e10cSrcweir 595cdf0e10cSrcweirINPUT_ENCODING = UTF-8 596cdf0e10cSrcweir 597cdf0e10cSrcweir# If the value of the INPUT tag contains directories, you can use the 598cdf0e10cSrcweir# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 599cdf0e10cSrcweir# and *.h) to filter out the source-files in the directories. If left 600cdf0e10cSrcweir# blank the following patterns are tested: 601cdf0e10cSrcweir# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 602cdf0e10cSrcweir# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 603cdf0e10cSrcweir 604cdf0e10cSrcweirFILE_PATTERNS = *.mk 605cdf0e10cSrcweir 606cdf0e10cSrcweir# The RECURSIVE tag can be used to turn specify whether or not subdirectories 607cdf0e10cSrcweir# should be searched for input files as well. Possible values are YES and NO. 608cdf0e10cSrcweir# If left blank NO is used. 609cdf0e10cSrcweir 610cdf0e10cSrcweirRECURSIVE = YES 611cdf0e10cSrcweir 612cdf0e10cSrcweir# The EXCLUDE tag can be used to specify files and/or directories that should 613cdf0e10cSrcweir# excluded from the INPUT source files. This way you can easily exclude a 614cdf0e10cSrcweir# subdirectory from a directory tree whose root is specified with the INPUT tag. 615cdf0e10cSrcweir 616cdf0e10cSrcweirEXCLUDE = 617cdf0e10cSrcweir 618cdf0e10cSrcweir# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 619cdf0e10cSrcweir# directories that are symbolic links (a Unix filesystem feature) are excluded 620cdf0e10cSrcweir# from the input. 621cdf0e10cSrcweir 622cdf0e10cSrcweirEXCLUDE_SYMLINKS = NO 623cdf0e10cSrcweir 624cdf0e10cSrcweir# If the value of the INPUT tag contains directories, you can use the 625cdf0e10cSrcweir# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 626cdf0e10cSrcweir# certain files from those directories. Note that the wildcards are matched 627cdf0e10cSrcweir# against the file with absolute path, so to exclude all test directories 628cdf0e10cSrcweir# for example use the pattern */test/* 629cdf0e10cSrcweir 630cdf0e10cSrcweirEXCLUDE_PATTERNS = 631cdf0e10cSrcweir 632cdf0e10cSrcweir# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 633cdf0e10cSrcweir# (namespaces, classes, functions, etc.) that should be excluded from the 634cdf0e10cSrcweir# output. The symbol name can be a fully qualified name, a word, or if the 635cdf0e10cSrcweir# wildcard * is used, a substring. Examples: ANamespace, AClass, 636cdf0e10cSrcweir# AClass::ANamespace, ANamespace::*Test 637cdf0e10cSrcweir 638cdf0e10cSrcweirEXCLUDE_SYMBOLS = 639cdf0e10cSrcweir 640cdf0e10cSrcweir# The EXAMPLE_PATH tag can be used to specify one or more files or 641cdf0e10cSrcweir# directories that contain example code fragments that are included (see 642cdf0e10cSrcweir# the \include command). 643cdf0e10cSrcweir 644cdf0e10cSrcweirEXAMPLE_PATH = 645cdf0e10cSrcweir 646cdf0e10cSrcweir# If the value of the EXAMPLE_PATH tag contains directories, you can use the 647cdf0e10cSrcweir# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 648cdf0e10cSrcweir# and *.h) to filter out the source-files in the directories. If left 649cdf0e10cSrcweir# blank all files are included. 650cdf0e10cSrcweir 651cdf0e10cSrcweirEXAMPLE_PATTERNS = 652cdf0e10cSrcweir 653cdf0e10cSrcweir# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 654cdf0e10cSrcweir# searched for input files to be used with the \include or \dontinclude 655cdf0e10cSrcweir# commands irrespective of the value of the RECURSIVE tag. 656cdf0e10cSrcweir# Possible values are YES and NO. If left blank NO is used. 657cdf0e10cSrcweir 658cdf0e10cSrcweirEXAMPLE_RECURSIVE = NO 659cdf0e10cSrcweir 660cdf0e10cSrcweir# The IMAGE_PATH tag can be used to specify one or more files or 661cdf0e10cSrcweir# directories that contain image that are included in the documentation (see 662cdf0e10cSrcweir# the \image command). 663cdf0e10cSrcweir 664cdf0e10cSrcweirIMAGE_PATH = 665cdf0e10cSrcweir 666cdf0e10cSrcweir# The INPUT_FILTER tag can be used to specify a program that doxygen should 667cdf0e10cSrcweir# invoke to filter for each input file. Doxygen will invoke the filter program 668cdf0e10cSrcweir# by executing (via popen()) the command <filter> <input-file>, where <filter> 669cdf0e10cSrcweir# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 670cdf0e10cSrcweir# input file. Doxygen will then use the output that the filter program writes 671cdf0e10cSrcweir# to standard output. 672cdf0e10cSrcweir# If FILTER_PATTERNS is specified, this tag will be 673cdf0e10cSrcweir# ignored. 674cdf0e10cSrcweir 675cdf0e10cSrcweirINPUT_FILTER = 676cdf0e10cSrcweir 677cdf0e10cSrcweir# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 678cdf0e10cSrcweir# basis. 679cdf0e10cSrcweir# Doxygen will compare the file name with each pattern and apply the 680cdf0e10cSrcweir# filter if there is a match. 681cdf0e10cSrcweir# The filters are a list of the form: 682cdf0e10cSrcweir# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 683cdf0e10cSrcweir# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 684cdf0e10cSrcweir# is applied to all files. 685cdf0e10cSrcweir 686cdf0e10cSrcweirFILTER_PATTERNS = 687cdf0e10cSrcweir 688cdf0e10cSrcweir# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 689cdf0e10cSrcweir# INPUT_FILTER) will be used to filter the input files when producing source 690cdf0e10cSrcweir# files to browse (i.e. when SOURCE_BROWSER is set to YES). 691cdf0e10cSrcweir 692cdf0e10cSrcweirFILTER_SOURCE_FILES = NO 693cdf0e10cSrcweir 694cdf0e10cSrcweir#--------------------------------------------------------------------------- 695cdf0e10cSrcweir# configuration options related to source browsing 696cdf0e10cSrcweir#--------------------------------------------------------------------------- 697cdf0e10cSrcweir 698cdf0e10cSrcweir# If the SOURCE_BROWSER tag is set to YES then a list of source files will 699cdf0e10cSrcweir# be generated. Documented entities will be cross-referenced with these sources. 700cdf0e10cSrcweir# Note: To get rid of all source code in the generated output, make sure also 701cdf0e10cSrcweir# VERBATIM_HEADERS is set to NO. 702cdf0e10cSrcweir 703cdf0e10cSrcweirSOURCE_BROWSER = NO 704cdf0e10cSrcweir 705cdf0e10cSrcweir# Setting the INLINE_SOURCES tag to YES will include the body 706cdf0e10cSrcweir# of functions and classes directly in the documentation. 707cdf0e10cSrcweir 708cdf0e10cSrcweirINLINE_SOURCES = NO 709cdf0e10cSrcweir 710cdf0e10cSrcweir# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 711cdf0e10cSrcweir# doxygen to hide any special comment blocks from generated source code 712cdf0e10cSrcweir# fragments. Normal C and C++ comments will always remain visible. 713cdf0e10cSrcweir 714cdf0e10cSrcweirSTRIP_CODE_COMMENTS = YES 715cdf0e10cSrcweir 716cdf0e10cSrcweir# If the REFERENCED_BY_RELATION tag is set to YES 717cdf0e10cSrcweir# then for each documented function all documented 718cdf0e10cSrcweir# functions referencing it will be listed. 719cdf0e10cSrcweir 720cdf0e10cSrcweirREFERENCED_BY_RELATION = NO 721cdf0e10cSrcweir 722cdf0e10cSrcweir# If the REFERENCES_RELATION tag is set to YES 723cdf0e10cSrcweir# then for each documented function all documented entities 724cdf0e10cSrcweir# called/used by that function will be listed. 725cdf0e10cSrcweir 726cdf0e10cSrcweirREFERENCES_RELATION = NO 727cdf0e10cSrcweir 728cdf0e10cSrcweir# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 729cdf0e10cSrcweir# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 730cdf0e10cSrcweir# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 731cdf0e10cSrcweir# link to the source code. 732cdf0e10cSrcweir# Otherwise they will link to the documentation. 733cdf0e10cSrcweir 734cdf0e10cSrcweirREFERENCES_LINK_SOURCE = YES 735cdf0e10cSrcweir 736cdf0e10cSrcweir# If the USE_HTAGS tag is set to YES then the references to source code 737cdf0e10cSrcweir# will point to the HTML generated by the htags(1) tool instead of doxygen 738cdf0e10cSrcweir# built-in source browser. The htags tool is part of GNU's global source 739cdf0e10cSrcweir# tagging system (see http://www.gnu.org/software/global/global.html). You 740cdf0e10cSrcweir# will need version 4.8.6 or higher. 741cdf0e10cSrcweir 742cdf0e10cSrcweirUSE_HTAGS = NO 743cdf0e10cSrcweir 744cdf0e10cSrcweir# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 745cdf0e10cSrcweir# will generate a verbatim copy of the header file for each class for 746cdf0e10cSrcweir# which an include is specified. Set to NO to disable this. 747cdf0e10cSrcweir 748cdf0e10cSrcweirVERBATIM_HEADERS = YES 749cdf0e10cSrcweir 750cdf0e10cSrcweir#--------------------------------------------------------------------------- 751cdf0e10cSrcweir# configuration options related to the alphabetical class index 752cdf0e10cSrcweir#--------------------------------------------------------------------------- 753cdf0e10cSrcweir 754cdf0e10cSrcweir# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 755cdf0e10cSrcweir# of all compounds will be generated. Enable this if the project 756cdf0e10cSrcweir# contains a lot of classes, structs, unions or interfaces. 757cdf0e10cSrcweir 758cdf0e10cSrcweirALPHABETICAL_INDEX = NO 759cdf0e10cSrcweir 760cdf0e10cSrcweir# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 761cdf0e10cSrcweir# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 762cdf0e10cSrcweir# in which this list will be split (can be a number in the range [1..20]) 763cdf0e10cSrcweir 764cdf0e10cSrcweirCOLS_IN_ALPHA_INDEX = 5 765cdf0e10cSrcweir 766cdf0e10cSrcweir# In case all classes in a project start with a common prefix, all 767cdf0e10cSrcweir# classes will be put under the same header in the alphabetical index. 768cdf0e10cSrcweir# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 769cdf0e10cSrcweir# should be ignored while generating the index headers. 770cdf0e10cSrcweir 771cdf0e10cSrcweirIGNORE_PREFIX = 772cdf0e10cSrcweir 773cdf0e10cSrcweir#--------------------------------------------------------------------------- 774cdf0e10cSrcweir# configuration options related to the HTML output 775cdf0e10cSrcweir#--------------------------------------------------------------------------- 776cdf0e10cSrcweir 777cdf0e10cSrcweir# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 778cdf0e10cSrcweir# generate HTML output. 779cdf0e10cSrcweir 780cdf0e10cSrcweirGENERATE_HTML = YES 781cdf0e10cSrcweir 782cdf0e10cSrcweir# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 783cdf0e10cSrcweir# If a relative path is entered the value of OUTPUT_DIRECTORY will be 784cdf0e10cSrcweir# put in front of it. If left blank `html' will be used as the default path. 785cdf0e10cSrcweir 786cdf0e10cSrcweirHTML_OUTPUT = html 787cdf0e10cSrcweir 788cdf0e10cSrcweir# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 789cdf0e10cSrcweir# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 790cdf0e10cSrcweir# doxygen will generate files with .html extension. 791cdf0e10cSrcweir 792cdf0e10cSrcweirHTML_FILE_EXTENSION = .html 793cdf0e10cSrcweir 794cdf0e10cSrcweir# The HTML_HEADER tag can be used to specify a personal HTML header for 795cdf0e10cSrcweir# each generated HTML page. If it is left blank doxygen will generate a 796cdf0e10cSrcweir# standard header. 797cdf0e10cSrcweir 798cdf0e10cSrcweirHTML_HEADER = 799cdf0e10cSrcweir 800cdf0e10cSrcweir# The HTML_FOOTER tag can be used to specify a personal HTML footer for 801cdf0e10cSrcweir# each generated HTML page. If it is left blank doxygen will generate a 802cdf0e10cSrcweir# standard footer. 803cdf0e10cSrcweir 804cdf0e10cSrcweirHTML_FOOTER = 805cdf0e10cSrcweir 806cdf0e10cSrcweir# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 807cdf0e10cSrcweir# style sheet that is used by each HTML page. It can be used to 808cdf0e10cSrcweir# fine-tune the look of the HTML output. If the tag is left blank doxygen 809cdf0e10cSrcweir# will generate a default style sheet. Note that doxygen will try to copy 810cdf0e10cSrcweir# the style sheet file to the HTML output directory, so don't put your own 811cdf0e10cSrcweir# stylesheet in the HTML output directory as well, or it will be erased! 812cdf0e10cSrcweir 813cdf0e10cSrcweirHTML_STYLESHEET = 814cdf0e10cSrcweir 815cdf0e10cSrcweir# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 816cdf0e10cSrcweir# files or namespaces will be aligned in HTML using tables. If set to 817cdf0e10cSrcweir# NO a bullet list will be used. 818cdf0e10cSrcweir 819cdf0e10cSrcweirHTML_ALIGN_MEMBERS = YES 820cdf0e10cSrcweir 821cdf0e10cSrcweir# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 822cdf0e10cSrcweir# documentation will contain sections that can be hidden and shown after the 823cdf0e10cSrcweir# page has loaded. For this to work a browser that supports 824cdf0e10cSrcweir# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 825cdf0e10cSrcweir# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 826cdf0e10cSrcweir 827cdf0e10cSrcweirHTML_DYNAMIC_SECTIONS = NO 828cdf0e10cSrcweir 829cdf0e10cSrcweir# If the GENERATE_DOCSET tag is set to YES, additional index files 830cdf0e10cSrcweir# will be generated that can be used as input for Apple's Xcode 3 831cdf0e10cSrcweir# integrated development environment, introduced with OSX 10.5 (Leopard). 832cdf0e10cSrcweir# To create a documentation set, doxygen will generate a Makefile in the 833cdf0e10cSrcweir# HTML output directory. Running make will produce the docset in that 834cdf0e10cSrcweir# directory and running "make install" will install the docset in 835cdf0e10cSrcweir# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 836cdf0e10cSrcweir# it at startup. 837cdf0e10cSrcweir# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. 838cdf0e10cSrcweir 839cdf0e10cSrcweirGENERATE_DOCSET = NO 840cdf0e10cSrcweir 841cdf0e10cSrcweir# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 842cdf0e10cSrcweir# feed. A documentation feed provides an umbrella under which multiple 843cdf0e10cSrcweir# documentation sets from a single provider (such as a company or product suite) 844cdf0e10cSrcweir# can be grouped. 845cdf0e10cSrcweir 846cdf0e10cSrcweirDOCSET_FEEDNAME = "Doxygen generated docs" 847cdf0e10cSrcweir 848cdf0e10cSrcweir# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 849cdf0e10cSrcweir# should uniquely identify the documentation set bundle. This should be a 850cdf0e10cSrcweir# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 851cdf0e10cSrcweir# will append .docset to the name. 852cdf0e10cSrcweir 853cdf0e10cSrcweirDOCSET_BUNDLE_ID = org.openoffice.gbuild 854cdf0e10cSrcweir 855cdf0e10cSrcweir# If the GENERATE_HTMLHELP tag is set to YES, additional index files 856cdf0e10cSrcweir# will be generated that can be used as input for tools like the 857cdf0e10cSrcweir# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 858cdf0e10cSrcweir# of the generated HTML documentation. 859cdf0e10cSrcweir 860cdf0e10cSrcweirGENERATE_HTMLHELP = NO 861cdf0e10cSrcweir 862cdf0e10cSrcweir# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 863cdf0e10cSrcweir# be used to specify the file name of the resulting .chm file. You 864cdf0e10cSrcweir# can add a path in front of the file if the result should not be 865cdf0e10cSrcweir# written to the html output directory. 866cdf0e10cSrcweir 867cdf0e10cSrcweirCHM_FILE = 868cdf0e10cSrcweir 869cdf0e10cSrcweir# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 870cdf0e10cSrcweir# be used to specify the location (absolute path including file name) of 871cdf0e10cSrcweir# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 872cdf0e10cSrcweir# the HTML help compiler on the generated index.hhp. 873cdf0e10cSrcweir 874cdf0e10cSrcweirHHC_LOCATION = 875cdf0e10cSrcweir 876cdf0e10cSrcweir# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 877cdf0e10cSrcweir# controls if a separate .chi index file is generated (YES) or that 878cdf0e10cSrcweir# it should be included in the master .chm file (NO). 879cdf0e10cSrcweir 880cdf0e10cSrcweirGENERATE_CHI = NO 881cdf0e10cSrcweir 882cdf0e10cSrcweir# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 883cdf0e10cSrcweir# is used to encode HtmlHelp index (hhk), content (hhc) and project file 884cdf0e10cSrcweir# content. 885cdf0e10cSrcweir 886cdf0e10cSrcweirCHM_INDEX_ENCODING = 887cdf0e10cSrcweir 888cdf0e10cSrcweir# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 889cdf0e10cSrcweir# controls whether a binary table of contents is generated (YES) or a 890cdf0e10cSrcweir# normal table of contents (NO) in the .chm file. 891cdf0e10cSrcweir 892cdf0e10cSrcweirBINARY_TOC = NO 893cdf0e10cSrcweir 894cdf0e10cSrcweir# The TOC_EXPAND flag can be set to YES to add extra items for group members 895cdf0e10cSrcweir# to the contents of the HTML help documentation and to the tree view. 896cdf0e10cSrcweir 897cdf0e10cSrcweirTOC_EXPAND = NO 898cdf0e10cSrcweir 899cdf0e10cSrcweir# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 900cdf0e10cSrcweir# are set, an additional index file will be generated that can be used as input for 901cdf0e10cSrcweir# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated 902cdf0e10cSrcweir# HTML documentation. 903cdf0e10cSrcweir 904cdf0e10cSrcweirGENERATE_QHP = NO 905cdf0e10cSrcweir 906cdf0e10cSrcweir# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 907cdf0e10cSrcweir# be used to specify the file name of the resulting .qch file. 908cdf0e10cSrcweir# The path specified is relative to the HTML output folder. 909cdf0e10cSrcweir 910cdf0e10cSrcweirQCH_FILE = 911cdf0e10cSrcweir 912cdf0e10cSrcweir# The QHP_NAMESPACE tag specifies the namespace to use when generating 913cdf0e10cSrcweir# Qt Help Project output. For more information please see 914cdf0e10cSrcweir# http://doc.trolltech.com/qthelpproject.html#namespace 915cdf0e10cSrcweir 916cdf0e10cSrcweirQHP_NAMESPACE = 917cdf0e10cSrcweir 918cdf0e10cSrcweir# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 919cdf0e10cSrcweir# Qt Help Project output. For more information please see 920cdf0e10cSrcweir# http://doc.trolltech.com/qthelpproject.html#virtual-folders 921cdf0e10cSrcweir 922cdf0e10cSrcweirQHP_VIRTUAL_FOLDER = doc 923cdf0e10cSrcweir 924cdf0e10cSrcweir# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. 925cdf0e10cSrcweir# For more information please see 926cdf0e10cSrcweir# http://doc.trolltech.com/qthelpproject.html#custom-filters 927cdf0e10cSrcweir 928cdf0e10cSrcweirQHP_CUST_FILTER_NAME = 929cdf0e10cSrcweir 930cdf0e10cSrcweir# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 931cdf0e10cSrcweir# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. 932cdf0e10cSrcweir 933cdf0e10cSrcweirQHP_CUST_FILTER_ATTRS = 934cdf0e10cSrcweir 935cdf0e10cSrcweir# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 936cdf0e10cSrcweir# filter section matches. 937cdf0e10cSrcweir# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. 938cdf0e10cSrcweir 939cdf0e10cSrcweirQHP_SECT_FILTER_ATTRS = 940cdf0e10cSrcweir 941cdf0e10cSrcweir# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 942cdf0e10cSrcweir# be used to specify the location of Qt's qhelpgenerator. 943cdf0e10cSrcweir# If non-empty doxygen will try to run qhelpgenerator on the generated 944cdf0e10cSrcweir# .qhp file. 945cdf0e10cSrcweir 946cdf0e10cSrcweirQHG_LOCATION = 947cdf0e10cSrcweir 948cdf0e10cSrcweir# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 949cdf0e10cSrcweir# top of each HTML page. The value NO (the default) enables the index and 950cdf0e10cSrcweir# the value YES disables it. 951cdf0e10cSrcweir 952cdf0e10cSrcweirDISABLE_INDEX = NO 953cdf0e10cSrcweir 954cdf0e10cSrcweir# This tag can be used to set the number of enum values (range [1..20]) 955cdf0e10cSrcweir# that doxygen will group on one line in the generated HTML documentation. 956cdf0e10cSrcweir 957cdf0e10cSrcweirENUM_VALUES_PER_LINE = 4 958cdf0e10cSrcweir 959cdf0e10cSrcweir# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 960cdf0e10cSrcweir# structure should be generated to display hierarchical information. 961cdf0e10cSrcweir# If the tag value is set to FRAME, a side panel will be generated 962cdf0e10cSrcweir# containing a tree-like index structure (just like the one that 963cdf0e10cSrcweir# is generated for HTML Help). For this to work a browser that supports 964cdf0e10cSrcweir# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 965cdf0e10cSrcweir# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 966cdf0e10cSrcweir# probably better off using the HTML help feature. Other possible values 967cdf0e10cSrcweir# for this tag are: HIERARCHIES, which will generate the Groups, Directories, 968cdf0e10cSrcweir# and Class Hierarchy pages using a tree view instead of an ordered list; 969cdf0e10cSrcweir# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which 970cdf0e10cSrcweir# disables this behavior completely. For backwards compatibility with previous 971cdf0e10cSrcweir# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE 972cdf0e10cSrcweir# respectively. 973cdf0e10cSrcweir 974cdf0e10cSrcweirGENERATE_TREEVIEW = NONE 975cdf0e10cSrcweir 976cdf0e10cSrcweir# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 977cdf0e10cSrcweir# used to set the initial width (in pixels) of the frame in which the tree 978cdf0e10cSrcweir# is shown. 979cdf0e10cSrcweir 980cdf0e10cSrcweirTREEVIEW_WIDTH = 250 981cdf0e10cSrcweir 982cdf0e10cSrcweir# Use this tag to change the font size of Latex formulas included 983cdf0e10cSrcweir# as images in the HTML documentation. The default is 10. Note that 984cdf0e10cSrcweir# when you change the font size after a successful doxygen run you need 985cdf0e10cSrcweir# to manually remove any form_*.png images from the HTML output directory 986cdf0e10cSrcweir# to force them to be regenerated. 987cdf0e10cSrcweir 988cdf0e10cSrcweirFORMULA_FONTSIZE = 10 989cdf0e10cSrcweir 990cdf0e10cSrcweir#--------------------------------------------------------------------------- 991cdf0e10cSrcweir# configuration options related to the LaTeX output 992cdf0e10cSrcweir#--------------------------------------------------------------------------- 993cdf0e10cSrcweir 994cdf0e10cSrcweir# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 995cdf0e10cSrcweir# generate Latex output. 996cdf0e10cSrcweir 997cdf0e10cSrcweirGENERATE_LATEX = YES 998cdf0e10cSrcweir 999cdf0e10cSrcweir# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1000cdf0e10cSrcweir# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1001cdf0e10cSrcweir# put in front of it. If left blank `latex' will be used as the default path. 1002cdf0e10cSrcweir 1003cdf0e10cSrcweirLATEX_OUTPUT = latex 1004cdf0e10cSrcweir 1005cdf0e10cSrcweir# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1006cdf0e10cSrcweir# invoked. If left blank `latex' will be used as the default command name. 1007cdf0e10cSrcweir 1008cdf0e10cSrcweirLATEX_CMD_NAME = latex 1009cdf0e10cSrcweir 1010cdf0e10cSrcweir# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1011cdf0e10cSrcweir# generate index for LaTeX. If left blank `makeindex' will be used as the 1012cdf0e10cSrcweir# default command name. 1013cdf0e10cSrcweir 1014cdf0e10cSrcweirMAKEINDEX_CMD_NAME = makeindex 1015cdf0e10cSrcweir 1016cdf0e10cSrcweir# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1017cdf0e10cSrcweir# LaTeX documents. This may be useful for small projects and may help to 1018cdf0e10cSrcweir# save some trees in general. 1019cdf0e10cSrcweir 1020cdf0e10cSrcweirCOMPACT_LATEX = NO 1021cdf0e10cSrcweir 1022cdf0e10cSrcweir# The PAPER_TYPE tag can be used to set the paper type that is used 1023cdf0e10cSrcweir# by the printer. Possible values are: a4, a4wide, letter, legal and 1024cdf0e10cSrcweir# executive. If left blank a4wide will be used. 1025cdf0e10cSrcweir 1026cdf0e10cSrcweirPAPER_TYPE = a4wide 1027cdf0e10cSrcweir 1028cdf0e10cSrcweir# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1029cdf0e10cSrcweir# packages that should be included in the LaTeX output. 1030cdf0e10cSrcweir 1031cdf0e10cSrcweirEXTRA_PACKAGES = 1032cdf0e10cSrcweir 1033cdf0e10cSrcweir# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1034cdf0e10cSrcweir# the generated latex document. The header should contain everything until 1035cdf0e10cSrcweir# the first chapter. If it is left blank doxygen will generate a 1036cdf0e10cSrcweir# standard header. Notice: only use this tag if you know what you are doing! 1037cdf0e10cSrcweir 1038cdf0e10cSrcweirLATEX_HEADER = 1039cdf0e10cSrcweir 1040cdf0e10cSrcweir# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1041cdf0e10cSrcweir# is prepared for conversion to pdf (using ps2pdf). The pdf file will 1042cdf0e10cSrcweir# contain links (just like the HTML output) instead of page references 1043cdf0e10cSrcweir# This makes the output suitable for online browsing using a pdf viewer. 1044cdf0e10cSrcweir 1045cdf0e10cSrcweirPDF_HYPERLINKS = YES 1046cdf0e10cSrcweir 1047cdf0e10cSrcweir# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1048cdf0e10cSrcweir# plain latex in the generated Makefile. Set this option to YES to get a 1049cdf0e10cSrcweir# higher quality PDF documentation. 1050cdf0e10cSrcweir 1051cdf0e10cSrcweirUSE_PDFLATEX = YES 1052cdf0e10cSrcweir 1053cdf0e10cSrcweir# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1054cdf0e10cSrcweir# command to the generated LaTeX files. This will instruct LaTeX to keep 1055cdf0e10cSrcweir# running if errors occur, instead of asking the user for help. 1056cdf0e10cSrcweir# This option is also used when generating formulas in HTML. 1057cdf0e10cSrcweir 1058cdf0e10cSrcweirLATEX_BATCHMODE = NO 1059cdf0e10cSrcweir 1060cdf0e10cSrcweir# If LATEX_HIDE_INDICES is set to YES then doxygen will not 1061cdf0e10cSrcweir# include the index chapters (such as File Index, Compound Index, etc.) 1062cdf0e10cSrcweir# in the output. 1063cdf0e10cSrcweir 1064cdf0e10cSrcweirLATEX_HIDE_INDICES = NO 1065cdf0e10cSrcweir 1066cdf0e10cSrcweir#--------------------------------------------------------------------------- 1067cdf0e10cSrcweir# configuration options related to the RTF output 1068cdf0e10cSrcweir#--------------------------------------------------------------------------- 1069cdf0e10cSrcweir 1070cdf0e10cSrcweir# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1071cdf0e10cSrcweir# The RTF output is optimized for Word 97 and may not look very pretty with 1072cdf0e10cSrcweir# other RTF readers or editors. 1073cdf0e10cSrcweir 1074cdf0e10cSrcweirGENERATE_RTF = NO 1075cdf0e10cSrcweir 1076cdf0e10cSrcweir# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1077cdf0e10cSrcweir# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1078cdf0e10cSrcweir# put in front of it. If left blank `rtf' will be used as the default path. 1079cdf0e10cSrcweir 1080cdf0e10cSrcweirRTF_OUTPUT = rtf 1081cdf0e10cSrcweir 1082cdf0e10cSrcweir# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1083cdf0e10cSrcweir# RTF documents. This may be useful for small projects and may help to 1084cdf0e10cSrcweir# save some trees in general. 1085cdf0e10cSrcweir 1086cdf0e10cSrcweirCOMPACT_RTF = NO 1087cdf0e10cSrcweir 1088cdf0e10cSrcweir# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1089cdf0e10cSrcweir# will contain hyperlink fields. The RTF file will 1090cdf0e10cSrcweir# contain links (just like the HTML output) instead of page references. 1091cdf0e10cSrcweir# This makes the output suitable for online browsing using WORD or other 1092cdf0e10cSrcweir# programs which support those fields. 1093cdf0e10cSrcweir# Note: wordpad (write) and others do not support links. 1094cdf0e10cSrcweir 1095cdf0e10cSrcweirRTF_HYPERLINKS = NO 1096cdf0e10cSrcweir 1097cdf0e10cSrcweir# Load stylesheet definitions from file. Syntax is similar to doxygen's 1098cdf0e10cSrcweir# config file, i.e. a series of assignments. You only have to provide 1099cdf0e10cSrcweir# replacements, missing definitions are set to their default value. 1100cdf0e10cSrcweir 1101cdf0e10cSrcweirRTF_STYLESHEET_FILE = 1102cdf0e10cSrcweir 1103cdf0e10cSrcweir# Set optional variables used in the generation of an rtf document. 1104cdf0e10cSrcweir# Syntax is similar to doxygen's config file. 1105cdf0e10cSrcweir 1106cdf0e10cSrcweirRTF_EXTENSIONS_FILE = 1107cdf0e10cSrcweir 1108cdf0e10cSrcweir#--------------------------------------------------------------------------- 1109cdf0e10cSrcweir# configuration options related to the man page output 1110cdf0e10cSrcweir#--------------------------------------------------------------------------- 1111cdf0e10cSrcweir 1112cdf0e10cSrcweir# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1113cdf0e10cSrcweir# generate man pages 1114cdf0e10cSrcweir 1115cdf0e10cSrcweirGENERATE_MAN = NO 1116cdf0e10cSrcweir 1117cdf0e10cSrcweir# The MAN_OUTPUT tag is used to specify where the man pages will be put. 1118cdf0e10cSrcweir# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1119cdf0e10cSrcweir# put in front of it. If left blank `man' will be used as the default path. 1120cdf0e10cSrcweir 1121cdf0e10cSrcweirMAN_OUTPUT = man 1122cdf0e10cSrcweir 1123cdf0e10cSrcweir# The MAN_EXTENSION tag determines the extension that is added to 1124cdf0e10cSrcweir# the generated man pages (default is the subroutine's section .3) 1125cdf0e10cSrcweir 1126cdf0e10cSrcweirMAN_EXTENSION = .3 1127cdf0e10cSrcweir 1128cdf0e10cSrcweir# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1129cdf0e10cSrcweir# then it will generate one additional man file for each entity 1130cdf0e10cSrcweir# documented in the real man page(s). These additional files 1131cdf0e10cSrcweir# only source the real man page, but without them the man command 1132cdf0e10cSrcweir# would be unable to find the correct page. The default is NO. 1133cdf0e10cSrcweir 1134cdf0e10cSrcweirMAN_LINKS = NO 1135cdf0e10cSrcweir 1136cdf0e10cSrcweir#--------------------------------------------------------------------------- 1137cdf0e10cSrcweir# configuration options related to the XML output 1138cdf0e10cSrcweir#--------------------------------------------------------------------------- 1139cdf0e10cSrcweir 1140cdf0e10cSrcweir# If the GENERATE_XML tag is set to YES Doxygen will 1141cdf0e10cSrcweir# generate an XML file that captures the structure of 1142cdf0e10cSrcweir# the code including all documentation. 1143cdf0e10cSrcweir 1144cdf0e10cSrcweirGENERATE_XML = NO 1145cdf0e10cSrcweir 1146cdf0e10cSrcweir# The XML_OUTPUT tag is used to specify where the XML pages will be put. 1147cdf0e10cSrcweir# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1148cdf0e10cSrcweir# put in front of it. If left blank `xml' will be used as the default path. 1149cdf0e10cSrcweir 1150cdf0e10cSrcweirXML_OUTPUT = xml 1151cdf0e10cSrcweir 1152cdf0e10cSrcweir# The XML_SCHEMA tag can be used to specify an XML schema, 1153cdf0e10cSrcweir# which can be used by a validating XML parser to check the 1154cdf0e10cSrcweir# syntax of the XML files. 1155cdf0e10cSrcweir 1156cdf0e10cSrcweirXML_SCHEMA = 1157cdf0e10cSrcweir 1158cdf0e10cSrcweir# The XML_DTD tag can be used to specify an XML DTD, 1159cdf0e10cSrcweir# which can be used by a validating XML parser to check the 1160cdf0e10cSrcweir# syntax of the XML files. 1161cdf0e10cSrcweir 1162cdf0e10cSrcweirXML_DTD = 1163cdf0e10cSrcweir 1164cdf0e10cSrcweir# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1165cdf0e10cSrcweir# dump the program listings (including syntax highlighting 1166cdf0e10cSrcweir# and cross-referencing information) to the XML output. Note that 1167cdf0e10cSrcweir# enabling this will significantly increase the size of the XML output. 1168cdf0e10cSrcweir 1169cdf0e10cSrcweirXML_PROGRAMLISTING = YES 1170cdf0e10cSrcweir 1171cdf0e10cSrcweir#--------------------------------------------------------------------------- 1172cdf0e10cSrcweir# configuration options for the AutoGen Definitions output 1173cdf0e10cSrcweir#--------------------------------------------------------------------------- 1174cdf0e10cSrcweir 1175cdf0e10cSrcweir# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1176cdf0e10cSrcweir# generate an AutoGen Definitions (see autogen.sf.net) file 1177cdf0e10cSrcweir# that captures the structure of the code including all 1178cdf0e10cSrcweir# documentation. Note that this feature is still experimental 1179cdf0e10cSrcweir# and incomplete at the moment. 1180cdf0e10cSrcweir 1181cdf0e10cSrcweirGENERATE_AUTOGEN_DEF = NO 1182cdf0e10cSrcweir 1183cdf0e10cSrcweir#--------------------------------------------------------------------------- 1184cdf0e10cSrcweir# configuration options related to the Perl module output 1185cdf0e10cSrcweir#--------------------------------------------------------------------------- 1186cdf0e10cSrcweir 1187cdf0e10cSrcweir# If the GENERATE_PERLMOD tag is set to YES Doxygen will 1188cdf0e10cSrcweir# generate a Perl module file that captures the structure of 1189cdf0e10cSrcweir# the code including all documentation. Note that this 1190cdf0e10cSrcweir# feature is still experimental and incomplete at the 1191cdf0e10cSrcweir# moment. 1192cdf0e10cSrcweir 1193cdf0e10cSrcweirGENERATE_PERLMOD = NO 1194cdf0e10cSrcweir 1195cdf0e10cSrcweir# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1196cdf0e10cSrcweir# the necessary Makefile rules, Perl scripts and LaTeX code to be able 1197cdf0e10cSrcweir# to generate PDF and DVI output from the Perl module output. 1198cdf0e10cSrcweir 1199cdf0e10cSrcweirPERLMOD_LATEX = NO 1200cdf0e10cSrcweir 1201cdf0e10cSrcweir# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1202cdf0e10cSrcweir# nicely formatted so it can be parsed by a human reader. 1203cdf0e10cSrcweir# This is useful 1204cdf0e10cSrcweir# if you want to understand what is going on. 1205cdf0e10cSrcweir# On the other hand, if this 1206cdf0e10cSrcweir# tag is set to NO the size of the Perl module output will be much smaller 1207cdf0e10cSrcweir# and Perl will parse it just the same. 1208cdf0e10cSrcweir 1209cdf0e10cSrcweirPERLMOD_PRETTY = YES 1210cdf0e10cSrcweir 1211cdf0e10cSrcweir# The names of the make variables in the generated doxyrules.make file 1212cdf0e10cSrcweir# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1213cdf0e10cSrcweir# This is useful so different doxyrules.make files included by the same 1214cdf0e10cSrcweir# Makefile don't overwrite each other's variables. 1215cdf0e10cSrcweir 1216cdf0e10cSrcweirPERLMOD_MAKEVAR_PREFIX = 1217cdf0e10cSrcweir 1218cdf0e10cSrcweir#--------------------------------------------------------------------------- 1219cdf0e10cSrcweir# Configuration options related to the preprocessor 1220cdf0e10cSrcweir#--------------------------------------------------------------------------- 1221cdf0e10cSrcweir 1222cdf0e10cSrcweir# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1223cdf0e10cSrcweir# evaluate all C-preprocessor directives found in the sources and include 1224cdf0e10cSrcweir# files. 1225cdf0e10cSrcweir 1226cdf0e10cSrcweirENABLE_PREPROCESSING = YES 1227cdf0e10cSrcweir 1228cdf0e10cSrcweir# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1229cdf0e10cSrcweir# names in the source code. If set to NO (the default) only conditional 1230cdf0e10cSrcweir# compilation will be performed. Macro expansion can be done in a controlled 1231cdf0e10cSrcweir# way by setting EXPAND_ONLY_PREDEF to YES. 1232cdf0e10cSrcweir 1233cdf0e10cSrcweirMACRO_EXPANSION = NO 1234cdf0e10cSrcweir 1235cdf0e10cSrcweir# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1236cdf0e10cSrcweir# then the macro expansion is limited to the macros specified with the 1237cdf0e10cSrcweir# PREDEFINED and EXPAND_AS_DEFINED tags. 1238cdf0e10cSrcweir 1239cdf0e10cSrcweirEXPAND_ONLY_PREDEF = NO 1240cdf0e10cSrcweir 1241cdf0e10cSrcweir# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1242cdf0e10cSrcweir# in the INCLUDE_PATH (see below) will be search if a #include is found. 1243cdf0e10cSrcweir 1244cdf0e10cSrcweirSEARCH_INCLUDES = YES 1245cdf0e10cSrcweir 1246cdf0e10cSrcweir# The INCLUDE_PATH tag can be used to specify one or more directories that 1247cdf0e10cSrcweir# contain include files that are not input files but should be processed by 1248cdf0e10cSrcweir# the preprocessor. 1249cdf0e10cSrcweir 1250cdf0e10cSrcweirINCLUDE_PATH = 1251cdf0e10cSrcweir 1252cdf0e10cSrcweir# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1253cdf0e10cSrcweir# patterns (like *.h and *.hpp) to filter out the header-files in the 1254cdf0e10cSrcweir# directories. If left blank, the patterns specified with FILE_PATTERNS will 1255cdf0e10cSrcweir# be used. 1256cdf0e10cSrcweir 1257cdf0e10cSrcweirINCLUDE_FILE_PATTERNS = 1258cdf0e10cSrcweir 1259cdf0e10cSrcweir# The PREDEFINED tag can be used to specify one or more macro names that 1260cdf0e10cSrcweir# are defined before the preprocessor is started (similar to the -D option of 1261cdf0e10cSrcweir# gcc). The argument of the tag is a list of macros of the form: name 1262cdf0e10cSrcweir# or name=definition (no spaces). If the definition and the = are 1263cdf0e10cSrcweir# omitted =1 is assumed. To prevent a macro definition from being 1264cdf0e10cSrcweir# undefined via #undef or recursively expanded use the := operator 1265cdf0e10cSrcweir# instead of the = operator. 1266cdf0e10cSrcweir 1267cdf0e10cSrcweirPREDEFINED = 1268cdf0e10cSrcweir 1269cdf0e10cSrcweir# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1270cdf0e10cSrcweir# this tag can be used to specify a list of macro names that should be expanded. 1271cdf0e10cSrcweir# The macro definition that is found in the sources will be used. 1272cdf0e10cSrcweir# Use the PREDEFINED tag if you want to use a different macro definition. 1273cdf0e10cSrcweir 1274cdf0e10cSrcweirEXPAND_AS_DEFINED = 1275cdf0e10cSrcweir 1276cdf0e10cSrcweir# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1277cdf0e10cSrcweir# doxygen's preprocessor will remove all function-like macros that are alone 1278cdf0e10cSrcweir# on a line, have an all uppercase name, and do not end with a semicolon. Such 1279cdf0e10cSrcweir# function macros are typically used for boiler-plate code, and will confuse 1280cdf0e10cSrcweir# the parser if not removed. 1281cdf0e10cSrcweir 1282cdf0e10cSrcweirSKIP_FUNCTION_MACROS = YES 1283cdf0e10cSrcweir 1284cdf0e10cSrcweir#--------------------------------------------------------------------------- 1285cdf0e10cSrcweir# Configuration::additions related to external references 1286cdf0e10cSrcweir#--------------------------------------------------------------------------- 1287cdf0e10cSrcweir 1288cdf0e10cSrcweir# The TAGFILES option can be used to specify one or more tagfiles. 1289cdf0e10cSrcweir# Optionally an initial location of the external documentation 1290cdf0e10cSrcweir# can be added for each tagfile. The format of a tag file without 1291cdf0e10cSrcweir# this location is as follows: 1292cdf0e10cSrcweir# 1293cdf0e10cSrcweir# TAGFILES = file1 file2 ... 1294cdf0e10cSrcweir# Adding location for the tag files is done as follows: 1295cdf0e10cSrcweir# 1296cdf0e10cSrcweir# TAGFILES = file1=loc1 "file2 = loc2" ... 1297cdf0e10cSrcweir# where "loc1" and "loc2" can be relative or absolute paths or 1298cdf0e10cSrcweir# URLs. If a location is present for each tag, the installdox tool 1299cdf0e10cSrcweir# does not have to be run to correct the links. 1300cdf0e10cSrcweir# Note that each tag file must have a unique name 1301cdf0e10cSrcweir# (where the name does NOT include the path) 1302cdf0e10cSrcweir# If a tag file is not located in the directory in which doxygen 1303cdf0e10cSrcweir# is run, you must also specify the path to the tagfile here. 1304cdf0e10cSrcweir 1305cdf0e10cSrcweirTAGFILES = 1306cdf0e10cSrcweir 1307cdf0e10cSrcweir# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1308cdf0e10cSrcweir# a tag file that is based on the input files it reads. 1309cdf0e10cSrcweir 1310cdf0e10cSrcweirGENERATE_TAGFILE = 1311cdf0e10cSrcweir 1312cdf0e10cSrcweir# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1313cdf0e10cSrcweir# in the class index. If set to NO only the inherited external classes 1314cdf0e10cSrcweir# will be listed. 1315cdf0e10cSrcweir 1316cdf0e10cSrcweirALLEXTERNALS = NO 1317cdf0e10cSrcweir 1318cdf0e10cSrcweir# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1319cdf0e10cSrcweir# in the modules index. If set to NO, only the current project's groups will 1320cdf0e10cSrcweir# be listed. 1321cdf0e10cSrcweir 1322cdf0e10cSrcweirEXTERNAL_GROUPS = YES 1323cdf0e10cSrcweir 1324cdf0e10cSrcweir# The PERL_PATH should be the absolute path and name of the perl script 1325cdf0e10cSrcweir# interpreter (i.e. the result of `which perl'). 1326cdf0e10cSrcweir 1327cdf0e10cSrcweirPERL_PATH = /usr/bin/perl 1328cdf0e10cSrcweir 1329cdf0e10cSrcweir#--------------------------------------------------------------------------- 1330cdf0e10cSrcweir# Configuration options related to the dot tool 1331cdf0e10cSrcweir#--------------------------------------------------------------------------- 1332cdf0e10cSrcweir 1333cdf0e10cSrcweir# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1334cdf0e10cSrcweir# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1335cdf0e10cSrcweir# or super classes. Setting the tag to NO turns the diagrams off. Note that 1336cdf0e10cSrcweir# this option is superseded by the HAVE_DOT option below. This is only a 1337cdf0e10cSrcweir# fallback. It is recommended to install and use dot, since it yields more 1338cdf0e10cSrcweir# powerful graphs. 1339cdf0e10cSrcweir 1340cdf0e10cSrcweirCLASS_DIAGRAMS = YES 1341cdf0e10cSrcweir 1342cdf0e10cSrcweir# You can define message sequence charts within doxygen comments using the \msc 1343cdf0e10cSrcweir# command. Doxygen will then run the mscgen tool (see 1344cdf0e10cSrcweir# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1345cdf0e10cSrcweir# documentation. The MSCGEN_PATH tag allows you to specify the directory where 1346cdf0e10cSrcweir# the mscgen tool resides. If left empty the tool is assumed to be found in the 1347cdf0e10cSrcweir# default search path. 1348cdf0e10cSrcweir 1349cdf0e10cSrcweirMSCGEN_PATH = 1350cdf0e10cSrcweir 1351cdf0e10cSrcweir# If set to YES, the inheritance and collaboration graphs will hide 1352cdf0e10cSrcweir# inheritance and usage relations if the target is undocumented 1353cdf0e10cSrcweir# or is not a class. 1354cdf0e10cSrcweir 1355cdf0e10cSrcweirHIDE_UNDOC_RELATIONS = YES 1356cdf0e10cSrcweir 1357cdf0e10cSrcweir# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1358cdf0e10cSrcweir# available from the path. This tool is part of Graphviz, a graph visualization 1359cdf0e10cSrcweir# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1360cdf0e10cSrcweir# have no effect if this option is set to NO (the default) 1361cdf0e10cSrcweir 1362cdf0e10cSrcweirHAVE_DOT = NO 1363cdf0e10cSrcweir 1364cdf0e10cSrcweir# By default doxygen will write a font called FreeSans.ttf to the output 1365cdf0e10cSrcweir# directory and reference it in all dot files that doxygen generates. This 1366cdf0e10cSrcweir# font does not include all possible unicode characters however, so when you need 1367cdf0e10cSrcweir# these (or just want a differently looking font) you can specify the font name 1368cdf0e10cSrcweir# using DOT_FONTNAME. You need need to make sure dot is able to find the font, 1369cdf0e10cSrcweir# which can be done by putting it in a standard location or by setting the 1370cdf0e10cSrcweir# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 1371cdf0e10cSrcweir# containing the font. 1372cdf0e10cSrcweir 1373cdf0e10cSrcweirDOT_FONTNAME = FreeSans 1374cdf0e10cSrcweir 1375cdf0e10cSrcweir# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1376cdf0e10cSrcweir# The default size is 10pt. 1377cdf0e10cSrcweir 1378cdf0e10cSrcweirDOT_FONTSIZE = 10 1379cdf0e10cSrcweir 1380cdf0e10cSrcweir# By default doxygen will tell dot to use the output directory to look for the 1381cdf0e10cSrcweir# FreeSans.ttf font (which doxygen will put there itself). If you specify a 1382cdf0e10cSrcweir# different font using DOT_FONTNAME you can set the path where dot 1383cdf0e10cSrcweir# can find it using this tag. 1384cdf0e10cSrcweir 1385cdf0e10cSrcweirDOT_FONTPATH = 1386cdf0e10cSrcweir 1387cdf0e10cSrcweir# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1388cdf0e10cSrcweir# will generate a graph for each documented class showing the direct and 1389cdf0e10cSrcweir# indirect inheritance relations. Setting this tag to YES will force the 1390cdf0e10cSrcweir# the CLASS_DIAGRAMS tag to NO. 1391cdf0e10cSrcweir 1392cdf0e10cSrcweirCLASS_GRAPH = YES 1393cdf0e10cSrcweir 1394cdf0e10cSrcweir# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1395cdf0e10cSrcweir# will generate a graph for each documented class showing the direct and 1396cdf0e10cSrcweir# indirect implementation dependencies (inheritance, containment, and 1397cdf0e10cSrcweir# class references variables) of the class with other documented classes. 1398cdf0e10cSrcweir 1399cdf0e10cSrcweirCOLLABORATION_GRAPH = YES 1400cdf0e10cSrcweir 1401cdf0e10cSrcweir# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1402cdf0e10cSrcweir# will generate a graph for groups, showing the direct groups dependencies 1403cdf0e10cSrcweir 1404cdf0e10cSrcweirGROUP_GRAPHS = YES 1405cdf0e10cSrcweir 1406cdf0e10cSrcweir# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1407cdf0e10cSrcweir# collaboration diagrams in a style similar to the OMG's Unified Modeling 1408cdf0e10cSrcweir# Language. 1409cdf0e10cSrcweir 1410cdf0e10cSrcweirUML_LOOK = NO 1411cdf0e10cSrcweir 1412cdf0e10cSrcweir# If set to YES, the inheritance and collaboration graphs will show the 1413cdf0e10cSrcweir# relations between templates and their instances. 1414cdf0e10cSrcweir 1415cdf0e10cSrcweirTEMPLATE_RELATIONS = NO 1416cdf0e10cSrcweir 1417cdf0e10cSrcweir# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1418cdf0e10cSrcweir# tags are set to YES then doxygen will generate a graph for each documented 1419cdf0e10cSrcweir# file showing the direct and indirect include dependencies of the file with 1420cdf0e10cSrcweir# other documented files. 1421cdf0e10cSrcweir 1422cdf0e10cSrcweirINCLUDE_GRAPH = YES 1423cdf0e10cSrcweir 1424cdf0e10cSrcweir# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1425cdf0e10cSrcweir# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1426cdf0e10cSrcweir# documented header file showing the documented files that directly or 1427cdf0e10cSrcweir# indirectly include this file. 1428cdf0e10cSrcweir 1429cdf0e10cSrcweirINCLUDED_BY_GRAPH = YES 1430cdf0e10cSrcweir 1431cdf0e10cSrcweir# If the CALL_GRAPH and HAVE_DOT options are set to YES then 1432cdf0e10cSrcweir# doxygen will generate a call dependency graph for every global function 1433cdf0e10cSrcweir# or class method. Note that enabling this option will significantly increase 1434cdf0e10cSrcweir# the time of a run. So in most cases it will be better to enable call graphs 1435cdf0e10cSrcweir# for selected functions only using the \callgraph command. 1436cdf0e10cSrcweir 1437cdf0e10cSrcweirCALL_GRAPH = NO 1438cdf0e10cSrcweir 1439cdf0e10cSrcweir# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1440cdf0e10cSrcweir# doxygen will generate a caller dependency graph for every global function 1441cdf0e10cSrcweir# or class method. Note that enabling this option will significantly increase 1442cdf0e10cSrcweir# the time of a run. So in most cases it will be better to enable caller 1443cdf0e10cSrcweir# graphs for selected functions only using the \callergraph command. 1444cdf0e10cSrcweir 1445cdf0e10cSrcweirCALLER_GRAPH = NO 1446cdf0e10cSrcweir 1447cdf0e10cSrcweir# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1448cdf0e10cSrcweir# will graphical hierarchy of all classes instead of a textual one. 1449cdf0e10cSrcweir 1450cdf0e10cSrcweirGRAPHICAL_HIERARCHY = YES 1451cdf0e10cSrcweir 1452cdf0e10cSrcweir# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1453cdf0e10cSrcweir# then doxygen will show the dependencies a directory has on other directories 1454cdf0e10cSrcweir# in a graphical way. The dependency relations are determined by the #include 1455cdf0e10cSrcweir# relations between the files in the directories. 1456cdf0e10cSrcweir 1457cdf0e10cSrcweirDIRECTORY_GRAPH = YES 1458cdf0e10cSrcweir 1459cdf0e10cSrcweir# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1460cdf0e10cSrcweir# generated by dot. Possible values are png, jpg, or gif 1461cdf0e10cSrcweir# If left blank png will be used. 1462cdf0e10cSrcweir 1463cdf0e10cSrcweirDOT_IMAGE_FORMAT = png 1464cdf0e10cSrcweir 1465cdf0e10cSrcweir# The tag DOT_PATH can be used to specify the path where the dot tool can be 1466cdf0e10cSrcweir# found. If left blank, it is assumed the dot tool can be found in the path. 1467cdf0e10cSrcweir 1468cdf0e10cSrcweirDOT_PATH = 1469cdf0e10cSrcweir 1470cdf0e10cSrcweir# The DOTFILE_DIRS tag can be used to specify one or more directories that 1471cdf0e10cSrcweir# contain dot files that are included in the documentation (see the 1472cdf0e10cSrcweir# \dotfile command). 1473cdf0e10cSrcweir 1474cdf0e10cSrcweirDOTFILE_DIRS = 1475cdf0e10cSrcweir 1476cdf0e10cSrcweir# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1477cdf0e10cSrcweir# nodes that will be shown in the graph. If the number of nodes in a graph 1478cdf0e10cSrcweir# becomes larger than this value, doxygen will truncate the graph, which is 1479cdf0e10cSrcweir# visualized by representing a node as a red box. Note that doxygen if the 1480cdf0e10cSrcweir# number of direct children of the root node in a graph is already larger than 1481cdf0e10cSrcweir# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1482cdf0e10cSrcweir# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1483cdf0e10cSrcweir 1484cdf0e10cSrcweirDOT_GRAPH_MAX_NODES = 50 1485cdf0e10cSrcweir 1486cdf0e10cSrcweir# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1487cdf0e10cSrcweir# graphs generated by dot. A depth value of 3 means that only nodes reachable 1488cdf0e10cSrcweir# from the root by following a path via at most 3 edges will be shown. Nodes 1489cdf0e10cSrcweir# that lay further from the root node will be omitted. Note that setting this 1490cdf0e10cSrcweir# option to 1 or 2 may greatly reduce the computation time needed for large 1491cdf0e10cSrcweir# code bases. Also note that the size of a graph can be further restricted by 1492cdf0e10cSrcweir# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1493cdf0e10cSrcweir 1494cdf0e10cSrcweirMAX_DOT_GRAPH_DEPTH = 0 1495cdf0e10cSrcweir 1496cdf0e10cSrcweir# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1497cdf0e10cSrcweir# background. This is disabled by default, because dot on Windows does not 1498cdf0e10cSrcweir# seem to support this out of the box. Warning: Depending on the platform used, 1499cdf0e10cSrcweir# enabling this option may lead to badly anti-aliased labels on the edges of 1500cdf0e10cSrcweir# a graph (i.e. they become hard to read). 1501cdf0e10cSrcweir 1502cdf0e10cSrcweirDOT_TRANSPARENT = NO 1503cdf0e10cSrcweir 1504cdf0e10cSrcweir# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1505cdf0e10cSrcweir# files in one run (i.e. multiple -o and -T options on the command line). This 1506cdf0e10cSrcweir# makes dot run faster, but since only newer versions of dot (>1.8.10) 1507cdf0e10cSrcweir# support this, this feature is disabled by default. 1508cdf0e10cSrcweir 1509cdf0e10cSrcweirDOT_MULTI_TARGETS = NO 1510cdf0e10cSrcweir 1511cdf0e10cSrcweir# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1512cdf0e10cSrcweir# generate a legend page explaining the meaning of the various boxes and 1513cdf0e10cSrcweir# arrows in the dot generated graphs. 1514cdf0e10cSrcweir 1515cdf0e10cSrcweirGENERATE_LEGEND = YES 1516cdf0e10cSrcweir 1517cdf0e10cSrcweir# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1518cdf0e10cSrcweir# remove the intermediate dot files that are used to generate 1519cdf0e10cSrcweir# the various graphs. 1520cdf0e10cSrcweir 1521cdf0e10cSrcweirDOT_CLEANUP = YES 1522cdf0e10cSrcweir 1523cdf0e10cSrcweir#--------------------------------------------------------------------------- 1524cdf0e10cSrcweir# Options related to the search engine 1525cdf0e10cSrcweir#--------------------------------------------------------------------------- 1526cdf0e10cSrcweir 1527cdf0e10cSrcweir# The SEARCHENGINE tag specifies whether or not a search engine should be 1528cdf0e10cSrcweir# used. If set to NO the values of all tags below this one will be ignored. 1529cdf0e10cSrcweir 1530cdf0e10cSrcweirSEARCHENGINE = NO 1531