1474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org## 2474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org## Copyright (c) 2010 The WebM project authors. All Rights Reserved. 3474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org## 4474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org## Use of this source code is governed by a BSD-style license 5474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org## that can be found in the LICENSE file in the root of the source 6474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org## tree. An additional intellectual property rights grant can be found 7474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org## in the file PATENTS. All contributing project authors may 8474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org## be found in the AUTHORS file in the root of the source tree. 9474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org## 10474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 11474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 12474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Doxyfile 1.5.4 13474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 14474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# This file describes the settings to be used by the documentation system 15474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# doxygen (www.doxygen.org) for a project 16474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# 17474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# All text after a hash (#) is considered a comment and will be ignored 18474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The format is: 19474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# TAG = value [value, ...] 20474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# For lists items can also be appended using: 21474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# TAG += value [value, ...] 22474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Values that contain spaces should be placed between quotes (" ") 23474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 24474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 25474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Project related configuration options 26474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 27474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 28474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# This tag specifies the encoding used for all characters in the config file that 29474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# follow. The default is UTF-8 which is also the encoding used for all text before 30474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into 31474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of 32474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# possible encodings. 33474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 34474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgDOXYFILE_ENCODING = UTF-8 35474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 36474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 37474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# by quotes) that should identify the project. 38474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 39474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgPROJECT_NAME = "WebM VP8 Codec SDK" 40474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 41474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 42474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# base path where the generated documentation will be put. 43474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If a relative path is entered, it will be relative to the location 44474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# where doxygen was started. If left blank the current directory will be used. 45474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 46474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgOUTPUT_DIRECTORY = docs 47474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 48474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 49474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# 4096 sub-directories (in 2 levels) under the output directory of each output 50474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# format and will distribute the generated files over these directories. 51474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Enabling this option can be useful when feeding doxygen a huge amount of 52474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# source files, where putting all generated files in the same directory would 53474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# otherwise cause performance problems for the file system. 54474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 55474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgCREATE_SUBDIRS = NO 56474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 57474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The OUTPUT_LANGUAGE tag is used to specify the language in which all 58474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# documentation generated by doxygen is written. Doxygen will use this 59474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# information to generate all constant output in the proper language. 60474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The default language is English, other supported languages are: 61474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 62474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, 63474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, 64474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, 65474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. 66474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 67474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgOUTPUT_LANGUAGE = English 68474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 69474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 70474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# include brief member descriptions after the members that are listed in 71474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the file and class documentation (similar to java_doc). 72474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Set to NO to disable this. 73474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 74474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgBRIEF_MEMBER_DESC = YES 75474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 76474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 77474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the brief description of a member or function before the detailed description. 78474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 79474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# brief descriptions will be completely suppressed. 80474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 81474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgREPEAT_BRIEF = YES 82474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 83474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# This tag implements a quasi-intelligent brief description abbreviator 84474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# that is used to form the text in various listings. Each string 85474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# in this list, if found as the leading text of the brief description, will be 86474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# stripped from the text and the result after processing the whole list, is 87474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# used as the annotated text. Otherwise, the brief description is used as-is. 88474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If left blank, the following values are used ("$name" is automatically 89474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# replaced with the name of the entity): "The $name class" "The $name widget" 90474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# "The $name file" "is" "provides" "specifies" "contains" 91474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# "represents" "a" "an" "the" 92474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 93474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgABBREVIATE_BRIEF = 94474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 95474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 96474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Doxygen will generate a detailed section even if there is only a brief 97474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# description. 98474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 99474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgALWAYS_DETAILED_SEC = NO 100474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 101474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 102474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# inherited members of a class in the documentation of that class as if those 103474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# members were ordinary class members. Constructors, destructors and assignment 104474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# operators of the base classes will not be shown. 105474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 106474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgINLINE_INHERITED_MEMB = NO 107474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 108474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 109474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# path before files name in the file list and in the header files. If set 110474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# to NO the shortest path that makes the file name unique will be used. 111474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 112474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgFULL_PATH_NAMES = YES 113474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 114474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 115474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# can be used to strip a user-defined part of the path. Stripping is 116474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# only done if one of the specified strings matches the left-hand part of 117474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the path. The tag can be used to show relative paths in the file list. 118474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If left blank the directory from which doxygen is run is used as the 119474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# path to strip. 120474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 121474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgSTRIP_FROM_PATH = 122474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 123474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 124474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the path mentioned in the documentation of a class, which tells 125474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the reader which header file to include in order to use a class. 126474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If left blank only the name of the header file containing the class 127474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# definition is used. Otherwise one should specify the include paths that 128474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# are normally passed to the compiler using the -I flag. 129474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 130474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgSTRIP_FROM_INC_PATH = 131474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 132474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 133474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# (but less readable) file names. This can be useful is your file systems 134474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# doesn't support long names like on DOS, Mac, or CD-ROM. 135474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 136474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgSHORT_NAMES = NO 137474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 138474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 139474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# will interpret the first line (until the first dot) of a java_doc-style 140474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# comment as the brief description. If set to NO, the java_doc 141474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# comments will behave just like regular Qt-style comments 142474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# (thus requiring an explicit @brief command for a brief description.) 143474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 144474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgJAVADOC_AUTOBRIEF = NO 145474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 146474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 147474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# interpret the first line (until the first dot) of a Qt-style 148474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# comment as the brief description. If set to NO, the comments 149474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# will behave just like regular Qt-style comments (thus requiring 150474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# an explicit \brief command for a brief description.) 151474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 152474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgQT_AUTOBRIEF = NO 153474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 154474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 155474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# treat a multi-line C++ special comment block (i.e. a block of //! or /// 156474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# comments) as a brief description. This used to be the default behaviour. 157474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The new default is to treat a multi-line C++ comment block as a detailed 158474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# description. Set this tag to YES if you prefer the old behaviour instead. 159474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 160474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgMULTILINE_CPP_IS_BRIEF = NO 161474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 162474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 163474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# member inherits the documentation from any documented member that it 164474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# re-implements. 165474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 166474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgINHERIT_DOCS = YES 167474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 168474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 169474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# a new page for each member. If set to NO, the documentation of a member will 170474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# be part of the file/class/namespace that contains it. 171474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 172474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgSEPARATE_MEMBER_PAGES = NO 173474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 174474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The TAB_SIZE tag can be used to set the number of spaces in a tab. 175474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Doxygen uses this value to replace tabs by spaces in code fragments. 176474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 177474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgTAB_SIZE = 4 178474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 179474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# This tag can be used to specify a number of aliases that acts 180474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# as commands in the documentation. An alias has the form "name=value". 181474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# For example adding "sideeffect=\par Side Effects:\n" will allow you to 182474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# put the command \sideeffect (or @sideeffect) in the documentation, which 183474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# will result in a user-defined paragraph with heading "Side Effects:". 184474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# You can put \n's in the value part of an alias to insert newlines. 185474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 186474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgALIASES = 187474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 188474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 189474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# sources only. Doxygen will then generate output that is more tailored for C. 190474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# For instance, some of the names that are used will be different. The list 191474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# of all members will be omitted, etc. 192474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 193474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgOPTIMIZE_OUTPUT_FOR_C = YES 194474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 195474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 196474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# sources only. Doxygen will then generate output that is more tailored for Java. 197474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# For instance, namespaces will be presented as packages, qualified scopes 198474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# will look different, etc. 199474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 200474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgOPTIMIZE_OUTPUT_JAVA = NO 201474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 202474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 203474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# include (a tag file for) the STL sources as input, then you should 204474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# set this tag to YES in order to let doxygen match functions declarations and 205474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 206474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# func(std::string) {}). This also make the inheritance and collaboration 207474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# diagrams that involve STL classes more complete and accurate. 208474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 209474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgBUILTIN_STL_SUPPORT = NO 210474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 211474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If you use Microsoft's C++/CLI language, you should set this option to YES to 212474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# enable parsing support. 213474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 214474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgCPP_CLI_SUPPORT = NO 215474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 216474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 217474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Doxygen will parse them like normal C++ but will assume all classes use public 218474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# instead of private inheritance when no explicit protection keyword is present. 219474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 220474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgSIP_SUPPORT = NO 221474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 222474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 223474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# tag is set to YES, then doxygen will reuse the documentation of the first 224474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# member in the group (if any) for the other members of the group. By default 225474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# all members of a group must be documented explicitly. 226474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 227474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgDISTRIBUTE_GROUP_DOC = NO 228474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 229474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Set the SUBGROUPING tag to YES (the defqault) to allow class member groups of 230474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the same type (for instance a group of public functions) to be put as a 231474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# subgroup of that type (e.g. under the Public Functions section). Set it to 232474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# NO to prevent subgrouping. Alternatively, this can be done per class using 233474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the \nosubgrouping command. 234474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 235474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgSUBGROUPING = YES 236474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 237474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct (or union) is 238474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# documented as struct with the name of the typedef. So 239474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# typedef struct type_s {} type_t, will appear in the documentation as a struct 240474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# with name type_t. When disabled the typedef will appear as a member of a file, 241474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# namespace, or class. And the struct will be named type_s. This can typically 242474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# be useful for C code where the coding convention is that all structs are 243474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# typedef'ed and only the typedef is referenced never the struct's name. 244474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 245474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgTYPEDEF_HIDES_STRUCT = NO 246474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 247474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 248474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Build related configuration options 249474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 250474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 251474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 252474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# documentation are documented, even if no documentation was available. 253474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Private class members and static file members will be hidden unless 254474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 255474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 256474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgEXTRACT_ALL = NO 257474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 258474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 259474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# will be included in the documentation. 260474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 261474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgEXTRACT_PRIVATE = NO 262474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 263474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the EXTRACT_STATIC tag is set to YES all static members of a file 264474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# will be included in the documentation. 265474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 266474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgEXTRACT_STATIC = NO 267474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 268474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 269474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# defined locally in source files will be included in the documentation. 270474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If set to NO only classes defined in header files are included. 271474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 272474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgEXTRACT_LOCAL_CLASSES = YES 273474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 274474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# This flag is only useful for Objective-C code. When set to YES local 275474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# methods, which are defined in the implementation section but not in 276474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the interface are included in the documentation. 277474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If set to NO (the default) only methods in the interface are included. 278474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 279474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgEXTRACT_LOCAL_METHODS = NO 280474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 281474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If this flag is set to YES, the members of anonymous namespaces will be extracted 282474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# and appear in the documentation as a namespace called 'anonymous_namespace{file}', 283474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# where file will be replaced with the base name of the file that contains the anonymous 284474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# namespace. By default anonymous namespace are hidden. 285474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 286474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgEXTRACT_ANON_NSPACES = NO 287474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 288474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 289474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# undocumented members of documented classes, files or namespaces. 290474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If set to NO (the default) these members will be included in the 291474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# various overviews, but no documentation section is generated. 292474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# This option has no effect if EXTRACT_ALL is enabled. 293474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 294474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgHIDE_UNDOC_MEMBERS = NO 295474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 296474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 297474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# undocumented classes that are normally visible in the class hierarchy. 298474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If set to NO (the default) these classes will be included in the various 299474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# overviews. This option has no effect if EXTRACT_ALL is enabled. 300474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 301474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgHIDE_UNDOC_CLASSES = NO 302474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 303474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 304474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# friend (class|struct|union) declarations. 305474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If set to NO (the default) these declarations will be included in the 306474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# documentation. 307474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 308474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgHIDE_FRIEND_COMPOUNDS = NO 309474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 310474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 311474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# documentation blocks found inside the body of a function. 312474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If set to NO (the default) these blocks will be appended to the 313474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# function's detailed documentation block. 314474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 315474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgHIDE_IN_BODY_DOCS = NO 316474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 317474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The INTERNAL_DOCS tag determines if documentation 318474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# that is typed after a \internal command is included. If the tag is set 319474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# to NO (the default) then the documentation will be excluded. 320474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Set it to YES to include the internal documentation. 321474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 322474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgINTERNAL_DOCS = NO 323474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 324474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 325474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# file names in lower-case letters. If set to YES upper-case letters are also 326474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# allowed. This is useful if you have classes or files whose names only differ 327474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# in case and if your file system supports case sensitive file names. Windows 328474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# and Mac users are advised to set this option to NO. 329474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 330474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgCASE_SENSE_NAMES = YES 331474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 332474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 333474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# will show members with their full class and namespace scopes in the 334474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# documentation. If set to YES the scope will be hidden. 335474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 336474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgHIDE_SCOPE_NAMES = NO 337474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 338474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 339474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# will put a list of the files that are included by a file in the documentation 340474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# of that file. 341474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 342474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgSHOW_INCLUDE_FILES = YES 343474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 344474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 345474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# is inserted in the documentation for inline members. 346474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 347474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgINLINE_INFO = YES 348474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 349474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 350474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# will sort the (detailed) documentation of file and class members 351474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# alphabetically by member name. If set to NO the members will appear in 352474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# declaration order. 353474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 354474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgSORT_MEMBER_DOCS = NO 355474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 356474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 357474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# brief documentation of file, namespace and class members alphabetically 358474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# by member name. If set to NO (the default) the members will appear in 359474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# declaration order. 360474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 361474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgSORT_BRIEF_DOCS = NO 362474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 363474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 364474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# sorted by fully-qualified names, including namespaces. If set to 365474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# NO (the default), the class list will be sorted only by class name, 366474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# not including the namespace part. 367474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 368474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Note: This option applies only to the class list, not to the 369474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# alphabetical list. 370474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 371474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgSORT_BY_SCOPE_NAME = NO 372474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 373474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The GENERATE_TODOLIST tag can be used to enable (YES) or 374474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# disable (NO) the todo list. This list is created by putting \todo 375474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# commands in the documentation. 376474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 377474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgGENERATE_TODOLIST = YES 378474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 379474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The GENERATE_TESTLIST tag can be used to enable (YES) or 380474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# disable (NO) the test list. This list is created by putting \test 381474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# commands in the documentation. 382474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 383474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgGENERATE_TESTLIST = YES 384474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 385474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The GENERATE_BUGLIST tag can be used to enable (YES) or 386474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# disable (NO) the bug list. This list is created by putting \bug 387474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# commands in the documentation. 388474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 389474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgGENERATE_BUGLIST = YES 390474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 391474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 392474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# disable (NO) the deprecated list. This list is created by putting 393474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# \deprecated commands in the documentation. 394474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 395474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgGENERATE_DEPRECATEDLIST= YES 396474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 397474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The ENABLED_SECTIONS tag can be used to enable conditional 398474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# documentation sections, marked by \if sectionname ... \endif. 399474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 400474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgENABLED_SECTIONS = 401474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 402474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 403474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the initial value of a variable or define consists of for it to appear in 404474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the documentation. If the initializer consists of more lines than specified 405474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# here it will be hidden. Use a value of 0 to hide initializers completely. 406474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The appearance of the initializer of individual variables and defines in the 407474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# documentation can be controlled using \showinitializer or \hideinitializer 408474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# command in the documentation regardless of this setting. 409474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 410474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgMAX_INITIALIZER_LINES = 30 411474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 412474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 413474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# at the bottom of the documentation of classes and structs. If set to YES the 414474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# list will mention the files that were used to generate the documentation. 415474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 416474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgSHOW_USED_FILES = YES 417474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 418474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the sources in your project are distributed over multiple directories 419474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 420474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# in the documentation. The default is NO. 421474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 422474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgSHOW_DIRECTORIES = NO 423474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 424474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The FILE_VERSION_FILTER tag can be used to specify a program or script that 425474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# doxygen should invoke to get the current version for each file (typically from the 426474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# version control system). Doxygen will invoke the program by executing (via 427474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# popen()) the command <command> <input-file>, where <command> is the value of 428474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 429474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# provided by doxygen. Whatever the program writes to standard output 430474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# is used as the file version. See the manual for examples. 431474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 432474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgFILE_VERSION_FILTER = 433474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 434474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 435474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# configuration options related to warning and progress messages 436474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 437474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 438474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The QUIET tag can be used to turn on/off the messages that are generated 439474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# by doxygen. Possible values are YES and NO. If left blank NO is used. 440474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 441474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgQUIET = YES 442474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 443474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The WARNINGS tag can be used to turn on/off the warning messages that are 444474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# generated by doxygen. Possible values are YES and NO. If left blank 445474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# NO is used. 446474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 447474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgWARNINGS = YES 448474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 449474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 450474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 451474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# automatically be disabled. 452474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 453474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgWARN_IF_UNDOCUMENTED = YES 454474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 455474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 456474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# potential errors in the documentation, such as not documenting some 457474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# parameters in a documented function, or documenting parameters that 458474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# don't exist or using markup commands wrongly. 459474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 460474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgWARN_IF_DOC_ERROR = YES 461474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 462474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# This WARN_NO_PARAMDOC option can be abled to get warnings for 463474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# functions that are documented, but have no documentation for their parameters 464474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# or return value. If set to NO (the default) doxygen will only warn about 465474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# wrong or incomplete parameter documentation, but not about the absence of 466474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# documentation. 467474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 468474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgWARN_NO_PARAMDOC = NO 469474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 470474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The WARN_FORMAT tag determines the format of the warning messages that 471474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# doxygen can produce. The string should contain the $file, $line, and $text 472474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# tags, which will be replaced by the file and line number from which the 473474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# warning originated and the warning text. Optionally the format may contain 474474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# $version, which will be replaced by the version of the file (if it could 475474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# be obtained via FILE_VERSION_FILTER) 476474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 477474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgWARN_FORMAT = "$file:$line: $text" 478474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 479474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The WARN_LOGFILE tag can be used to specify a file to which warning 480474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# and error messages should be written. If left blank the output is written 481474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# to stderr. 482474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 483474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgWARN_LOGFILE = 484474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 485474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 486474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# configuration options related to the input files 487474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 488474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 489474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The INPUT tag can be used to specify the files and/or directories that contain 490474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# documented source files. You may enter file names like "myfile.cpp" or 491474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# directories like "/usr/src/myproject". Separate the files or directories 492474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# with spaces. 493474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 494474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgINPUT = 495474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 496474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# This tag can be used to specify the character encoding of the source files that 497474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 498474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. 499474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# See http://www.gnu.org/software/libiconv for the list of possible encodings. 500474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 501474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgINPUT_ENCODING = UTF-8 502474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 503474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the value of the INPUT tag contains directories, you can use the 504474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 505474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# and *.h) to filter out the source-files in the directories. If left 506474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# blank the following patterns are tested: 507474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 508474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 509474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 510474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgFILE_PATTERNS = 511474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 512474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The RECURSIVE tag can be used to turn specify whether or not subdirectories 513474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# should be searched for input files as well. Possible values are YES and NO. 514474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If left blank NO is used. 515474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 516474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgRECURSIVE = NO 517474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 518474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The EXCLUDE tag can be used to specify files and/or directories that should 519474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# excluded from the INPUT source files. This way you can easily exclude a 520474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# subdirectory from a directory tree whose root is specified with the INPUT tag. 521474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 522474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgEXCLUDE = 523474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 524474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 525474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# directories that are symbolic links (a Unix filesystem feature) are excluded 526474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# from the input. 527474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 528474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgEXCLUDE_SYMLINKS = NO 529474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 530474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the value of the INPUT tag contains directories, you can use the 531474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 532474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# certain files from those directories. Note that the wildcards are matched 533474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# against the file with absolute path, so to exclude all test directories 534474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# for example use the pattern */test/* 535474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 536474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgEXCLUDE_PATTERNS = 537474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 538474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 539474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# (namespaces, classes, functions, etc.) that should be excluded from the output. 540474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The symbol name can be a fully qualified name, a word, or if the wildcard * is used, 541474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test 542474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 543474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgEXCLUDE_SYMBOLS = 544474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 545474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The EXAMPLE_PATH tag can be used to specify one or more files or 546474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# directories that contain example code fragments that are included (see 547474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the \include command). 548474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 549474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgEXAMPLE_PATH = 550474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 551474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the value of the EXAMPLE_PATH tag contains directories, you can use the 552474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 553474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# and *.h) to filter out the source-files in the directories. If left 554474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# blank all files are included. 555474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 556474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgEXAMPLE_PATTERNS = 557474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 558474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 559474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# searched for input files to be used with the \include or \dontinclude 560474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# commands irrespective of the value of the RECURSIVE tag. 561474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Possible values are YES and NO. If left blank NO is used. 562474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 563474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgEXAMPLE_RECURSIVE = NO 564474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 565474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The IMAGE_PATH tag can be used to specify one or more files or 566474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# directories that contain image that are included in the documentation (see 567474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the \image command). 568474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 569474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgIMAGE_PATH = 570474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 571474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The INPUT_FILTER tag can be used to specify a program that doxygen should 572474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# invoke to filter for each input file. Doxygen will invoke the filter program 573474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# by executing (via popen()) the command <filter> <input-file>, where <filter> 574474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 575474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# input file. Doxygen will then use the output that the filter program writes 576474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# to standard output. If FILTER_PATTERNS is specified, this tag will be 577474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# ignored. 578474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 579474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgINPUT_FILTER = 580474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 581474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 582474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# basis. Doxygen will compare the file name with each pattern and apply the 583474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# filter if there is a match. The filters are a list of the form: 584474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 585474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 586474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# is applied to all files. 587474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 588474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgFILTER_PATTERNS = 589474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 590474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 591474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# INPUT_FILTER) will be used to filter the input files when producing source 592474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# files to browse (i.e. when SOURCE_BROWSER is set to YES). 593474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 594474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgFILTER_SOURCE_FILES = NO 595474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 596474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 597474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# configuration options related to source browsing 598474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 599474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 600474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the SOURCE_BROWSER tag is set to YES then a list of source files will 601474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# be generated. Documented entities will be cross-referenced with these sources. 602474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Note: To get rid of all source code in the generated output, make sure also 603474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH 604474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# then you must also enable this option. If you don't then doxygen will produce 605474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# a warning and turn it on anyway 606474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 607474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgSOURCE_BROWSER = NO 608474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 609474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Setting the INLINE_SOURCES tag to YES will include the body 610474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# of functions and classes directly in the documentation. 611474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 612474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgINLINE_SOURCES = NO 613474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 614474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 615474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# doxygen to hide any special comment blocks from generated source code 616474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# fragments. Normal C and C++ comments will always remain visible. 617474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 618474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgSTRIP_CODE_COMMENTS = YES 619474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 620474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the REFERENCED_BY_RELATION tag is set to YES (the default) 621474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# then for each documented function all documented 622474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# functions referencing it will be listed. 623474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 624474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgREFERENCED_BY_RELATION = YES 625474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 626474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the REFERENCES_RELATION tag is set to YES (the default) 627474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# then for each documented function all documented entities 628474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# called/used by that function will be listed. 629474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 630474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgREFERENCES_RELATION = YES 631474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 632474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 633474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 634474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 635474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# link to the source code. Otherwise they will link to the documentstion. 636474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 637474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgREFERENCES_LINK_SOURCE = YES 638474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 639474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the USE_HTAGS tag is set to YES then the references to source code 640474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# will point to the HTML generated by the htags(1) tool instead of doxygen 641474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# built-in source browser. The htags tool is part of GNU's global source 642474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# tagging system (see http://www.gnu.org/software/global/global.html). You 643474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# will need version 4.8.6 or higher. 644474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 645474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgUSE_HTAGS = NO 646474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 647474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 648474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# will generate a verbatim copy of the header file for each class for 649474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# which an include is specified. Set to NO to disable this. 650474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 651474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgVERBATIM_HEADERS = YES 652474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 653474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 654474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# configuration options related to the alphabetical class index 655474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 656474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 657474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 658474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# of all compounds will be generated. Enable this if the project 659474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# contains a lot of classes, structs, unions or interfaces. 660474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 661474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgALPHABETICAL_INDEX = NO 662474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 663474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 664474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 665474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# in which this list will be split (can be a number in the range [1..20]) 666474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 667474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgCOLS_IN_ALPHA_INDEX = 5 668474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 669474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# In case all classes in a project start with a common prefix, all 670474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# classes will be put under the same header in the alphabetical index. 671474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 672474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# should be ignored while generating the index headers. 673474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 674474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgIGNORE_PREFIX = 675474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 676474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 677474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# configuration options related to the HTML output 678474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 679474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 680474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 681474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# generate HTML output. 682474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 683474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgGENERATE_HTML = YES 684474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 685474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 686474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If a relative path is entered the value of OUTPUT_DIRECTORY will be 687474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# put in front of it. If left blank `html' will be used as the default path. 688474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 689474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgHTML_OUTPUT = html 690474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 691474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 692474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 693474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# doxygen will generate files with .html extension. 694474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 695474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgHTML_FILE_EXTENSION = .html 696474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 697474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The HTML_HEADER tag can be used to specify a personal HTML header for 698474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# each generated HTML page. If it is left blank doxygen will generate a 699474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# standard header. 700474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 701474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgHTML_HEADER = 702474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 703474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The HTML_FOOTER tag can be used to specify a personal HTML footer for 704474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# each generated HTML page. If it is left blank doxygen will generate a 705474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# standard footer. 706474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 707474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgHTML_FOOTER = 708474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 709474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 710474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# style sheet that is used by each HTML page. It can be used to 711474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# fine-tune the look of the HTML output. If the tag is left blank doxygen 712474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# will generate a default style sheet. Note that doxygen will try to copy 713474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the style sheet file to the HTML output directory, so don't put your own 714474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# stylesheet in the HTML output directory as well, or it will be erased! 715474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 716474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgHTML_STYLESHEET = 717474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 718474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 719474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# files or namespaces will be aligned in HTML using tables. If set to 720474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# NO a bullet list will be used. 721474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 722474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgHTML_ALIGN_MEMBERS = YES 723474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 724474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the GENERATE_HTMLHELP tag is set to YES, additional index files 725474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# will be generated that can be used as input for tools like the 726474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 727474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# of the generated HTML documentation. 728474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 729474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgGENERATE_HTMLHELP = NO 730474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 731474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 732474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# documentation will contain sections that can be hidden and shown after the 733474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# page has loaded. For this to work a browser that supports 734474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# java_script and DHTML is required (for instance Mozilla 1.0+, Firefox 735474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 736474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 737474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgHTML_DYNAMIC_SECTIONS = NO 738474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 739474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 740474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# be used to specify the file name of the resulting .chm file. You 741474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# can add a path in front of the file if the result should not be 742474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# written to the html output directory. 743474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 744474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgCHM_FILE = 745474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 746474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 747474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# be used to specify the location (absolute path including file name) of 748474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 749474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the HTML help compiler on the generated index.hhp. 750474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 751474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgHHC_LOCATION = 752474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 753474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 754474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# controls if a separate .chi index file is generated (YES) or that 755474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# it should be included in the master .chm file (NO). 756474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 757474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgGENERATE_CHI = NO 758474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 759474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 760474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# controls whether a binary table of contents is generated (YES) or a 761474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# normal table of contents (NO) in the .chm file. 762474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 763474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgBINARY_TOC = NO 764474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 765474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The TOC_EXPAND flag can be set to YES to add extra items for group members 766474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# to the contents of the HTML help documentation and to the tree view. 767474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 768474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgTOC_EXPAND = NO 769474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 770474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 771474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# top of each HTML page. The value NO (the default) enables the index and 772474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the value YES disables it. 773474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 774474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgDISABLE_INDEX = NO 775474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 776474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# This tag can be used to set the number of enum values (range [1..20]) 777474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# that doxygen will group on one line in the generated HTML documentation. 778474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 779474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgENUM_VALUES_PER_LINE = 4 780474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 781474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 782474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# generated containing a tree-like index structure (just like the one that 783474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# is generated for HTML Help). For this to work a browser that supports 784474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# java_script, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 785474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 786474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# probably better off using the HTML help feature. 787474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 788474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgGENERATE_TREEVIEW = NO 789474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 790474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 791474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# used to set the initial width (in pixels) of the frame in which the tree 792474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# is shown. 793474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 794474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgTREEVIEW_WIDTH = 250 795474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 796474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 797474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# configuration options related to the la_te_x output 798474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 799474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 800474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 801474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# generate Latex output. 802474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 803474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgGENERATE_LATEX = YES 804474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 805474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The LATEX_OUTPUT tag is used to specify where the la_te_x docs will be put. 806474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If a relative path is entered the value of OUTPUT_DIRECTORY will be 807474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# put in front of it. If left blank `latex' will be used as the default path. 808474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 809474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgLATEX_OUTPUT = latex 810474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 811474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The LATEX_CMD_NAME tag can be used to specify the la_te_x command name to be 812474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# invoked. If left blank `latex' will be used as the default command name. 813474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 814474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgLATEX_CMD_NAME = latex 815474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 816474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 817474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# generate index for la_te_x. If left blank `makeindex' will be used as the 818474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# default command name. 819474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 820474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgMAKEINDEX_CMD_NAME = makeindex 821474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 822474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 823474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# la_te_x documents. This may be useful for small projects and may help to 824474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# save some trees in general. 825474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 826474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgCOMPACT_LATEX = YES 827474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 828474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The PAPER_TYPE tag can be used to set the paper type that is used 829474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# by the printer. Possible values are: a4, a4wide, letter, legal and 830474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# executive. If left blank a4wide will be used. 831474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 832474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgPAPER_TYPE = letter 833474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 834474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The EXTRA_PACKAGES tag can be to specify one or more names of la_te_x 835474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# packages that should be included in the la_te_x output. 836474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 837474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgEXTRA_PACKAGES = 838474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 839474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The LATEX_HEADER tag can be used to specify a personal la_te_x header for 840474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the generated latex document. The header should contain everything until 841474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the first chapter. If it is left blank doxygen will generate a 842474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# standard header. Notice: only use this tag if you know what you are doing! 843474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 844474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgLATEX_HEADER = 845474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 846474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the PDF_HYPERLINKS tag is set to YES, the la_te_x that is generated 847474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# is prepared for conversion to pdf (using ps2pdf). The pdf file will 848474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# contain links (just like the HTML output) instead of page references 849474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# This makes the output suitable for online browsing using a pdf viewer. 850474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 851474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgPDF_HYPERLINKS = YES 852474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 853474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 854474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# plain latex in the generated Makefile. Set this option to YES to get a 855474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# higher quality PDF documentation. 856474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 857474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgUSE_PDFLATEX = YES 858474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 859474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 860474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# command to the generated la_te_x files. This will instruct la_te_x to keep 861474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# running if errors occur, instead of asking the user for help. 862474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# This option is also used when generating formulas in HTML. 863474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 864474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgLATEX_BATCHMODE = NO 865474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 866474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If LATEX_HIDE_INDICES is set to YES then doxygen will not 867474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# include the index chapters (such as File Index, Compound Index, etc.) 868474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# in the output. 869474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 870474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgLATEX_HIDE_INDICES = NO 871474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 872474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 873474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# configuration options related to the RTF output 874474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 875474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 876474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 877474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The RTF output is optimized for Word 97 and may not look very pretty with 878474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# other RTF readers or editors. 879474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 880474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgGENERATE_RTF = NO 881474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 882474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 883474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If a relative path is entered the value of OUTPUT_DIRECTORY will be 884474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# put in front of it. If left blank `rtf' will be used as the default path. 885474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 886474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgRTF_OUTPUT = rtf 887474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 888474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 889474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# RTF documents. This may be useful for small projects and may help to 890474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# save some trees in general. 891474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 892474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgCOMPACT_RTF = NO 893474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 894474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 895474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# will contain hyperlink fields. The RTF file will 896474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# contain links (just like the HTML output) instead of page references. 897474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# This makes the output suitable for online browsing using WORD or other 898474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# programs which support those fields. 899474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Note: wordpad (write) and others do not support links. 900474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 901474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgRTF_HYPERLINKS = NO 902474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 903474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Load stylesheet definitions from file. Syntax is similar to doxygen's 904474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# config file, i.e. a series of assignments. You only have to provide 905474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# replacements, missing definitions are set to their default value. 906474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 907474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgRTF_STYLESHEET_FILE = 908474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 909474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Set optional variables used in the generation of an rtf document. 910474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Syntax is similar to doxygen's config file. 911474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 912474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgRTF_EXTENSIONS_FILE = 913474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 914474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 915474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# configuration options related to the man page output 916474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 917474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 918474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 919474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# generate man pages 920474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 921474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgGENERATE_MAN = NO 922474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 923474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The MAN_OUTPUT tag is used to specify where the man pages will be put. 924474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If a relative path is entered the value of OUTPUT_DIRECTORY will be 925474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# put in front of it. If left blank `man' will be used as the default path. 926474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 927474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgMAN_OUTPUT = man 928474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 929474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The MAN_EXTENSION tag determines the extension that is added to 930474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the generated man pages (default is the subroutine's section .3) 931474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 932474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgMAN_EXTENSION = .3 933474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 934474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 935474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# then it will generate one additional man file for each entity 936474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# documented in the real man page(s). These additional files 937474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# only source the real man page, but without them the man command 938474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# would be unable to find the correct page. The default is NO. 939474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 940474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgMAN_LINKS = YES 941474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 942474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 943474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# configuration options related to the XML output 944474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 945474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 946474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the GENERATE_XML tag is set to YES Doxygen will 947474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# generate an XML file that captures the structure of 948474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the code including all documentation. 949474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 950474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgGENERATE_XML = NO 951474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 952474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The XML_OUTPUT tag is used to specify where the XML pages will be put. 953474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If a relative path is entered the value of OUTPUT_DIRECTORY will be 954474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# put in front of it. If left blank `xml' will be used as the default path. 955474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 956474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgXML_OUTPUT = xml 957474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 958474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The XML_SCHEMA tag can be used to specify an XML schema, 959474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# which can be used by a validating XML parser to check the 960474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# syntax of the XML files. 961474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 962474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgXML_SCHEMA = 963474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 964474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The XML_DTD tag can be used to specify an XML DTD, 965474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# which can be used by a validating XML parser to check the 966474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# syntax of the XML files. 967474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 968474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgXML_DTD = 969474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 970474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 971474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# dump the program listings (including syntax highlighting 972474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# and cross-referencing information) to the XML output. Note that 973474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# enabling this will significantly increase the size of the XML output. 974474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 975474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgXML_PROGRAMLISTING = YES 976474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 977474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 978474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# configuration options for the auto_gen Definitions output 979474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 980474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 981474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 982474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# generate an auto_gen Definitions (see autogen.sf.net) file 983474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# that captures the structure of the code including all 984474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# documentation. Note that this feature is still experimental 985474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# and incomplete at the moment. 986474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 987474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgGENERATE_AUTOGEN_DEF = NO 988474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 989474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 990474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# configuration options related to the Perl module output 991474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 992474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 993474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the GENERATE_PERLMOD tag is set to YES Doxygen will 994474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# generate a Perl module file that captures the structure of 995474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the code including all documentation. Note that this 996474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# feature is still experimental and incomplete at the 997474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# moment. 998474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 999474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgGENERATE_PERLMOD = NO 1000474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1001474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1002474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the necessary Makefile rules, Perl scripts and la_te_x code to be able 1003474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# to generate PDF and DVI output from the Perl module output. 1004474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1005474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgPERLMOD_LATEX = NO 1006474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1007474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1008474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# nicely formatted so it can be parsed by a human reader. This is useful 1009474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# if you want to understand what is going on. On the other hand, if this 1010474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# tag is set to NO the size of the Perl module output will be much smaller 1011474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# and Perl will parse it just the same. 1012474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1013474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgPERLMOD_PRETTY = YES 1014474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1015474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The names of the make variables in the generated doxyrules.make file 1016474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1017474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# This is useful so different doxyrules.make files included by the same 1018474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Makefile don't overwrite each other's variables. 1019474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1020474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgPERLMOD_MAKEVAR_PREFIX = 1021474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1022474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 1023474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Configuration options related to the preprocessor 1024474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 1025474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1026474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1027474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# evaluate all C-preprocessor directives found in the sources and include 1028474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# files. 1029474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1030474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgENABLE_PREPROCESSING = YES 1031474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1032474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1033474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# names in the source code. If set to NO (the default) only conditional 1034474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# compilation will be performed. Macro expansion can be done in a controlled 1035474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# way by setting EXPAND_ONLY_PREDEF to YES. 1036474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1037474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgMACRO_EXPANSION = YES 1038474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1039474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1040474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# then the macro expansion is limited to the macros specified with the 1041474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# PREDEFINED and EXPAND_AS_DEFINED tags. 1042474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1043474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgEXPAND_ONLY_PREDEF = NO 1044474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1045474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1046474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# in the INCLUDE_PATH (see below) will be search if a #include is found. 1047474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1048474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgSEARCH_INCLUDES = YES 1049474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1050474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The INCLUDE_PATH tag can be used to specify one or more directories that 1051474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# contain include files that are not input files but should be processed by 1052474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the preprocessor. 1053474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1054474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgINCLUDE_PATH = 1055474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1056474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1057474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# patterns (like *.h and *.hpp) to filter out the header-files in the 1058474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# directories. If left blank, the patterns specified with FILE_PATTERNS will 1059474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# be used. 1060474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1061474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgINCLUDE_FILE_PATTERNS = *.h 1062474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1063474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The PREDEFINED tag can be used to specify one or more macro names that 1064474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# are defined before the preprocessor is started (similar to the -D option of 1065474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# gcc). The argument of the tag is a list of macros of the form: name 1066474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# or name=definition (no spaces). If the definition and the = are 1067474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# omitted =1 is assumed. To prevent a macro definition from being 1068474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# undefined via #undef or recursively expanded use the := operator 1069474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# instead of the = operator. 1070474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1071474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgPREDEFINED = 1072474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1073474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1074474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# this tag can be used to specify a list of macro names that should be expanded. 1075474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The macro definition that is found in the sources will be used. 1076474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Use the PREDEFINED tag if you want to use a different macro definition. 1077474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1078474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgEXPAND_AS_DEFINED = 1079474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1080474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1081474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# doxygen's preprocessor will remove all function-like macros that are alone 1082474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# on a line, have an all uppercase name, and do not end with a semicolon. Such 1083474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# function macros are typically used for boiler-plate code, and will confuse 1084474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the parser if not removed. 1085474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1086474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgSKIP_FUNCTION_MACROS = YES 1087474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1088474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 1089474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Configuration::additions related to external references 1090474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 1091474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1092474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The TAGFILES option can be used to specify one or more tagfiles. 1093474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Optionally an initial location of the external documentation 1094474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# can be added for each tagfile. The format of a tag file without 1095474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# this location is as follows: 1096474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# TAGFILES = file1 file2 ... 1097474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Adding location for the tag files is done as follows: 1098474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# TAGFILES = file1=loc1 "file2 = loc2" ... 1099474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# where "loc1" and "loc2" can be relative or absolute paths or 1100474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# URLs. If a location is present for each tag, the installdox tool 1101474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# does not have to be run to correct the links. 1102474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Note that each tag file must have a unique name 1103474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# (where the name does NOT include the path) 1104474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If a tag file is not located in the directory in which doxygen 1105474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# is run, you must also specify the path to the tagfile here. 1106474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1107474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgTAGFILES = 1108474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1109474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1110474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# a tag file that is based on the input files it reads. 1111474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1112474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgGENERATE_TAGFILE = 1113474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1114474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1115474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# in the class index. If set to NO only the inherited external classes 1116474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# will be listed. 1117474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1118474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgALLEXTERNALS = NO 1119474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1120474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1121474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# in the modules index. If set to NO, only the current project's groups will 1122474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# be listed. 1123474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1124474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgEXTERNAL_GROUPS = YES 1125474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1126474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The PERL_PATH should be the absolute path and name of the perl script 1127474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# interpreter (i.e. the result of `which perl'). 1128474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1129474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgPERL_PATH = /usr/bin/perl 1130474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1131474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 1132474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Configuration options related to the dot tool 1133474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 1134474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1135474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1136474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# generate a inheritance diagram (in HTML, RTF and la_te_x) for classes with base 1137474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# or super classes. Setting the tag to NO turns the diagrams off. Note that 1138474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# this option is superseded by the HAVE_DOT option below. This is only a 1139474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# fallback. It is recommended to install and use dot, since it yields more 1140474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# powerful graphs. 1141474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1142474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgCLASS_DIAGRAMS = YES 1143474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1144474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# You can define message sequence charts within doxygen comments using the \msc 1145474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to 1146474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to 1147474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# specify the directory where the mscgen tool resides. If left empty the tool is assumed to 1148474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# be found in the default search path. 1149474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1150474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgMSCGEN_PATH = 1151474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1152474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If set to YES, the inheritance and collaboration graphs will hide 1153474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# inheritance and usage relations if the target is undocumented 1154474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# or is not a class. 1155474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1156474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgHIDE_UNDOC_RELATIONS = YES 1157474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1158474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1159474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# available from the path. This tool is part of Graphviz, a graph visualization 1160474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1161474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# have no effect if this option is set to NO (the default) 1162474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1163474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgHAVE_DOT = NO 1164474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1165474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1166474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# will generate a graph for each documented class showing the direct and 1167474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# indirect inheritance relations. Setting this tag to YES will force the 1168474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the CLASS_DIAGRAMS tag to NO. 1169474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1170474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgCLASS_GRAPH = YES 1171474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1172474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1173474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# will generate a graph for each documented class showing the direct and 1174474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# indirect implementation dependencies (inheritance, containment, and 1175474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# class references variables) of the class with other documented classes. 1176474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1177474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgCOLLABORATION_GRAPH = YES 1178474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1179474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1180474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# will generate a graph for groups, showing the direct groups dependencies 1181474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1182474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgGROUP_GRAPHS = YES 1183474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1184474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1185474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# collaboration diagrams in a style similar to the OMG's Unified Modeling 1186474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Language. 1187474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1188474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgUML_LOOK = NO 1189474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1190474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If set to YES, the inheritance and collaboration graphs will show the 1191474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# relations between templates and their instances. 1192474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1193474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgTEMPLATE_RELATIONS = NO 1194474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1195474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1196474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# tags are set to YES then doxygen will generate a graph for each documented 1197474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# file showing the direct and indirect include dependencies of the file with 1198474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# other documented files. 1199474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1200474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgINCLUDE_GRAPH = YES 1201474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1202474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1203474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1204474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# documented header file showing the documented files that directly or 1205474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# indirectly include this file. 1206474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1207474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgINCLUDED_BY_GRAPH = YES 1208474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1209474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will 1210474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# generate a call dependency graph for every global function or class method. 1211474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Note that enabling this option will significantly increase the time of a run. 1212474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# So in most cases it will be better to enable call graphs for selected 1213474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# functions only using the \callgraph command. 1214474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1215474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgCALL_GRAPH = NO 1216474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1217474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will 1218474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# generate a caller dependency graph for every global function or class method. 1219474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Note that enabling this option will significantly increase the time of a run. 1220474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# So in most cases it will be better to enable caller graphs for selected 1221474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# functions only using the \callergraph command. 1222474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1223474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgCALLER_GRAPH = NO 1224474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1225474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1226474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# will graphical hierarchy of all classes instead of a textual one. 1227474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1228474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgGRAPHICAL_HIERARCHY = YES 1229474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1230474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1231474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# then doxygen will show the dependencies a directory has on other directories 1232474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# in a graphical way. The dependency relations are determined by the #include 1233474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# relations between the files in the directories. 1234474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1235474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgDIRECTORY_GRAPH = YES 1236474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1237474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1238474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# generated by dot. Possible values are png, jpg, or gif 1239474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If left blank png will be used. 1240474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1241474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgDOT_IMAGE_FORMAT = png 1242474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1243474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The tag DOT_PATH can be used to specify the path where the dot tool can be 1244474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# found. If left blank, it is assumed the dot tool can be found in the path. 1245474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1246474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgDOT_PATH = 1247474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1248474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The DOTFILE_DIRS tag can be used to specify one or more directories that 1249474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# contain dot files that are included in the documentation (see the 1250474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# \dotfile command). 1251474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1252474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgDOTFILE_DIRS = 1253474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1254474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1255474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# nodes that will be shown in the graph. If the number of nodes in a graph 1256474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# becomes larger than this value, doxygen will truncate the graph, which is 1257474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# visualized by representing a node as a red box. Note that doxygen if the number 1258474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# of direct children of the root node in a graph is already larger than 1259474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note 1260474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1261474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1262474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgDOT_GRAPH_MAX_NODES = 50 1263474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1264474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1265474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# graphs generated by dot. A depth value of 3 means that only nodes reachable 1266474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# from the root by following a path via at most 3 edges will be shown. Nodes 1267474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# that lay further from the root node will be omitted. Note that setting this 1268474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# option to 1 or 2 may greatly reduce the computation time needed for large 1269474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# code bases. Also note that the size of a graph can be further restricted by 1270474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1271474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1272474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgMAX_DOT_GRAPH_DEPTH = 0 1273474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1274474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1275474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# background. This is disabled by default, which results in a white background. 1276474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Warning: Depending on the platform used, enabling this option may lead to 1277474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 1278474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# read). 1279474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1280474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgDOT_TRANSPARENT = YES 1281474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1282474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1283474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# files in one run (i.e. multiple -o and -T options on the command line). This 1284474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# makes dot run faster, but since only newer versions of dot (>1.8.10) 1285474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# support this, this feature is disabled by default. 1286474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1287474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgDOT_MULTI_TARGETS = NO 1288474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1289474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1290474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# generate a legend page explaining the meaning of the various boxes and 1291474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# arrows in the dot generated graphs. 1292474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1293474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgGENERATE_LEGEND = YES 1294474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1295474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1296474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# remove the intermediate dot files that are used to generate 1297474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# the various graphs. 1298474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1299474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgDOT_CLEANUP = YES 1300474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1301474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 1302474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# Configuration::additions related to the search engine 1303474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org#--------------------------------------------------------------------------- 1304474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1305474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# The SEARCHENGINE tag specifies whether or not a search engine should be 1306474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org# used. If set to NO the values of all tags below this one will be ignored. 1307474eb7536515fb785e925cc9375d22817c416851hclam@chromium.org 1308474eb7536515fb785e925cc9375d22817c416851hclam@chromium.orgSEARCHENGINE = NO 1309