190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber## 2f71323e297a928af368937089d3ed71239786f86Andreas Huber## Copyright (c) 2010 The WebM project authors. All Rights Reserved. 390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber## 4f71323e297a928af368937089d3ed71239786f86Andreas Huber## Use of this source code is governed by a BSD-style license 5f71323e297a928af368937089d3ed71239786f86Andreas Huber## that can be found in the LICENSE file in the root of the source 6f71323e297a928af368937089d3ed71239786f86Andreas Huber## tree. An additional intellectual property rights grant can be found 7f71323e297a928af368937089d3ed71239786f86Andreas Huber## in the file PATENTS. All contributing project authors may 8f71323e297a928af368937089d3ed71239786f86Andreas Huber## be found in the AUTHORS file in the root of the source tree. 990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber## 1090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 1190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 1290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Doxyfile 1.5.4 1390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 1490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# This file describes the settings to be used by the documentation system 1590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# doxygen (www.doxygen.org) for a project 1690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# 1790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# All text after a hash (#) is considered a comment and will be ignored 1890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The format is: 1990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# TAG = value [value, ...] 2090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# For lists items can also be appended using: 2190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# TAG += value [value, ...] 2290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Values that contain spaces should be placed between quotes (" ") 2390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 2490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 2590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Project related configuration options 2690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 2790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 2890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# This tag specifies the encoding used for all characters in the config file that 2990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# follow. The default is UTF-8 which is also the encoding used for all text before 3090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into 3190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of 3290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# possible encodings. 3390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 3490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberDOXYFILE_ENCODING = UTF-8 3590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 3690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 3790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# by quotes) that should identify the project. 3890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 3990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberPROJECT_NAME = "WebM VP8 Codec SDK" 4090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 4190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 4290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# base path where the generated documentation will be put. 4390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If a relative path is entered, it will be relative to the location 4490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# where doxygen was started. If left blank the current directory will be used. 4590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 4690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberOUTPUT_DIRECTORY = docs 4790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 4890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# 4096 sub-directories (in 2 levels) under the output directory of each output 5090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# format and will distribute the generated files over these directories. 5190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Enabling this option can be useful when feeding doxygen a huge amount of 5290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# source files, where putting all generated files in the same directory would 5390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# otherwise cause performance problems for the file system. 5490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 5590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberCREATE_SUBDIRS = NO 5690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 5790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The OUTPUT_LANGUAGE tag is used to specify the language in which all 5890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# documentation generated by doxygen is written. Doxygen will use this 5990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# information to generate all constant output in the proper language. 6090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The default language is English, other supported languages are: 6190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 6290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, 6390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, 6490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, 6590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. 6690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 6790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberOUTPUT_LANGUAGE = English 6890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 6990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 7090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# include brief member descriptions after the members that are listed in 7190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the file and class documentation (similar to java_doc). 7290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Set to NO to disable this. 7390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 7490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberBRIEF_MEMBER_DESC = YES 7590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 7690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 7790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the brief description of a member or function before the detailed description. 7890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 7990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# brief descriptions will be completely suppressed. 8090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 8190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberREPEAT_BRIEF = YES 8290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 8390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# This tag implements a quasi-intelligent brief description abbreviator 8490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# that is used to form the text in various listings. Each string 8590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# in this list, if found as the leading text of the brief description, will be 8690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# stripped from the text and the result after processing the whole list, is 8790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# used as the annotated text. Otherwise, the brief description is used as-is. 8890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If left blank, the following values are used ("$name" is automatically 8990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# replaced with the name of the entity): "The $name class" "The $name widget" 9090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# "The $name file" "is" "provides" "specifies" "contains" 9190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# "represents" "a" "an" "the" 9290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 9390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberABBREVIATE_BRIEF = 9490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 9590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 9690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Doxygen will generate a detailed section even if there is only a brief 9790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# description. 9890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 9990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberALWAYS_DETAILED_SEC = NO 10090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 10190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 10290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# inherited members of a class in the documentation of that class as if those 10390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# members were ordinary class members. Constructors, destructors and assignment 10490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# operators of the base classes will not be shown. 10590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 10690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberINLINE_INHERITED_MEMB = NO 10790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 10890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 10990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# path before files name in the file list and in the header files. If set 11090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# to NO the shortest path that makes the file name unique will be used. 11190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 11290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberFULL_PATH_NAMES = YES 11390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 11490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 11590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# can be used to strip a user-defined part of the path. Stripping is 11690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# only done if one of the specified strings matches the left-hand part of 11790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the path. The tag can be used to show relative paths in the file list. 11890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If left blank the directory from which doxygen is run is used as the 11990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# path to strip. 12090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 12190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberSTRIP_FROM_PATH = 12290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 12390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 12490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the path mentioned in the documentation of a class, which tells 12590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the reader which header file to include in order to use a class. 12690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If left blank only the name of the header file containing the class 12790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# definition is used. Otherwise one should specify the include paths that 12890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# are normally passed to the compiler using the -I flag. 12990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 13090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberSTRIP_FROM_INC_PATH = 13190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 13290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 13390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# (but less readable) file names. This can be useful is your file systems 13490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# doesn't support long names like on DOS, Mac, or CD-ROM. 13590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 13690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberSHORT_NAMES = NO 13790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 13890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 13990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# will interpret the first line (until the first dot) of a java_doc-style 14090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# comment as the brief description. If set to NO, the java_doc 14190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# comments will behave just like regular Qt-style comments 14290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# (thus requiring an explicit @brief command for a brief description.) 14390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 14490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberJAVADOC_AUTOBRIEF = NO 14590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 14690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 14790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# interpret the first line (until the first dot) of a Qt-style 14890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# comment as the brief description. If set to NO, the comments 14990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# will behave just like regular Qt-style comments (thus requiring 15090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# an explicit \brief command for a brief description.) 15190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 15290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberQT_AUTOBRIEF = NO 15390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 15490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 15590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# treat a multi-line C++ special comment block (i.e. a block of //! or /// 15690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# comments) as a brief description. This used to be the default behaviour. 15790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The new default is to treat a multi-line C++ comment block as a detailed 15890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# description. Set this tag to YES if you prefer the old behaviour instead. 15990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 16090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberMULTILINE_CPP_IS_BRIEF = NO 16190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 16290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 16390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# member inherits the documentation from any documented member that it 16490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# re-implements. 16590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 16690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberINHERIT_DOCS = YES 16790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 16890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 16990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# a new page for each member. If set to NO, the documentation of a member will 17090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# be part of the file/class/namespace that contains it. 17190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 17290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberSEPARATE_MEMBER_PAGES = NO 17390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 17490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The TAB_SIZE tag can be used to set the number of spaces in a tab. 17590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Doxygen uses this value to replace tabs by spaces in code fragments. 17690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 17790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberTAB_SIZE = 4 17890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 17990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# This tag can be used to specify a number of aliases that acts 18090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# as commands in the documentation. An alias has the form "name=value". 18190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# For example adding "sideeffect=\par Side Effects:\n" will allow you to 18290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# put the command \sideeffect (or @sideeffect) in the documentation, which 18390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# will result in a user-defined paragraph with heading "Side Effects:". 18490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# You can put \n's in the value part of an alias to insert newlines. 18590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 18690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberALIASES = 18790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 18890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 18990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# sources only. Doxygen will then generate output that is more tailored for C. 19090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# For instance, some of the names that are used will be different. The list 19190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# of all members will be omitted, etc. 19290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 19390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberOPTIMIZE_OUTPUT_FOR_C = YES 19490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 19590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 19690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# sources only. Doxygen will then generate output that is more tailored for Java. 19790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# For instance, namespaces will be presented as packages, qualified scopes 19890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# will look different, etc. 19990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 20090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberOPTIMIZE_OUTPUT_JAVA = NO 20190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 20290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 20390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# include (a tag file for) the STL sources as input, then you should 20490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# set this tag to YES in order to let doxygen match functions declarations and 20590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 20690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# func(std::string) {}). This also make the inheritance and collaboration 20790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# diagrams that involve STL classes more complete and accurate. 20890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 20990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberBUILTIN_STL_SUPPORT = NO 21090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 21190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If you use Microsoft's C++/CLI language, you should set this option to YES to 21290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# enable parsing support. 21390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 21490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberCPP_CLI_SUPPORT = NO 21590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 21690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 21790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Doxygen will parse them like normal C++ but will assume all classes use public 21890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# instead of private inheritance when no explicit protection keyword is present. 21990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 22090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberSIP_SUPPORT = NO 22190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 22290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 22390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# tag is set to YES, then doxygen will reuse the documentation of the first 22490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# member in the group (if any) for the other members of the group. By default 22590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# all members of a group must be documented explicitly. 22690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 22790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberDISTRIBUTE_GROUP_DOC = NO 22890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 22990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Set the SUBGROUPING tag to YES (the defqault) to allow class member groups of 23090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the same type (for instance a group of public functions) to be put as a 23190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# subgroup of that type (e.g. under the Public Functions section). Set it to 23290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# NO to prevent subgrouping. Alternatively, this can be done per class using 23390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the \nosubgrouping command. 23490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 23590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberSUBGROUPING = YES 23690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 23790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct (or union) is 23890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# documented as struct with the name of the typedef. So 23990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# typedef struct type_s {} type_t, will appear in the documentation as a struct 24090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# with name type_t. When disabled the typedef will appear as a member of a file, 24190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# namespace, or class. And the struct will be named type_s. This can typically 24290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# be useful for C code where the coding convention is that all structs are 24390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# typedef'ed and only the typedef is referenced never the struct's name. 24490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 24590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberTYPEDEF_HIDES_STRUCT = NO 24690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 24790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 24890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Build related configuration options 24990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 25090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 25190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 25290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# documentation are documented, even if no documentation was available. 25390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Private class members and static file members will be hidden unless 25490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 25590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 25690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberEXTRACT_ALL = NO 25790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 25890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 25990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# will be included in the documentation. 26090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 26190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberEXTRACT_PRIVATE = NO 26290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 26390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the EXTRACT_STATIC tag is set to YES all static members of a file 26490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# will be included in the documentation. 26590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 26690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberEXTRACT_STATIC = NO 26790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 26890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 26990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# defined locally in source files will be included in the documentation. 27090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If set to NO only classes defined in header files are included. 27190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 27290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberEXTRACT_LOCAL_CLASSES = YES 27390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 27490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# This flag is only useful for Objective-C code. When set to YES local 27590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# methods, which are defined in the implementation section but not in 27690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the interface are included in the documentation. 27790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If set to NO (the default) only methods in the interface are included. 27890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 27990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberEXTRACT_LOCAL_METHODS = NO 28090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 28190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If this flag is set to YES, the members of anonymous namespaces will be extracted 28290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# and appear in the documentation as a namespace called 'anonymous_namespace{file}', 28390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# where file will be replaced with the base name of the file that contains the anonymous 28490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# namespace. By default anonymous namespace are hidden. 28590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 28690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberEXTRACT_ANON_NSPACES = NO 28790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 28890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 28990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# undocumented members of documented classes, files or namespaces. 29090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If set to NO (the default) these members will be included in the 29190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# various overviews, but no documentation section is generated. 29290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# This option has no effect if EXTRACT_ALL is enabled. 29390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 29490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberHIDE_UNDOC_MEMBERS = NO 29590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 29690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 29790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# undocumented classes that are normally visible in the class hierarchy. 29890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If set to NO (the default) these classes will be included in the various 29990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# overviews. This option has no effect if EXTRACT_ALL is enabled. 30090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 30190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberHIDE_UNDOC_CLASSES = NO 30290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 30390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 30490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# friend (class|struct|union) declarations. 30590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If set to NO (the default) these declarations will be included in the 30690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# documentation. 30790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 30890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberHIDE_FRIEND_COMPOUNDS = NO 30990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 31090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 31190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# documentation blocks found inside the body of a function. 31290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If set to NO (the default) these blocks will be appended to the 31390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# function's detailed documentation block. 31490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 31590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberHIDE_IN_BODY_DOCS = NO 31690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 31790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The INTERNAL_DOCS tag determines if documentation 31890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# that is typed after a \internal command is included. If the tag is set 31990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# to NO (the default) then the documentation will be excluded. 32090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Set it to YES to include the internal documentation. 32190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 32290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberINTERNAL_DOCS = NO 32390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 32490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 32590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# file names in lower-case letters. If set to YES upper-case letters are also 32690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# allowed. This is useful if you have classes or files whose names only differ 32790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# in case and if your file system supports case sensitive file names. Windows 32890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# and Mac users are advised to set this option to NO. 32990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 33090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberCASE_SENSE_NAMES = YES 33190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 33290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 33390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# will show members with their full class and namespace scopes in the 33490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# documentation. If set to YES the scope will be hidden. 33590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 33690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberHIDE_SCOPE_NAMES = NO 33790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 33890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 33990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# will put a list of the files that are included by a file in the documentation 34090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# of that file. 34190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 34290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberSHOW_INCLUDE_FILES = YES 34390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 34490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 34590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# is inserted in the documentation for inline members. 34690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 34790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberINLINE_INFO = YES 34890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 34990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 35090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# will sort the (detailed) documentation of file and class members 35190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# alphabetically by member name. If set to NO the members will appear in 35290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# declaration order. 35390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 35490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberSORT_MEMBER_DOCS = NO 35590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 35690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 35790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# brief documentation of file, namespace and class members alphabetically 35890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# by member name. If set to NO (the default) the members will appear in 35990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# declaration order. 36090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 36190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberSORT_BRIEF_DOCS = NO 36290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 36390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 36490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# sorted by fully-qualified names, including namespaces. If set to 36590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# NO (the default), the class list will be sorted only by class name, 36690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# not including the namespace part. 36790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 36890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Note: This option applies only to the class list, not to the 36990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# alphabetical list. 37090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 37190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberSORT_BY_SCOPE_NAME = NO 37290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 37390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The GENERATE_TODOLIST tag can be used to enable (YES) or 37490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# disable (NO) the todo list. This list is created by putting \todo 37590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# commands in the documentation. 37690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 37790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberGENERATE_TODOLIST = YES 37890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 37990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The GENERATE_TESTLIST tag can be used to enable (YES) or 38090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# disable (NO) the test list. This list is created by putting \test 38190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# commands in the documentation. 38290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 38390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberGENERATE_TESTLIST = YES 38490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 38590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The GENERATE_BUGLIST tag can be used to enable (YES) or 38690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# disable (NO) the bug list. This list is created by putting \bug 38790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# commands in the documentation. 38890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 38990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberGENERATE_BUGLIST = YES 39090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 39190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 39290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# disable (NO) the deprecated list. This list is created by putting 39390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# \deprecated commands in the documentation. 39490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 39590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberGENERATE_DEPRECATEDLIST= YES 39690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 39790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The ENABLED_SECTIONS tag can be used to enable conditional 39890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# documentation sections, marked by \if sectionname ... \endif. 39990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 40090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberENABLED_SECTIONS = 40190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 40290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 40390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the initial value of a variable or define consists of for it to appear in 40490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the documentation. If the initializer consists of more lines than specified 40590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# here it will be hidden. Use a value of 0 to hide initializers completely. 40690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The appearance of the initializer of individual variables and defines in the 40790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# documentation can be controlled using \showinitializer or \hideinitializer 40890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# command in the documentation regardless of this setting. 40990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 41090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberMAX_INITIALIZER_LINES = 30 41190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 41290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 41390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# at the bottom of the documentation of classes and structs. If set to YES the 41490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# list will mention the files that were used to generate the documentation. 41590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 41690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberSHOW_USED_FILES = YES 41790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 41890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the sources in your project are distributed over multiple directories 41990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 42090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# in the documentation. The default is NO. 42190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 42290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberSHOW_DIRECTORIES = NO 42390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 42490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The FILE_VERSION_FILTER tag can be used to specify a program or script that 42590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# doxygen should invoke to get the current version for each file (typically from the 42690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# version control system). Doxygen will invoke the program by executing (via 42790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# popen()) the command <command> <input-file>, where <command> is the value of 42890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 42990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# provided by doxygen. Whatever the program writes to standard output 43090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# is used as the file version. See the manual for examples. 43190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 43290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberFILE_VERSION_FILTER = 43390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 43490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 43590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# configuration options related to warning and progress messages 43690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 43790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 43890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The QUIET tag can be used to turn on/off the messages that are generated 43990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# by doxygen. Possible values are YES and NO. If left blank NO is used. 44090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 44190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberQUIET = YES 44290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 44390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The WARNINGS tag can be used to turn on/off the warning messages that are 44490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# generated by doxygen. Possible values are YES and NO. If left blank 44590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# NO is used. 44690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 44790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberWARNINGS = YES 44890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 44990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 45090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 45190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# automatically be disabled. 45290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 45390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberWARN_IF_UNDOCUMENTED = YES 45490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 45590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 45690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# potential errors in the documentation, such as not documenting some 45790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# parameters in a documented function, or documenting parameters that 45890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# don't exist or using markup commands wrongly. 45990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 46090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberWARN_IF_DOC_ERROR = YES 46190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 46290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# This WARN_NO_PARAMDOC option can be abled to get warnings for 46390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# functions that are documented, but have no documentation for their parameters 46490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# or return value. If set to NO (the default) doxygen will only warn about 46590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# wrong or incomplete parameter documentation, but not about the absence of 46690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# documentation. 46790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 46890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberWARN_NO_PARAMDOC = NO 46990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 47090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The WARN_FORMAT tag determines the format of the warning messages that 47190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# doxygen can produce. The string should contain the $file, $line, and $text 47290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# tags, which will be replaced by the file and line number from which the 47390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# warning originated and the warning text. Optionally the format may contain 47490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# $version, which will be replaced by the version of the file (if it could 47590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# be obtained via FILE_VERSION_FILTER) 47690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 47790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberWARN_FORMAT = "$file:$line: $text" 47890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 47990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The WARN_LOGFILE tag can be used to specify a file to which warning 48090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# and error messages should be written. If left blank the output is written 48190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# to stderr. 48290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 48390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberWARN_LOGFILE = 48490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 48590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 48690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# configuration options related to the input files 48790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 48890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 48990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The INPUT tag can be used to specify the files and/or directories that contain 49090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# documented source files. You may enter file names like "myfile.cpp" or 49190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# directories like "/usr/src/myproject". Separate the files or directories 49290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# with spaces. 49390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 49490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberINPUT = 49590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 49690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# This tag can be used to specify the character encoding of the source files that 49790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 49890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. 49990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# See http://www.gnu.org/software/libiconv for the list of possible encodings. 50090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 50190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberINPUT_ENCODING = UTF-8 50290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 50390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the value of the INPUT tag contains directories, you can use the 50490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 50590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# and *.h) to filter out the source-files in the directories. If left 50690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# blank the following patterns are tested: 50790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 50890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 50990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 51090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberFILE_PATTERNS = 51190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 51290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The RECURSIVE tag can be used to turn specify whether or not subdirectories 51390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# should be searched for input files as well. Possible values are YES and NO. 51490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If left blank NO is used. 51590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 51690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberRECURSIVE = NO 51790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 51890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The EXCLUDE tag can be used to specify files and/or directories that should 51990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# excluded from the INPUT source files. This way you can easily exclude a 52090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# subdirectory from a directory tree whose root is specified with the INPUT tag. 52190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 52290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberEXCLUDE = 52390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 52490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 52590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# directories that are symbolic links (a Unix filesystem feature) are excluded 52690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# from the input. 52790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 52890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberEXCLUDE_SYMLINKS = NO 52990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 53090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the value of the INPUT tag contains directories, you can use the 53190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 53290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# certain files from those directories. Note that the wildcards are matched 53390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# against the file with absolute path, so to exclude all test directories 53490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# for example use the pattern */test/* 53590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 53690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberEXCLUDE_PATTERNS = 53790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 53890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 53990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# (namespaces, classes, functions, etc.) that should be excluded from the output. 54090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The symbol name can be a fully qualified name, a word, or if the wildcard * is used, 54190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test 54290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 54390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberEXCLUDE_SYMBOLS = 54490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 54590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The EXAMPLE_PATH tag can be used to specify one or more files or 54690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# directories that contain example code fragments that are included (see 54790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the \include command). 54890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 54990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberEXAMPLE_PATH = 55090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 55190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the value of the EXAMPLE_PATH tag contains directories, you can use the 55290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 55390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# and *.h) to filter out the source-files in the directories. If left 55490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# blank all files are included. 55590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 55690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberEXAMPLE_PATTERNS = 55790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 55890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 55990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# searched for input files to be used with the \include or \dontinclude 56090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# commands irrespective of the value of the RECURSIVE tag. 56190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Possible values are YES and NO. If left blank NO is used. 56290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 56390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberEXAMPLE_RECURSIVE = NO 56490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 56590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The IMAGE_PATH tag can be used to specify one or more files or 56690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# directories that contain image that are included in the documentation (see 56790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the \image command). 56890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 56990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberIMAGE_PATH = 57090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 57190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The INPUT_FILTER tag can be used to specify a program that doxygen should 57290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# invoke to filter for each input file. Doxygen will invoke the filter program 57390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# by executing (via popen()) the command <filter> <input-file>, where <filter> 57490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 57590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# input file. Doxygen will then use the output that the filter program writes 57690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# to standard output. If FILTER_PATTERNS is specified, this tag will be 57790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# ignored. 57890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 57990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberINPUT_FILTER = 58090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 58190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 58290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# basis. Doxygen will compare the file name with each pattern and apply the 58390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# filter if there is a match. The filters are a list of the form: 58490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 58590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 58690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# is applied to all files. 58790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 58890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberFILTER_PATTERNS = 58990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 59090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 59190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# INPUT_FILTER) will be used to filter the input files when producing source 59290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# files to browse (i.e. when SOURCE_BROWSER is set to YES). 59390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 59490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberFILTER_SOURCE_FILES = NO 59590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 59690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 59790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# configuration options related to source browsing 59890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 59990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 60090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the SOURCE_BROWSER tag is set to YES then a list of source files will 60190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# be generated. Documented entities will be cross-referenced with these sources. 60290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Note: To get rid of all source code in the generated output, make sure also 60390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH 60490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# then you must also enable this option. If you don't then doxygen will produce 60590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# a warning and turn it on anyway 60690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 60790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberSOURCE_BROWSER = NO 60890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 60990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Setting the INLINE_SOURCES tag to YES will include the body 61090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# of functions and classes directly in the documentation. 61190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 61290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberINLINE_SOURCES = NO 61390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 61490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 61590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# doxygen to hide any special comment blocks from generated source code 61690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# fragments. Normal C and C++ comments will always remain visible. 61790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 61890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberSTRIP_CODE_COMMENTS = YES 61990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 62090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the REFERENCED_BY_RELATION tag is set to YES (the default) 62190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# then for each documented function all documented 62290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# functions referencing it will be listed. 62390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 62490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberREFERENCED_BY_RELATION = YES 62590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 62690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the REFERENCES_RELATION tag is set to YES (the default) 62790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# then for each documented function all documented entities 62890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# called/used by that function will be listed. 62990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 63090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberREFERENCES_RELATION = YES 63190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 63290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 63390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 63490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 63590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# link to the source code. Otherwise they will link to the documentstion. 63690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 63790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberREFERENCES_LINK_SOURCE = YES 63890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 63990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the USE_HTAGS tag is set to YES then the references to source code 64090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# will point to the HTML generated by the htags(1) tool instead of doxygen 64190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# built-in source browser. The htags tool is part of GNU's global source 64290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# tagging system (see http://www.gnu.org/software/global/global.html). You 64390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# will need version 4.8.6 or higher. 64490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 64590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberUSE_HTAGS = NO 64690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 64790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 64890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# will generate a verbatim copy of the header file for each class for 64990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# which an include is specified. Set to NO to disable this. 65090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 65190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberVERBATIM_HEADERS = YES 65290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 65390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 65490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# configuration options related to the alphabetical class index 65590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 65690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 65790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 65890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# of all compounds will be generated. Enable this if the project 65990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# contains a lot of classes, structs, unions or interfaces. 66090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 66190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberALPHABETICAL_INDEX = NO 66290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 66390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 66490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 66590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# in which this list will be split (can be a number in the range [1..20]) 66690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 66790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberCOLS_IN_ALPHA_INDEX = 5 66890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 66990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# In case all classes in a project start with a common prefix, all 67090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# classes will be put under the same header in the alphabetical index. 67190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 67290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# should be ignored while generating the index headers. 67390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 67490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberIGNORE_PREFIX = 67590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 67690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 67790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# configuration options related to the HTML output 67890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 67990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 68090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 68190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# generate HTML output. 68290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 68390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberGENERATE_HTML = YES 68490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 68590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 68690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If a relative path is entered the value of OUTPUT_DIRECTORY will be 68790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# put in front of it. If left blank `html' will be used as the default path. 68890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 68990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberHTML_OUTPUT = html 69090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 69190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 69290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 69390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# doxygen will generate files with .html extension. 69490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 69590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberHTML_FILE_EXTENSION = .html 69690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 69790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The HTML_HEADER tag can be used to specify a personal HTML header for 69890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# each generated HTML page. If it is left blank doxygen will generate a 69990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# standard header. 70090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 70190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberHTML_HEADER = 70290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 70390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The HTML_FOOTER tag can be used to specify a personal HTML footer for 70490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# each generated HTML page. If it is left blank doxygen will generate a 70590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# standard footer. 70690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 70790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberHTML_FOOTER = 70890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 70990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 71090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# style sheet that is used by each HTML page. It can be used to 71190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# fine-tune the look of the HTML output. If the tag is left blank doxygen 71290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# will generate a default style sheet. Note that doxygen will try to copy 71390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the style sheet file to the HTML output directory, so don't put your own 71490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# stylesheet in the HTML output directory as well, or it will be erased! 71590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 71690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberHTML_STYLESHEET = 71790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 71890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 71990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# files or namespaces will be aligned in HTML using tables. If set to 72090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# NO a bullet list will be used. 72190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 72290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberHTML_ALIGN_MEMBERS = YES 72390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 72490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the GENERATE_HTMLHELP tag is set to YES, additional index files 72590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# will be generated that can be used as input for tools like the 72690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 72790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# of the generated HTML documentation. 72890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 72990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberGENERATE_HTMLHELP = NO 73090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 73190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 73290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# documentation will contain sections that can be hidden and shown after the 73390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# page has loaded. For this to work a browser that supports 73490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# java_script and DHTML is required (for instance Mozilla 1.0+, Firefox 73590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 73690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 73790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberHTML_DYNAMIC_SECTIONS = NO 73890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 73990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 74090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# be used to specify the file name of the resulting .chm file. You 74190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# can add a path in front of the file if the result should not be 74290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# written to the html output directory. 74390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 74490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberCHM_FILE = 74590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 74690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 74790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# be used to specify the location (absolute path including file name) of 74890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 74990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the HTML help compiler on the generated index.hhp. 75090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 75190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberHHC_LOCATION = 75290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 75390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 75490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# controls if a separate .chi index file is generated (YES) or that 75590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# it should be included in the master .chm file (NO). 75690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 75790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberGENERATE_CHI = NO 75890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 75990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 76090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# controls whether a binary table of contents is generated (YES) or a 76190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# normal table of contents (NO) in the .chm file. 76290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 76390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberBINARY_TOC = NO 76490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 76590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The TOC_EXPAND flag can be set to YES to add extra items for group members 76690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# to the contents of the HTML help documentation and to the tree view. 76790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 76890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberTOC_EXPAND = NO 76990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 77090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 77190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# top of each HTML page. The value NO (the default) enables the index and 77290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the value YES disables it. 77390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 77490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberDISABLE_INDEX = NO 77590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 77690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# This tag can be used to set the number of enum values (range [1..20]) 77790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# that doxygen will group on one line in the generated HTML documentation. 77890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 77990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberENUM_VALUES_PER_LINE = 4 78090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 78190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 78290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# generated containing a tree-like index structure (just like the one that 78390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# is generated for HTML Help). For this to work a browser that supports 78490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# java_script, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 78590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 78690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# probably better off using the HTML help feature. 78790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 78890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberGENERATE_TREEVIEW = NO 78990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 79090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 79190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# used to set the initial width (in pixels) of the frame in which the tree 79290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# is shown. 79390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 79490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberTREEVIEW_WIDTH = 250 79590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 79690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 79790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# configuration options related to the la_te_x output 79890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 79990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 80090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 80190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# generate Latex output. 80290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 80390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberGENERATE_LATEX = YES 80490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 80590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The LATEX_OUTPUT tag is used to specify where the la_te_x docs will be put. 80690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If a relative path is entered the value of OUTPUT_DIRECTORY will be 80790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# put in front of it. If left blank `latex' will be used as the default path. 80890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 80990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberLATEX_OUTPUT = latex 81090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 81190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The LATEX_CMD_NAME tag can be used to specify the la_te_x command name to be 81290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# invoked. If left blank `latex' will be used as the default command name. 81390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 81490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberLATEX_CMD_NAME = latex 81590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 81690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 81790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# generate index for la_te_x. If left blank `makeindex' will be used as the 81890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# default command name. 81990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 82090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberMAKEINDEX_CMD_NAME = makeindex 82190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 82290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 82390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# la_te_x documents. This may be useful for small projects and may help to 82490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# save some trees in general. 82590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 82690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberCOMPACT_LATEX = YES 82790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 82890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The PAPER_TYPE tag can be used to set the paper type that is used 82990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# by the printer. Possible values are: a4, a4wide, letter, legal and 83090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# executive. If left blank a4wide will be used. 83190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 83290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberPAPER_TYPE = letter 83390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 83490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The EXTRA_PACKAGES tag can be to specify one or more names of la_te_x 83590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# packages that should be included in the la_te_x output. 83690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 83790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberEXTRA_PACKAGES = 83890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 83990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The LATEX_HEADER tag can be used to specify a personal la_te_x header for 84090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the generated latex document. The header should contain everything until 84190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the first chapter. If it is left blank doxygen will generate a 84290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# standard header. Notice: only use this tag if you know what you are doing! 84390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 84490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberLATEX_HEADER = 84590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 84690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the PDF_HYPERLINKS tag is set to YES, the la_te_x that is generated 84790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# is prepared for conversion to pdf (using ps2pdf). The pdf file will 84890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# contain links (just like the HTML output) instead of page references 84990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# This makes the output suitable for online browsing using a pdf viewer. 85090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 85190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberPDF_HYPERLINKS = YES 85290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 85390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 85490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# plain latex in the generated Makefile. Set this option to YES to get a 85590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# higher quality PDF documentation. 85690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 85790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberUSE_PDFLATEX = YES 85890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 85990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 86090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# command to the generated la_te_x files. This will instruct la_te_x to keep 86190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# running if errors occur, instead of asking the user for help. 86290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# This option is also used when generating formulas in HTML. 86390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 86490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberLATEX_BATCHMODE = NO 86590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 86690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If LATEX_HIDE_INDICES is set to YES then doxygen will not 86790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# include the index chapters (such as File Index, Compound Index, etc.) 86890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# in the output. 86990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 87090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberLATEX_HIDE_INDICES = NO 87190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 87290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 87390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# configuration options related to the RTF output 87490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 87590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 87690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 87790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The RTF output is optimized for Word 97 and may not look very pretty with 87890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# other RTF readers or editors. 87990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 88090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberGENERATE_RTF = NO 88190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 88290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 88390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If a relative path is entered the value of OUTPUT_DIRECTORY will be 88490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# put in front of it. If left blank `rtf' will be used as the default path. 88590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 88690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberRTF_OUTPUT = rtf 88790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 88890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 88990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# RTF documents. This may be useful for small projects and may help to 89090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# save some trees in general. 89190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 89290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberCOMPACT_RTF = NO 89390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 89490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 89590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# will contain hyperlink fields. The RTF file will 89690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# contain links (just like the HTML output) instead of page references. 89790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# This makes the output suitable for online browsing using WORD or other 89890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# programs which support those fields. 89990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Note: wordpad (write) and others do not support links. 90090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 90190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberRTF_HYPERLINKS = NO 90290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 90390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Load stylesheet definitions from file. Syntax is similar to doxygen's 90490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# config file, i.e. a series of assignments. You only have to provide 90590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# replacements, missing definitions are set to their default value. 90690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 90790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberRTF_STYLESHEET_FILE = 90890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 90990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Set optional variables used in the generation of an rtf document. 91090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Syntax is similar to doxygen's config file. 91190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 91290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberRTF_EXTENSIONS_FILE = 91390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 91490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 91590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# configuration options related to the man page output 91690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 91790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 91890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 91990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# generate man pages 92090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 92190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberGENERATE_MAN = NO 92290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 92390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The MAN_OUTPUT tag is used to specify where the man pages will be put. 92490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If a relative path is entered the value of OUTPUT_DIRECTORY will be 92590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# put in front of it. If left blank `man' will be used as the default path. 92690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 92790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberMAN_OUTPUT = man 92890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 92990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The MAN_EXTENSION tag determines the extension that is added to 93090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the generated man pages (default is the subroutine's section .3) 93190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 93290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberMAN_EXTENSION = .3 93390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 93490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 93590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# then it will generate one additional man file for each entity 93690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# documented in the real man page(s). These additional files 93790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# only source the real man page, but without them the man command 93890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# would be unable to find the correct page. The default is NO. 93990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 94090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberMAN_LINKS = YES 94190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 94290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 94390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# configuration options related to the XML output 94490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 94590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 94690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the GENERATE_XML tag is set to YES Doxygen will 94790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# generate an XML file that captures the structure of 94890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the code including all documentation. 94990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 95090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberGENERATE_XML = NO 95190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 95290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The XML_OUTPUT tag is used to specify where the XML pages will be put. 95390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If a relative path is entered the value of OUTPUT_DIRECTORY will be 95490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# put in front of it. If left blank `xml' will be used as the default path. 95590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 95690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberXML_OUTPUT = xml 95790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 95890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The XML_SCHEMA tag can be used to specify an XML schema, 95990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# which can be used by a validating XML parser to check the 96090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# syntax of the XML files. 96190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 96290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberXML_SCHEMA = 96390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 96490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The XML_DTD tag can be used to specify an XML DTD, 96590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# which can be used by a validating XML parser to check the 96690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# syntax of the XML files. 96790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 96890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberXML_DTD = 96990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 97090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 97190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# dump the program listings (including syntax highlighting 97290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# and cross-referencing information) to the XML output. Note that 97390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# enabling this will significantly increase the size of the XML output. 97490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 97590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberXML_PROGRAMLISTING = YES 97690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 97790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 97890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# configuration options for the auto_gen Definitions output 97990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 98090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 98190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 98290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# generate an auto_gen Definitions (see autogen.sf.net) file 98390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# that captures the structure of the code including all 98490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# documentation. Note that this feature is still experimental 98590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# and incomplete at the moment. 98690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 98790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberGENERATE_AUTOGEN_DEF = NO 98890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 98990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 99090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# configuration options related to the Perl module output 99190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 99290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 99390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the GENERATE_PERLMOD tag is set to YES Doxygen will 99490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# generate a Perl module file that captures the structure of 99590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the code including all documentation. Note that this 99690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# feature is still experimental and incomplete at the 99790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# moment. 99890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 99990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberGENERATE_PERLMOD = NO 100090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 100190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 100290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the necessary Makefile rules, Perl scripts and la_te_x code to be able 100390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# to generate PDF and DVI output from the Perl module output. 100490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 100590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberPERLMOD_LATEX = NO 100690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 100790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 100890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# nicely formatted so it can be parsed by a human reader. This is useful 100990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# if you want to understand what is going on. On the other hand, if this 101090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# tag is set to NO the size of the Perl module output will be much smaller 101190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# and Perl will parse it just the same. 101290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 101390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberPERLMOD_PRETTY = YES 101490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 101590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The names of the make variables in the generated doxyrules.make file 101690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 101790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# This is useful so different doxyrules.make files included by the same 101890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Makefile don't overwrite each other's variables. 101990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 102090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberPERLMOD_MAKEVAR_PREFIX = 102190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 102290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 102390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Configuration options related to the preprocessor 102490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 102590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 102690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 102790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# evaluate all C-preprocessor directives found in the sources and include 102890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# files. 102990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 103090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberENABLE_PREPROCESSING = YES 103190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 103290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 103390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# names in the source code. If set to NO (the default) only conditional 103490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# compilation will be performed. Macro expansion can be done in a controlled 103590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# way by setting EXPAND_ONLY_PREDEF to YES. 103690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 103790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberMACRO_EXPANSION = YES 103890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 103990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 104090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# then the macro expansion is limited to the macros specified with the 104190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# PREDEFINED and EXPAND_AS_DEFINED tags. 104290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 104390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberEXPAND_ONLY_PREDEF = NO 104490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 104590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 104690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# in the INCLUDE_PATH (see below) will be search if a #include is found. 104790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 104890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberSEARCH_INCLUDES = YES 104990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 105090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The INCLUDE_PATH tag can be used to specify one or more directories that 105190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# contain include files that are not input files but should be processed by 105290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the preprocessor. 105390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 105490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberINCLUDE_PATH = 105590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 105690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 105790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# patterns (like *.h and *.hpp) to filter out the header-files in the 105890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# directories. If left blank, the patterns specified with FILE_PATTERNS will 105990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# be used. 106090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 106190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberINCLUDE_FILE_PATTERNS = *.h 106290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 106390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The PREDEFINED tag can be used to specify one or more macro names that 106490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# are defined before the preprocessor is started (similar to the -D option of 106590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# gcc). The argument of the tag is a list of macros of the form: name 106690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# or name=definition (no spaces). If the definition and the = are 106790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# omitted =1 is assumed. To prevent a macro definition from being 106890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# undefined via #undef or recursively expanded use the := operator 106990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# instead of the = operator. 107090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 107190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberPREDEFINED = 107290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 107390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 107490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# this tag can be used to specify a list of macro names that should be expanded. 107590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The macro definition that is found in the sources will be used. 107690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Use the PREDEFINED tag if you want to use a different macro definition. 107790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 107890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberEXPAND_AS_DEFINED = 107990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 108090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 108190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# doxygen's preprocessor will remove all function-like macros that are alone 108290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# on a line, have an all uppercase name, and do not end with a semicolon. Such 108390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# function macros are typically used for boiler-plate code, and will confuse 108490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the parser if not removed. 108590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 108690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberSKIP_FUNCTION_MACROS = YES 108790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 108890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 108990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Configuration::additions related to external references 109090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 109190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 109290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The TAGFILES option can be used to specify one or more tagfiles. 109390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Optionally an initial location of the external documentation 109490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# can be added for each tagfile. The format of a tag file without 109590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# this location is as follows: 109690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# TAGFILES = file1 file2 ... 109790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Adding location for the tag files is done as follows: 109890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# TAGFILES = file1=loc1 "file2 = loc2" ... 109990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# where "loc1" and "loc2" can be relative or absolute paths or 110090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# URLs. If a location is present for each tag, the installdox tool 110190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# does not have to be run to correct the links. 110290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Note that each tag file must have a unique name 110390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# (where the name does NOT include the path) 110490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If a tag file is not located in the directory in which doxygen 110590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# is run, you must also specify the path to the tagfile here. 110690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 110790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberTAGFILES = 110890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 110990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# When a file name is specified after GENERATE_TAGFILE, doxygen will create 111090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# a tag file that is based on the input files it reads. 111190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 111290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberGENERATE_TAGFILE = 111390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 111490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the ALLEXTERNALS tag is set to YES all external classes will be listed 111590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# in the class index. If set to NO only the inherited external classes 111690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# will be listed. 111790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 111890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberALLEXTERNALS = NO 111990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 112090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 112190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# in the modules index. If set to NO, only the current project's groups will 112290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# be listed. 112390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 112490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberEXTERNAL_GROUPS = YES 112590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 112690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The PERL_PATH should be the absolute path and name of the perl script 112790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# interpreter (i.e. the result of `which perl'). 112890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 112990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberPERL_PATH = /usr/bin/perl 113090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 113190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 113290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Configuration options related to the dot tool 113390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 113490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 113590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 113690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# generate a inheritance diagram (in HTML, RTF and la_te_x) for classes with base 113790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# or super classes. Setting the tag to NO turns the diagrams off. Note that 113890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# this option is superseded by the HAVE_DOT option below. This is only a 113990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# fallback. It is recommended to install and use dot, since it yields more 114090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# powerful graphs. 114190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 114290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberCLASS_DIAGRAMS = YES 114390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 114490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# You can define message sequence charts within doxygen comments using the \msc 114590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to 114690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to 114790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# specify the directory where the mscgen tool resides. If left empty the tool is assumed to 114890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# be found in the default search path. 114990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 115090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberMSCGEN_PATH = 115190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 115290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If set to YES, the inheritance and collaboration graphs will hide 115390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# inheritance and usage relations if the target is undocumented 115490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# or is not a class. 115590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 115690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberHIDE_UNDOC_RELATIONS = YES 115790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 115890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 115990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# available from the path. This tool is part of Graphviz, a graph visualization 116090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# toolkit from AT&T and Lucent Bell Labs. The other options in this section 116190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# have no effect if this option is set to NO (the default) 116290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 116390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberHAVE_DOT = NO 116490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 116590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 116690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# will generate a graph for each documented class showing the direct and 116790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# indirect inheritance relations. Setting this tag to YES will force the 116890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the CLASS_DIAGRAMS tag to NO. 116990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 117090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberCLASS_GRAPH = YES 117190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 117290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 117390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# will generate a graph for each documented class showing the direct and 117490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# indirect implementation dependencies (inheritance, containment, and 117590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# class references variables) of the class with other documented classes. 117690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 117790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberCOLLABORATION_GRAPH = YES 117890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 117990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 118090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# will generate a graph for groups, showing the direct groups dependencies 118190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 118290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberGROUP_GRAPHS = YES 118390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 118490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 118590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# collaboration diagrams in a style similar to the OMG's Unified Modeling 118690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Language. 118790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 118890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberUML_LOOK = NO 118990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 119090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If set to YES, the inheritance and collaboration graphs will show the 119190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# relations between templates and their instances. 119290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 119390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberTEMPLATE_RELATIONS = NO 119490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 119590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 119690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# tags are set to YES then doxygen will generate a graph for each documented 119790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# file showing the direct and indirect include dependencies of the file with 119890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# other documented files. 119990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 120090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberINCLUDE_GRAPH = YES 120190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 120290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 120390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 120490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# documented header file showing the documented files that directly or 120590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# indirectly include this file. 120690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 120790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberINCLUDED_BY_GRAPH = YES 120890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 120990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will 121090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# generate a call dependency graph for every global function or class method. 121190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Note that enabling this option will significantly increase the time of a run. 121290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# So in most cases it will be better to enable call graphs for selected 121390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# functions only using the \callgraph command. 121490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 121590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberCALL_GRAPH = NO 121690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 121790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will 121890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# generate a caller dependency graph for every global function or class method. 121990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Note that enabling this option will significantly increase the time of a run. 122090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# So in most cases it will be better to enable caller graphs for selected 122190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# functions only using the \callergraph command. 122290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 122390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberCALLER_GRAPH = NO 122490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 122590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 122690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# will graphical hierarchy of all classes instead of a textual one. 122790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 122890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberGRAPHICAL_HIERARCHY = YES 122990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 123090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 123190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# then doxygen will show the dependencies a directory has on other directories 123290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# in a graphical way. The dependency relations are determined by the #include 123390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# relations between the files in the directories. 123490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 123590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberDIRECTORY_GRAPH = YES 123690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 123790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 123890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# generated by dot. Possible values are png, jpg, or gif 123990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If left blank png will be used. 124090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 124190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberDOT_IMAGE_FORMAT = png 124290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 124390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The tag DOT_PATH can be used to specify the path where the dot tool can be 124490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# found. If left blank, it is assumed the dot tool can be found in the path. 124590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 124690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberDOT_PATH = 124790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 124890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The DOTFILE_DIRS tag can be used to specify one or more directories that 124990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# contain dot files that are included in the documentation (see the 125090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# \dotfile command). 125190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 125290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberDOTFILE_DIRS = 125390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 125490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 125590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# nodes that will be shown in the graph. If the number of nodes in a graph 125690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# becomes larger than this value, doxygen will truncate the graph, which is 125790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# visualized by representing a node as a red box. Note that doxygen if the number 125890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# of direct children of the root node in a graph is already larger than 125990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note 126090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 126190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 126290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberDOT_GRAPH_MAX_NODES = 50 126390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 126490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 126590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# graphs generated by dot. A depth value of 3 means that only nodes reachable 126690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# from the root by following a path via at most 3 edges will be shown. Nodes 126790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# that lay further from the root node will be omitted. Note that setting this 126890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# option to 1 or 2 may greatly reduce the computation time needed for large 126990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# code bases. Also note that the size of a graph can be further restricted by 127090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 127190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 127290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberMAX_DOT_GRAPH_DEPTH = 0 127390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 127490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 127590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# background. This is disabled by default, which results in a white background. 127690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Warning: Depending on the platform used, enabling this option may lead to 127790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 127890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# read). 127990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 128090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberDOT_TRANSPARENT = YES 128190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 128290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 128390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# files in one run (i.e. multiple -o and -T options on the command line). This 128490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# makes dot run faster, but since only newer versions of dot (>1.8.10) 128590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# support this, this feature is disabled by default. 128690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 128790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberDOT_MULTI_TARGETS = NO 128890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 128990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 129090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# generate a legend page explaining the meaning of the various boxes and 129190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# arrows in the dot generated graphs. 129290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 129390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberGENERATE_LEGEND = YES 129490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 129590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 129690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# remove the intermediate dot files that are used to generate 129790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# the various graphs. 129890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 129990d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberDOT_CLEANUP = YES 130090d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 130190d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 130290d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# Configuration::additions related to the search engine 130390d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber#--------------------------------------------------------------------------- 130490d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 130590d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# The SEARCHENGINE tag specifies whether or not a search engine should be 130690d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber# used. If set to NO the values of all tags below this one will be ignored. 130790d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas Huber 130890d3ed91ae9228e1c8bab561b6138d4cb8c1e4fdAndreas HuberSEARCHENGINE = NO 1309