module Language.Drasil.Code.Imperative.Doxygen.Import (
makeDoxConfig, yes, no
) where
import Utils.Drasil (blank)
import Drasil.GOOL (GOOLState, headers, mainMod)
import Language.Drasil.Choices (Verbosity(..))
import Data.List (intersperse, nub)
import Data.Maybe (maybeToList)
import Control.Lens ((^.))
import Text.PrettyPrint.HughesPJ (Doc, (<+>), text, hcat, vcat)
type OptimizeChoice = Doc
type ProjName = String
yes, no, defaultValSentence :: Doc
yes :: Doc
yes = String -> Doc
text String
"YES"
no :: Doc
no = String -> Doc
text String
"NO"
defaultValSentence :: Doc
defaultValSentence = String -> Doc
text String
"# The default value is: "
verbosityToDoc :: Verbosity -> Doc
verbosityToDoc :: Verbosity -> Doc
verbosityToDoc Verbosity
Verbose = Doc
no
verbosityToDoc Verbosity
Quiet = Doc
yes
defNo, defYes :: Doc
defNo :: Doc
defNo = Doc
defaultValSentence Doc -> Doc -> Doc
forall a. Semigroup a => a -> a -> a
<> Doc
no Doc -> Doc -> Doc
forall a. Semigroup a => a -> a -> a
<> String -> Doc
text String
"."
defYes :: Doc
defYes = Doc
defaultValSentence Doc -> Doc -> Doc
forall a. Semigroup a => a -> a -> a
<> Doc
yes Doc -> Doc -> Doc
forall a. Semigroup a => a -> a -> a
<> String -> Doc
text String
"."
makeDoxConfig :: ProjName -> GOOLState -> OptimizeChoice -> Verbosity -> Doc
makeDoxConfig :: String -> GOOLState -> Doc -> Verbosity -> Doc
makeDoxConfig String
prog GOOLState
s Doc
opt Verbosity
v =
let fs :: [String]
fs = [String] -> [String]
forall a. Eq a => [a] -> [a]
nub (GOOLState
s GOOLState -> Getting [String] GOOLState [String] -> [String]
forall s a. s -> Getting a s a -> a
^. Getting [String] GOOLState [String]
Lens' GOOLState [String]
headers [String] -> [String] -> [String]
forall a. [a] -> [a] -> [a]
++ Maybe String -> [String]
forall a. Maybe a -> [a]
maybeToList (GOOLState
s GOOLState
-> Getting (Maybe String) GOOLState (Maybe String) -> Maybe String
forall s a. s -> Getting a s a -> a
^. Getting (Maybe String) GOOLState (Maybe String)
Lens' GOOLState (Maybe String)
mainMod))
in [Doc] -> Doc
vcat [
String -> Doc
text String
"# Doxyfile 1.8.15",
Doc
blank,
String -> Doc
text String
"# This file describes the settings to be used by the documentation system",
String -> Doc
text String
"# doxygen (www.doxygen.org) for a project.",
String -> Doc
text String
"#",
String -> Doc
text String
"# All text after a double hash (##) is considered a comment and is placed in",
String -> Doc
text String
"# front of the TAG it is preceding.",
String -> Doc
text String
"#",
String -> Doc
text String
"# All text after a single hash (#) is considered a comment and will be ignored.",
String -> Doc
text String
"# The format is:",
String -> Doc
text String
"# TAG = value [value, ...]",
String -> Doc
text String
"# For lists, items can also be appended using:",
String -> Doc
text String
"# TAG += value [value, ...]",
String -> Doc
text String
"# Values that contain spaces should be placed between quotes (\\\" \\\").",
Doc
blank,
String -> Doc
text String
"#---------------------------------------------------------------------------",
String -> Doc
text String
"# Project related configuration options",
String -> Doc
text String
"#---------------------------------------------------------------------------",
Doc
blank,
String -> Doc
text String
"# This tag specifies the encoding used for all characters in the configuration",
String -> Doc
text String
"# file that follow. The default is UTF-8 which is also the encoding used for all",
String -> Doc
text String
"# text before the first occurrence of this tag. Doxygen uses libiconv (or the",
String -> Doc
text String
"# iconv built into libc) for the transcoding. See",
String -> Doc
text String
"# https://www.gnu.org/software/libiconv/ for the list of possible encodings.",
String -> Doc
text String
"# The default value is: UTF-8.",
Doc
blank,
String -> Doc
text String
"DOXYFILE_ENCODING = UTF-8",
Doc
blank,
String -> Doc
text String
"# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by",
String -> Doc
text String
"# double-quotes, unless you are using Doxywizard) that should identify the",
String -> Doc
text String
"# project for which the documentation is generated. This name is used in the",
String -> Doc
text String
"# title of most generated pages and in a few other places.",
String -> Doc
text String
"# The default value is: My Project.",
Doc
blank,
String -> Doc
text (String -> Doc) -> String -> Doc
forall a b. (a -> b) -> a -> b
$ String
"PROJECT_NAME = \"" String -> String -> String
forall a. [a] -> [a] -> [a]
++ String
prog String -> String -> String
forall a. [a] -> [a] -> [a]
++ String
"\"",
Doc
blank,
String -> Doc
text String
"# The PROJECT_NUMBER tag can be used to enter a project or revision number. This",
String -> Doc
text String
"# could be handy for archiving the generated documentation or if some version",
String -> Doc
text String
"# control system is used.",
Doc
blank,
String -> Doc
text String
"PROJECT_NUMBER =",
Doc
blank,
String -> Doc
text String
"# Using the PROJECT_BRIEF tag one can provide an optional one line description",
String -> Doc
text String
"# for a project that appears at the top of each page and should give viewer a",
String -> Doc
text String
"# quick idea about the purpose of the project. Keep the description short.",
Doc
blank,
String -> Doc
text String
"PROJECT_BRIEF =",
Doc
blank,
String -> Doc
text String
"# With the PROJECT_LOGO tag one can specify a logo or an icon that is included",
String -> Doc
text String
"# in the documentation. The maximum height of the logo should not exceed 55",
String -> Doc
text String
"# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy",
String -> Doc
text String
"# the logo to the output directory.",
Doc
blank,
String -> Doc
text String
"PROJECT_LOGO =",
Doc
blank,
String -> Doc
text String
"# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path",
String -> Doc
text String
"# into which the generated documentation will be written. If a relative path is",
String -> Doc
text String
"# entered, it will be relative to the location where doxygen was started. If",
String -> Doc
text String
"# left blank the current directory will be used.",
Doc
blank,
String -> Doc
text String
"OUTPUT_DIRECTORY =",
Doc
blank,
String -> Doc
text String
"# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-",
String -> Doc
text String
"# directories (in 2 levels) under the output directory of each output format and",
String -> Doc
text String
"# will distribute the generated files over these directories. Enabling this",
String -> Doc
text String
"# option can be useful when feeding doxygen a huge amount of source files, where",
String -> Doc
text String
"# putting all generated files in the same directory would otherwise causes",
String -> Doc
text String
"# performance problems for the file system.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"CREATE_SUBDIRS = NO",
Doc
blank,
String -> Doc
text String
"# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII",
String -> Doc
text String
"# characters to appear in the names of generated files. If set to NO, non-ASCII",
String -> Doc
text String
"# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode",
String -> Doc
text String
"# U+3044.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"ALLOW_UNICODE_NAMES = NO",
Doc
blank,
String -> Doc
text String
"# The OUTPUT_LANGUAGE tag is used to specify the language in which all",
String -> Doc
text String
"# documentation generated by doxygen is written. Doxygen will use this",
String -> Doc
text String
"# information to generate all constant output in the proper language.",
String -> Doc
text String
"# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,",
String -> Doc
text String
"# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),",
String -> Doc
text String
"# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,",
String -> Doc
text String
"# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),",
String -> Doc
text String
"# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,",
String -> Doc
text String
"# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,",
String -> Doc
text String
"# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,",
String -> Doc
text String
"# Ukrainian and Vietnamese.",
String -> Doc
text String
"# The default value is: English.",
Doc
blank,
String -> Doc
text String
"OUTPUT_LANGUAGE = English",
Doc
blank,
String -> Doc
text String
"# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member",
String -> Doc
text String
"# descriptions after the members that are listed in the file and class",
String -> Doc
text String
"# documentation (similar to Javadoc). Set to NO to disable this.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"BRIEF_MEMBER_DESC = YES",
Doc
blank,
String -> Doc
text String
"# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief",
String -> Doc
text String
"# description of a member or function before the detailed description",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the",
String -> Doc
text String
"# brief descriptions will be completely suppressed.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"REPEAT_BRIEF = YES",
Doc
blank,
String -> Doc
text String
"# This tag implements a quasi-intelligent brief description abbreviator that is",
String -> Doc
text String
"# used to form the text in various listings. Each string in this list, if found",
String -> Doc
text String
"# as the leading text of the brief description, will be stripped from the text",
String -> Doc
text String
"# and the result, after processing the whole list, is used as the annotated",
String -> Doc
text String
"# text. Otherwise, the brief description is used as-is. If left blank, the",
String -> Doc
text String
"# following values are used ($name is automatically replaced with the name of",
String -> Doc
text String
"# the entity):The $name class, The $name widget, The $name file, is, provides,",
String -> Doc
text String
"# specifies, contains, represents, a, an and the.",
Doc
blank,
String -> Doc
text String
"ABBREVIATE_BRIEF = \"The $name class\" \\",
String -> Doc
text String
" \"The $name widget\" \\",
String -> Doc
text String
" \"The $name file\" \\",
String -> Doc
text String
" is \\",
String -> Doc
text String
" provides \\",
String -> Doc
text String
" specifies \\",
String -> Doc
text String
" contains \\",
String -> Doc
text String
" represents \\",
String -> Doc
text String
" a \\",
String -> Doc
text String
" an \\",
String -> Doc
text String
" the",
Doc
blank,
String -> Doc
text String
"# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then",
String -> Doc
text String
"# doxygen will generate a detailed section even if there is only a brief",
String -> Doc
text String
"# description.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"ALWAYS_DETAILED_SEC = NO",
Doc
blank,
String -> Doc
text String
"# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all",
String -> Doc
text String
"# inherited members of a class in the documentation of that class as if those",
String -> Doc
text String
"# members were ordinary class members. Constructors, destructors and assignment",
String -> Doc
text String
"# operators of the base classes will not be shown.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"INLINE_INHERITED_MEMB = NO",
Doc
blank,
String -> Doc
text String
"# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path",
String -> Doc
text String
"# before files name in the file list and in the header files. If set to NO the",
String -> Doc
text String
"# shortest path that makes the file name unique will be used",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"FULL_PATH_NAMES = YES",
Doc
blank,
String -> Doc
text String
"# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.",
String -> Doc
text String
"# Stripping is only done if one of the specified strings matches the left-hand",
String -> Doc
text String
"# part of the path. The tag can be used to show relative paths in the file list.",
String -> Doc
text String
"# If left blank the directory from which doxygen is run is used as the path to",
String -> Doc
text String
"# strip.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that you can specify absolute paths here, but also relative paths, which",
String -> Doc
text String
"# will be relative from the directory where doxygen is started.",
String -> Doc
text String
"# This tag requires that the tag FULL_PATH_NAMES is set to YES.",
Doc
blank,
String -> Doc
text String
"STRIP_FROM_PATH =",
Doc
blank,
String -> Doc
text String
"# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the",
String -> Doc
text String
"# path mentioned in the documentation of a class, which tells the reader which",
String -> Doc
text String
"# header file to include in order to use a class. If left blank only the name of",
String -> Doc
text String
"# the header file containing the class definition is used. Otherwise one should",
String -> Doc
text String
"# specify the list of include paths that are normally passed to the compiler",
String -> Doc
text String
"# using the -I flag.",
Doc
blank,
String -> Doc
text String
"STRIP_FROM_INC_PATH =",
Doc
blank,
String -> Doc
text String
"# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but",
String -> Doc
text String
"# less readable) file names. This can be useful is your file systems doesn't",
String -> Doc
text String
"# support long names like on DOS, Mac, or CD-ROM.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"SHORT_NAMES = NO",
Doc
blank,
String -> Doc
text String
"# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the",
String -> Doc
text String
"# first line (until the first dot) of a Javadoc-style comment as the brief",
String -> Doc
text String
"# description. If set to NO, the Javadoc-style will behave just like regular Qt-",
String -> Doc
text String
"# style comments (thus requiring an explicit @brief command for a brief",
String -> Doc
text String
"# description.)",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"JAVADOC_AUTOBRIEF = NO",
Doc
blank,
String -> Doc
text String
"# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first",
String -> Doc
text String
"# line (until the first dot) of a Qt-style comment as the brief description. If",
String -> Doc
text String
"# set to NO, the Qt-style will behave just like regular Qt-style comments (thus",
String -> Doc
text String
"# requiring an explicit \\brief command for a brief description.)",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"QT_AUTOBRIEF = NO",
Doc
blank,
String -> Doc
text String
"# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a",
String -> Doc
text String
"# multi-line C++ special comment block (i.e. a block of //! or /// comments) as",
String -> Doc
text String
"# a brief description. This used to be the default behavior. The new default is",
String -> Doc
text String
"# to treat a multi-line C++ comment block as a detailed description. Set this",
String -> Doc
text String
"# tag to YES if you prefer the old behavior instead.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that setting this tag to YES also means that rational rose comments are",
String -> Doc
text String
"# not recognized any more.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"MULTILINE_CPP_IS_BRIEF = NO",
Doc
blank,
String -> Doc
text String
"# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the",
String -> Doc
text String
"# documentation from any documented member that it re-implements.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"INHERIT_DOCS = YES",
Doc
blank,
String -> Doc
text String
"# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new",
String -> Doc
text String
"# page for each member. If set to NO, the documentation of a member will be part",
String -> Doc
text String
"# of the file/class/namespace that contains it.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"SEPARATE_MEMBER_PAGES = NO",
Doc
blank,
String -> Doc
text String
"# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen",
String -> Doc
text String
"# uses this value to replace tabs by spaces in code fragments.",
String -> Doc
text String
"# Minimum value: 1, maximum value: 16, default value: 4.",
Doc
blank,
String -> Doc
text String
"TAB_SIZE = 4",
Doc
blank,
String -> Doc
text String
"# This tag can be used to specify a number of aliases that act as commands in",
String -> Doc
text String
"# the documentation. An alias has the form:",
String -> Doc
text String
"# name=value",
String -> Doc
text String
"# For example adding",
String -> Doc
text String
"# \"sideeffect=@par Side Effects:\\n\"",
String -> Doc
text String
"# will allow you to put the command \\sideeffect (or @sideeffect) in the",
String -> Doc
text String
"# documentation, which will result in a user-defined paragraph with heading",
String -> Doc
text String
"# \"Side Effects:\". You can put \\n's in the value part of an alias to insert",
String -> Doc
text String
"# newlines (in the resulting output). You can put ^^ in the value part of an",
String -> Doc
text String
"# alias to insert a newline as if a physical newline was in the original file.",
String -> Doc
text String
"# When you need a literal { or } or , in the value part of an alias you have to",
String -> Doc
text String
"# escape them by means of a backslash (\\), this can lead to conflicts with the",
String -> Doc
text String
"# commands \\{ and \\} for these it is advised to use the version @{ and @} or use",
String -> Doc
text String
"# a double escape (\\\\{ and \\\\})",
Doc
blank,
String -> Doc
text String
"ALIASES =",
Doc
blank,
String -> Doc
text String
"# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources",
String -> Doc
text String
"# only. Doxygen will then generate output that is more tailored for C. For",
String -> Doc
text String
"# instance, some of the names that are used will be different. The list of all",
String -> Doc
text String
"# members will be omitted, etc.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"OPTIMIZE_OUTPUT_FOR_C = NO",
Doc
blank,
String -> Doc
text String
"# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or",
String -> Doc
text String
"# Python sources only. Doxygen will then generate output that is more tailored",
String -> Doc
text String
"# for that language. For instance, namespaces will be presented as packages,",
String -> Doc
text String
"# qualified scopes will look different, etc.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"OPTIMIZE_OUTPUT_JAVA =" Doc -> Doc -> Doc
<+> Doc
opt,
Doc
blank,
String -> Doc
text String
"# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran",
String -> Doc
text String
"# sources. Doxygen will then generate output that is tailored for Fortran.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"OPTIMIZE_FOR_FORTRAN = NO",
Doc
blank,
String -> Doc
text String
"# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL",
String -> Doc
text String
"# sources. Doxygen will then generate output that is tailored for VHDL.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"OPTIMIZE_OUTPUT_VHDL = NO",
Doc
blank,
String -> Doc
text String
"# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice",
String -> Doc
text String
"# sources only. Doxygen will then generate output that is more tailored for that",
String -> Doc
text String
"# language. For instance, namespaces will be presented as modules, types will be",
String -> Doc
text String
"# separated into more groups, etc.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"OPTIMIZE_OUTPUT_SLICE = NO",
Doc
blank,
String -> Doc
text String
"# Doxygen selects the parser to use depending on the extension of the files it",
String -> Doc
text String
"# parses. With this tag you can assign which parser to use for a given",
String -> Doc
text String
"# extension. Doxygen has a built-in mapping, but you can override or extend it",
String -> Doc
text String
"# using this tag. The format is ext=language, where ext is a file extension, and",
String -> Doc
text String
"# language is one of the parsers supported by doxygen: IDL, Java, Javascript,",
String -> Doc
text String
"# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice,",
String -> Doc
text String
"# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:",
String -> Doc
text String
"# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser",
String -> Doc
text String
"# tries to guess whether the code is fixed or free formatted code, this is the",
String -> Doc
text String
"# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat",
String -> Doc
text String
"# .inc files as Fortran files (default is PHP), and .f files as C (default is",
String -> Doc
text String
"# Fortran), use: inc=Fortran f=C.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note: For files without extension you can use no_extension as a placeholder.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that for custom extensions you also need to set FILE_PATTERNS otherwise",
String -> Doc
text String
"# the files are not read by doxygen.",
Doc
blank,
String -> Doc
text String
"EXTENSION_MAPPING =",
Doc
blank,
String -> Doc
text String
"# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments",
String -> Doc
text String
"# according to the Markdown format, which allows for more readable",
String -> Doc
text String
"# documentation. See https://daringfireball.net/projects/markdown/ for details.",
String -> Doc
text String
"# The output of markdown processing is further processed by doxygen, so you can",
String -> Doc
text String
"# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in",
String -> Doc
text String
"# case of backward compatibilities issues.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"MARKDOWN_SUPPORT = YES",
Doc
blank,
String -> Doc
text String
"# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up",
String -> Doc
text String
"# to that level are automatically included in the table of contents, even if",
String -> Doc
text String
"# they do not have an id attribute.",
String -> Doc
text String
"# Note: This feature currently applies only to Markdown headings.",
String -> Doc
text String
"# Minimum value: 0, maximum value: 99, default value: 0.",
String -> Doc
text String
"# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.",
Doc
blank,
String -> Doc
text String
"TOC_INCLUDE_HEADINGS = 0",
Doc
blank,
String -> Doc
text String
"# When enabled doxygen tries to link words that correspond to documented",
String -> Doc
text String
"# classes, or namespaces to their corresponding documentation. Such a link can",
String -> Doc
text String
"# be prevented in individual cases by putting a % sign in front of the word or",
String -> Doc
text String
"# globally by setting AUTOLINK_SUPPORT to NO.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"AUTOLINK_SUPPORT = YES",
Doc
blank,
String -> Doc
text String
"# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want",
String -> Doc
text String
"# to include (a tag file for) the STL sources as input, then you should set this",
String -> Doc
text String
"# tag to YES in order to let doxygen match functions declarations and",
String -> Doc
text String
"# definitions whose arguments contain STL classes (e.g. func(std::string);",
String -> Doc
text String
"# versus func(std::string) {}). This also make the inheritance and collaboration",
String -> Doc
text String
"# diagrams that involve STL classes more complete and accurate.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"BUILTIN_STL_SUPPORT = NO",
Doc
blank,
String -> Doc
text String
"# If you use Microsoft's C++/CLI language, you should set this option to YES to",
String -> Doc
text String
"# enable parsing support.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"CPP_CLI_SUPPORT = NO",
Doc
blank,
String -> Doc
text String
"# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:",
String -> Doc
text String
"# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen",
String -> Doc
text String
"# will parse them like normal C++ but will assume all classes use public instead",
String -> Doc
text String
"# of private inheritance when no explicit protection keyword is present.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"SIP_SUPPORT = NO",
Doc
blank,
String -> Doc
text String
"# For Microsoft's IDL there are propget and propput attributes to indicate",
String -> Doc
text String
"# getter and setter methods for a property. Setting this option to YES will make",
String -> Doc
text String
"# doxygen to replace the get and set methods by a property in the documentation.",
String -> Doc
text String
"# This will only work if the methods are indeed getting or setting a simple",
String -> Doc
text String
"# type. If this is not the case, or you want to show the methods anyway, you",
String -> Doc
text String
"# should set this option to NO.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"IDL_PROPERTY_SUPPORT = YES",
Doc
blank,
String -> Doc
text String
"# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC",
String -> Doc
text String
"# tag is set to YES then doxygen will reuse the documentation of the first",
String -> Doc
text String
"# member in the group (if any) for the other members of the group. By default",
String -> Doc
text String
"# all members of a group must be documented explicitly.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"DISTRIBUTE_GROUP_DOC = NO",
Doc
blank,
String -> Doc
text String
"# If one adds a struct or class to a group and this option is enabled, then also",
String -> Doc
text String
"# any nested class or struct is added to the same group. By default this option",
String -> Doc
text String
"# is disabled and one has to add nested compounds explicitly via \\ingroup.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"GROUP_NESTED_COMPOUNDS = NO",
Doc
blank,
String -> Doc
text String
"# Set the SUBGROUPING tag to YES to allow class member groups of the same type",
String -> Doc
text String
"# (for instance a group of public functions) to be put as a subgroup of that",
String -> Doc
text String
"# type (e.g. under the Public Functions section). Set it to NO to prevent",
String -> Doc
text String
"# subgrouping. Alternatively, this can be done per class using the",
String -> Doc
text String
"# \\nosubgrouping command.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"SUBGROUPING = YES",
Doc
blank,
String -> Doc
text String
"# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions",
String -> Doc
text String
"# are shown inside the group in which they are included (e.g. using \\ingroup)",
String -> Doc
text String
"# instead of on a separate page (for HTML and Man pages) or section (for LaTeX",
String -> Doc
text String
"# and RTF).",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that this feature does not work in combination with",
String -> Doc
text String
"# SEPARATE_MEMBER_PAGES.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"INLINE_GROUPED_CLASSES = NO",
Doc
blank,
String -> Doc
text String
"# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions",
String -> Doc
text String
"# with only public data fields or simple typedef fields will be shown inline in",
String -> Doc
text String
"# the documentation of the scope in which they are defined (i.e. file,",
String -> Doc
text String
"# namespace, or group documentation), provided this scope is documented. If set",
String -> Doc
text String
"# to NO, structs, classes, and unions are shown on a separate page (for HTML and",
String -> Doc
text String
"# Man pages) or section (for LaTeX and RTF).",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"INLINE_SIMPLE_STRUCTS = NO",
Doc
blank,
String -> Doc
text String
"# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or",
String -> Doc
text String
"# enum is documented as struct, union, or enum with the name of the typedef. So",
String -> Doc
text String
"# typedef struct TypeS {} TypeT, will appear in the documentation as a struct",
String -> Doc
text String
"# with name TypeT. When disabled the typedef will appear as a member of a file,",
String -> Doc
text String
"# namespace, or class. And the struct will be named TypeS. This can typically be",
String -> Doc
text String
"# useful for C code in case the coding convention dictates that all compound",
String -> Doc
text String
"# types are typedef'ed and only the typedef is referenced, never the tag name.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"TYPEDEF_HIDES_STRUCT = NO",
Doc
blank,
String -> Doc
text String
"# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This",
String -> Doc
text String
"# cache is used to resolve symbols given their name and scope. Since this can be",
String -> Doc
text String
"# an expensive process and often the same symbol appears multiple times in the",
String -> Doc
text String
"# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small",
String -> Doc
text String
"# doxygen will become slower. If the cache is too large, memory is wasted. The",
String -> Doc
text String
"# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range",
String -> Doc
text String
"# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536",
String -> Doc
text String
"# symbols. At the end of a run doxygen will report the cache usage and suggest",
String -> Doc
text String
"# the optimal cache size from a speed point of view.",
String -> Doc
text String
"# Minimum value: 0, maximum value: 9, default value: 0.",
Doc
blank,
String -> Doc
text String
"LOOKUP_CACHE_SIZE = 0",
Doc
blank,
String -> Doc
text String
"#---------------------------------------------------------------------------",
String -> Doc
text String
"# Build related configuration options",
String -> Doc
text String
"#---------------------------------------------------------------------------",
Doc
blank,
String -> Doc
text String
"# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in",
String -> Doc
text String
"# documentation are documented, even if no documentation was available. Private",
String -> Doc
text String
"# class members and static file members will be hidden unless the",
String -> Doc
text String
"# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.",
String -> Doc
text String
"# Note: This will also disable the warnings about undocumented members that are",
String -> Doc
text String
"# normally produced when WARNINGS is set to YES.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"EXTRACT_ALL = NO",
Doc
blank,
String -> Doc
text String
"# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will",
String -> Doc
text String
"# be included in the documentation.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"EXTRACT_PRIVATE = NO",
Doc
blank,
String -> Doc
text String
"# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal",
String -> Doc
text String
"# scope will be included in the documentation.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"EXTRACT_PACKAGE = NO",
Doc
blank,
String -> Doc
text String
"# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be",
String -> Doc
text String
"# included in the documentation.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"EXTRACT_STATIC = NO",
Doc
blank,
String -> Doc
text String
"# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined",
String -> Doc
text String
"# locally in source files will be included in the documentation. If set to NO,",
String -> Doc
text String
"# only classes defined in header files are included. Does not have any effect",
String -> Doc
text String
"# for Java sources.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"EXTRACT_LOCAL_CLASSES = YES",
Doc
blank,
String -> Doc
text String
"# This flag is only useful for Objective-C code. If set to YES, local methods,",
String -> Doc
text String
"# which are defined in the implementation section but not in the interface are",
String -> Doc
text String
"# included in the documentation. If set to NO, only methods in the interface are",
String -> Doc
text String
"# included.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"EXTRACT_LOCAL_METHODS = NO",
Doc
blank,
String -> Doc
text String
"# If this flag is set to YES, the members of anonymous namespaces will be",
String -> Doc
text String
"# extracted and appear in the documentation as a namespace called",
String -> Doc
text String
"# 'anonymous_namespace{file}', where file will be replaced with the base name of",
String -> Doc
text String
"# the file that contains the anonymous namespace. By default anonymous namespace",
String -> Doc
text String
"# are hidden.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"EXTRACT_ANON_NSPACES = NO",
Doc
blank,
String -> Doc
text String
"# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all",
String -> Doc
text String
"# undocumented members inside documented classes or files. If set to NO these",
String -> Doc
text String
"# members will be included in the various overviews, but no documentation",
String -> Doc
text String
"# section is generated. This option has no effect if EXTRACT_ALL is enabled.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"HIDE_UNDOC_MEMBERS = NO",
Doc
blank,
String -> Doc
text String
"# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all",
String -> Doc
text String
"# undocumented classes that are normally visible in the class hierarchy. If set",
String -> Doc
text String
"# to NO, these classes will be included in the various overviews. This option",
String -> Doc
text String
"# has no effect if EXTRACT_ALL is enabled.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"HIDE_UNDOC_CLASSES = NO",
Doc
blank,
String -> Doc
text String
"# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend",
String -> Doc
text String
"# (class|struct|union) declarations. If set to NO, these declarations will be",
String -> Doc
text String
"# included in the documentation.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"HIDE_FRIEND_COMPOUNDS = NO",
Doc
blank,
String -> Doc
text String
"# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any",
String -> Doc
text String
"# documentation blocks found inside the body of a function. If set to NO, these",
String -> Doc
text String
"# blocks will be appended to the function's detailed documentation block.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"HIDE_IN_BODY_DOCS = NO",
Doc
blank,
String -> Doc
text String
"# The INTERNAL_DOCS tag determines if documentation that is typed after a",
String -> Doc
text String
"# \\internal command is included. If the tag is set to NO then the documentation",
String -> Doc
text String
"# will be excluded. Set it to YES to include the internal documentation.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"INTERNAL_DOCS = NO",
Doc
blank,
String -> Doc
text String
"# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file",
String -> Doc
text String
"# names in lower-case letters. If set to YES, upper-case letters are also",
String -> Doc
text String
"# allowed. This is useful if you have classes or files whose names only differ",
String -> Doc
text String
"# in case and if your file system supports case sensitive file names. Windows",
String -> Doc
text String
"# and Mac users are advised to set this option to NO.",
String -> Doc
text String
"# The default value is: system dependent.",
Doc
blank,
String -> Doc
text String
"CASE_SENSE_NAMES = NO",
Doc
blank,
String -> Doc
text String
"# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with",
String -> Doc
text String
"# their full class and namespace scopes in the documentation. If set to YES, the",
String -> Doc
text String
"# scope will be hidden.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"HIDE_SCOPE_NAMES = NO",
Doc
blank,
String -> Doc
text String
"# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will",
String -> Doc
text String
"# append additional text to a page's title, such as Class Reference. If set to",
String -> Doc
text String
"# YES the compound reference will be hidden.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"HIDE_COMPOUND_REFERENCE= NO",
Doc
blank,
String -> Doc
text String
"# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of",
String -> Doc
text String
"# the files that are included by a file in the documentation of that file.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"SHOW_INCLUDE_FILES = YES",
Doc
blank,
String -> Doc
text String
"# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each",
String -> Doc
text String
"# grouped member an include statement to the documentation, telling the reader",
String -> Doc
text String
"# which file to include in order to use the member.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"SHOW_GROUPED_MEMB_INC = NO",
Doc
blank,
String -> Doc
text String
"# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include",
String -> Doc
text String
"# files with double quotes in the documentation rather than with sharp brackets.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"FORCE_LOCAL_INCLUDES = NO",
Doc
blank,
String -> Doc
text String
"# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the",
String -> Doc
text String
"# documentation for inline members.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"INLINE_INFO = YES",
Doc
blank,
String -> Doc
text String
"# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the",
String -> Doc
text String
"# (detailed) documentation of file and class members alphabetically by member",
String -> Doc
text String
"# name. If set to NO, the members will appear in declaration order.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"SORT_MEMBER_DOCS = YES",
Doc
blank,
String -> Doc
text String
"# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief",
String -> Doc
text String
"# descriptions of file, namespace and class members alphabetically by member",
String -> Doc
text String
"# name. If set to NO, the members will appear in declaration order. Note that",
String -> Doc
text String
"# this will also influence the order of the classes in the class list.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"SORT_BRIEF_DOCS = NO",
Doc
blank,
String -> Doc
text String
"# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the",
String -> Doc
text String
"# (brief and detailed) documentation of class members so that constructors and",
String -> Doc
text String
"# destructors are listed first. If set to NO the constructors will appear in the",
String -> Doc
text String
"# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.",
String -> Doc
text String
"# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief",
String -> Doc
text String
"# member documentation.",
String -> Doc
text String
"# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting",
String -> Doc
text String
"# detailed member documentation.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"SORT_MEMBERS_CTORS_1ST = NO",
Doc
blank,
String -> Doc
text String
"# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy",
String -> Doc
text String
"# of group names into alphabetical order. If set to NO the group names will",
String -> Doc
text String
"# appear in their defined order.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"SORT_GROUP_NAMES = NO",
Doc
blank,
String -> Doc
text String
"# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by",
String -> Doc
text String
"# fully-qualified names, including namespaces. If set to NO, the class list will",
String -> Doc
text String
"# be sorted only by class name, not including the namespace part.",
String -> Doc
text String
"# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.",
String -> Doc
text String
"# Note: This option applies only to the class list, not to the alphabetical",
String -> Doc
text String
"# list.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"SORT_BY_SCOPE_NAME = NO",
Doc
blank,
String -> Doc
text String
"# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper",
String -> Doc
text String
"# type resolution of all parameters of a function it will reject a match between",
String -> Doc
text String
"# the prototype and the implementation of a member function even if there is",
String -> Doc
text String
"# only one candidate or it is obvious which candidate to choose by doing a",
String -> Doc
text String
"# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still",
String -> Doc
text String
"# accept a match between prototype and implementation in such cases.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"STRICT_PROTO_MATCHING = NO",
Doc
blank,
String -> Doc
text String
"# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo",
String -> Doc
text String
"# list. This list is created by putting \\todo commands in the documentation.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"GENERATE_TODOLIST = YES",
Doc
blank,
String -> Doc
text String
"# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test",
String -> Doc
text String
"# list. This list is created by putting \\test commands in the documentation.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"GENERATE_TESTLIST = YES",
Doc
blank,
String -> Doc
text String
"# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug",
String -> Doc
text String
"# list. This list is created by putting \\bug commands in the documentation.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"GENERATE_BUGLIST = YES",
Doc
blank,
String -> Doc
text String
"# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)",
String -> Doc
text String
"# the deprecated list. This list is created by putting \\deprecated commands in",
String -> Doc
text String
"# the documentation.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"GENERATE_DEPRECATEDLIST= YES",
Doc
blank,
String -> Doc
text String
"# The ENABLED_SECTIONS tag can be used to enable conditional documentation",
String -> Doc
text String
"# sections, marked by \\if <section_label> ... \\endif and \\cond <section_label>",
String -> Doc
text String
"# ... \\endcond blocks.",
Doc
blank,
String -> Doc
text String
"ENABLED_SECTIONS =",
Doc
blank,
String -> Doc
text String
"# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the",
String -> Doc
text String
"# initial value of a variable or macro / define can have for it to appear in the",
String -> Doc
text String
"# documentation. If the initializer consists of more lines than specified here",
String -> Doc
text String
"# it will be hidden. Use a value of 0 to hide initializers completely. The",
String -> Doc
text String
"# appearance of the value of individual variables and macros / defines can be",
String -> Doc
text String
"# controlled using \\showinitializer or \\hideinitializer command in the",
String -> Doc
text String
"# documentation regardless of this setting.",
String -> Doc
text String
"# Minimum value: 0, maximum value: 10000, default value: 30.",
Doc
blank,
String -> Doc
text String
"MAX_INITIALIZER_LINES = 30",
Doc
blank,
String -> Doc
text String
"# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at",
String -> Doc
text String
"# the bottom of the documentation of classes and structs. If set to YES, the",
String -> Doc
text String
"# list will mention the files that were used to generate the documentation.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"SHOW_USED_FILES = YES",
Doc
blank,
String -> Doc
text String
"# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This",
String -> Doc
text String
"# will remove the Files entry from the Quick Index and from the Folder Tree View",
String -> Doc
text String
"# (if specified).",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"SHOW_FILES = YES",
Doc
blank,
String -> Doc
text String
"# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces",
String -> Doc
text String
"# page. This will remove the Namespaces entry from the Quick Index and from the",
String -> Doc
text String
"# Folder Tree View (if specified).",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"SHOW_NAMESPACES = YES",
Doc
blank,
String -> Doc
text String
"# The FILE_VERSION_FILTER tag can be used to specify a program or script that",
String -> Doc
text String
"# doxygen should invoke to get the current version for each file (typically from",
String -> Doc
text String
"# the version control system). Doxygen will invoke the program by executing (via",
String -> Doc
text String
"# popen()) the command command input-file, where command is the value of the",
String -> Doc
text String
"# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided",
String -> Doc
text String
"# by doxygen. Whatever the program writes to standard output is used as the file",
String -> Doc
text String
"# version. For an example see the documentation.",
Doc
blank,
String -> Doc
text String
"FILE_VERSION_FILTER =",
Doc
blank,
String -> Doc
text String
"# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed",
String -> Doc
text String
"# by doxygen. The layout file controls the global structure of the generated",
String -> Doc
text String
"# output files in an output format independent way. To create the layout file",
String -> Doc
text String
"# that represents doxygen's defaults, run doxygen with the -l option. You can",
String -> Doc
text String
"# optionally specify a file name after the option, if omitted DoxygenLayout.xml",
String -> Doc
text String
"# will be used as the name of the layout file.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that if you run doxygen from a directory containing a file called",
String -> Doc
text String
"# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE",
String -> Doc
text String
"# tag is left empty.",
Doc
blank,
String -> Doc
text String
"LAYOUT_FILE =",
Doc
blank,
String -> Doc
text String
"# The CITE_BIB_FILES tag can be used to specify one or more bib files containing",
String -> Doc
text String
"# the reference definitions. This must be a list of .bib files. The .bib",
String -> Doc
text String
"# extension is automatically appended if omitted. This requires the bibtex tool",
String -> Doc
text String
"# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.",
String -> Doc
text String
"# For LaTeX the style of the bibliography can be controlled using",
String -> Doc
text String
"# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the",
String -> Doc
text String
"# search path. See also \\cite for info how to create references.",
Doc
blank,
String -> Doc
text String
"CITE_BIB_FILES =",
Doc
blank,
String -> Doc
text String
"#---------------------------------------------------------------------------",
String -> Doc
text String
"# Configuration options related to warning and progress messages",
String -> Doc
text String
"#---------------------------------------------------------------------------",
Doc
blank,
String -> Doc
text String
"# The QUIET tag can be used to turn on/off the messages that are generated to",
String -> Doc
text String
"# standard output by doxygen. If QUIET is set to YES this implies that the",
String -> Doc
text String
"# messages are off.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"QUIET =" Doc -> Doc -> Doc
<+> Verbosity -> Doc
verbosityToDoc Verbosity
v,
Doc
blank,
String -> Doc
text String
"# The WARNINGS tag can be used to turn on/off the warning messages that are",
String -> Doc
text String
"# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES",
String -> Doc
text String
"# this implies that the warnings are on.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Tip: Turn warnings on while writing the documentation.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"WARNINGS = YES",
Doc
blank,
String -> Doc
text String
"# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate",
String -> Doc
text String
"# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag",
String -> Doc
text String
"# will automatically be disabled.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"WARN_IF_UNDOCUMENTED = YES",
Doc
blank,
String -> Doc
text String
"# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for",
String -> Doc
text String
"# potential errors in the documentation, such as not documenting some parameters",
String -> Doc
text String
"# in a documented function, or documenting parameters that don't exist or using",
String -> Doc
text String
"# markup commands wrongly.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"WARN_IF_DOC_ERROR = YES",
Doc
blank,
String -> Doc
text String
"# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that",
String -> Doc
text String
"# are documented, but have no documentation for their parameters or return",
String -> Doc
text String
"# value. If set to NO, doxygen will only warn about wrong or incomplete",
String -> Doc
text String
"# parameter documentation, but not about the absence of documentation. If",
String -> Doc
text String
"# EXTRACT_ALL is set to YES then this flag will automatically be disabled.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"WARN_NO_PARAMDOC = NO",
Doc
blank,
String -> Doc
text String
"# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when",
String -> Doc
text String
"# a warning is encountered.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"WARN_AS_ERROR = NO",
Doc
blank,
String -> Doc
text String
"# The WARN_FORMAT tag determines the format of the warning messages that doxygen",
String -> Doc
text String
"# can produce. The string should contain the $file, $line, and $text tags, which",
String -> Doc
text String
"# will be replaced by the file and line number from which the warning originated",
String -> Doc
text String
"# and the warning text. Optionally the format may contain $version, which will",
String -> Doc
text String
"# be replaced by the version of the file (if it could be obtained via",
String -> Doc
text String
"# FILE_VERSION_FILTER)",
String -> Doc
text String
"# The default value is: $file:$line: $text.",
Doc
blank,
String -> Doc
text String
"WARN_FORMAT = \"$file:$line: $text\"",
Doc
blank,
String -> Doc
text String
"# The WARN_LOGFILE tag can be used to specify a file to which warning and error",
String -> Doc
text String
"# messages should be written. If left blank the output is written to standard",
String -> Doc
text String
"# error (stderr).",
Doc
blank,
String -> Doc
text String
"WARN_LOGFILE =",
Doc
blank,
String -> Doc
text String
"#---------------------------------------------------------------------------",
String -> Doc
text String
"# Configuration options related to the input files",
String -> Doc
text String
"#---------------------------------------------------------------------------",
Doc
blank,
String -> Doc
text String
"# The INPUT tag is used to specify the files and/or directories that contain",
String -> Doc
text String
"# documented source files. You may enter file names like myfile.cpp or",
String -> Doc
text String
"# directories like /usr/src/myproject. Separate the files or directories with",
String -> Doc
text String
"# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING",
String -> Doc
text String
"# Note: If this tag is empty the current directory is searched.",
Doc
blank,
String -> Doc
text String
"INPUT =" Doc -> Doc -> Doc
<+> [Doc] -> Doc
hcat ((String -> Doc) -> [String] -> [Doc]
forall a b. (a -> b) -> [a] -> [b]
map String -> Doc
text ([String] -> [Doc]) -> [String] -> [Doc]
forall a b. (a -> b) -> a -> b
$ String -> [String] -> [String]
forall a. a -> [a] -> [a]
intersperse String
" " [String]
fs),
Doc
blank,
String -> Doc
text String
"# This tag can be used to specify the character encoding of the source files",
String -> Doc
text String
"# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses",
String -> Doc
text String
"# libiconv (or the iconv built into libc) for the transcoding. See the libiconv",
String -> Doc
text String
"# documentation (see: https://www.gnu.org/software/libiconv/) for the list of",
String -> Doc
text String
"# possible encodings.",
String -> Doc
text String
"# The default value is: UTF-8.",
Doc
blank,
String -> Doc
text String
"INPUT_ENCODING = UTF-8",
Doc
blank,
String -> Doc
text String
"# If the value of the INPUT tag contains directories, you can use the",
String -> Doc
text String
"# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and",
String -> Doc
text String
"# *.h) to filter out the source-files in the directories.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that for custom extensions or not directly supported extensions you also",
String -> Doc
text String
"# need to set EXTENSION_MAPPING for the extension otherwise the files are not",
String -> Doc
text String
"# read by doxygen.",
String -> Doc
text String
"#",
String -> Doc
text String
"# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,",
String -> Doc
text String
"# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,",
String -> Doc
text String
"# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,",
String -> Doc
text String
"# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,",
String -> Doc
text String
"# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.",
Doc
blank,
String -> Doc
text String
"FILE_PATTERNS = *.c \\",
String -> Doc
text String
" *.cc \\",
String -> Doc
text String
" *.cxx \\",
String -> Doc
text String
" *.cpp \\",
String -> Doc
text String
" *.c++ \\",
String -> Doc
text String
" *.java \\",
String -> Doc
text String
" *.ii \\",
String -> Doc
text String
" *.ixx \\",
String -> Doc
text String
" *.ipp \\",
String -> Doc
text String
" *.i++ \\",
String -> Doc
text String
" *.inl \\",
String -> Doc
text String
" *.idl \\",
String -> Doc
text String
" *.ddl \\",
String -> Doc
text String
" *.odl \\",
String -> Doc
text String
" *.h \\",
String -> Doc
text String
" *.hh \\",
String -> Doc
text String
" *.hxx \\",
String -> Doc
text String
" *.hpp \\",
String -> Doc
text String
" *.h++ \\",
String -> Doc
text String
" *.cs \\",
String -> Doc
text String
" *.d \\",
String -> Doc
text String
" *.php \\",
String -> Doc
text String
" *.php4 \\",
String -> Doc
text String
" *.php5 \\",
String -> Doc
text String
" *.phtml \\",
String -> Doc
text String
" *.inc \\",
String -> Doc
text String
" *.m \\",
String -> Doc
text String
" *.markdown \\",
String -> Doc
text String
" *.md \\",
String -> Doc
text String
" *.mm \\",
String -> Doc
text String
" *.dox \\",
String -> Doc
text String
" *.py \\",
String -> Doc
text String
" *.pyw \\",
String -> Doc
text String
" *.f90 \\",
String -> Doc
text String
" *.f95 \\",
String -> Doc
text String
" *.f03 \\",
String -> Doc
text String
" *.f08 \\",
String -> Doc
text String
" *.f \\",
String -> Doc
text String
" *.for \\",
String -> Doc
text String
" *.tcl \\",
String -> Doc
text String
" *.vhd \\",
String -> Doc
text String
" *.vhdl \\",
String -> Doc
text String
" *.ucf \\",
String -> Doc
text String
" *.qsf \\",
String -> Doc
text String
" *.ice",
Doc
blank,
String -> Doc
text String
"# The RECURSIVE tag can be used to specify whether or not subdirectories should",
String -> Doc
text String
"# be searched for input files as well.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"RECURSIVE = NO",
Doc
blank,
String -> Doc
text String
"# The EXCLUDE tag can be used to specify files and/or directories that should be",
String -> Doc
text String
"# excluded from the INPUT source files. This way you can easily exclude a",
String -> Doc
text String
"# subdirectory from a directory tree whose root is specified with the INPUT tag.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that relative paths are relative to the directory from which doxygen is",
String -> Doc
text String
"# run.",
Doc
blank,
String -> Doc
text String
"EXCLUDE =",
Doc
blank,
String -> Doc
text String
"# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or",
String -> Doc
text String
"# directories that are symbolic links (a Unix file system feature) are excluded",
String -> Doc
text String
"# from the input.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"EXCLUDE_SYMLINKS = NO",
Doc
blank,
String -> Doc
text String
"# If the value of the INPUT tag contains directories, you can use the",
String -> Doc
text String
"# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude",
String -> Doc
text String
"# certain files from those directories.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that the wildcards are matched against the file with absolute path, so to",
String -> Doc
text String
"# exclude all test directories for example use the pattern */test/*",
Doc
blank,
String -> Doc
text String
"EXCLUDE_PATTERNS =",
Doc
blank,
String -> Doc
text String
"# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names",
String -> Doc
text String
"# (namespaces, classes, functions, etc.) that should be excluded from the",
String -> Doc
text String
"# output. The symbol name can be a fully qualified name, a word, or if the",
String -> Doc
text String
"# wildcard * is used, a substring. Examples: ANamespace, AClass,",
String -> Doc
text String
"# AClass::ANamespace, ANamespace::*Test",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that the wildcards are matched against the file with absolute path, so to",
String -> Doc
text String
"# exclude all test directories use the pattern */test/*",
Doc
blank,
String -> Doc
text String
"EXCLUDE_SYMBOLS =",
Doc
blank,
String -> Doc
text String
"# The EXAMPLE_PATH tag can be used to specify one or more files or directories",
String -> Doc
text String
"# that contain example code fragments that are included (see the \\include",
String -> Doc
text String
"# command).",
Doc
blank,
String -> Doc
text String
"EXAMPLE_PATH =",
Doc
blank,
String -> Doc
text String
"# If the value of the EXAMPLE_PATH tag contains directories, you can use the",
String -> Doc
text String
"# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and",
String -> Doc
text String
"# *.h) to filter out the source-files in the directories. If left blank all",
String -> Doc
text String
"# files are included.",
Doc
blank,
String -> Doc
text String
"EXAMPLE_PATTERNS = *",
Doc
blank,
String -> Doc
text String
"# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be",
String -> Doc
text String
"# searched for input files to be used with the \\include or \\dontinclude commands",
String -> Doc
text String
"# irrespective of the value of the RECURSIVE tag.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"EXAMPLE_RECURSIVE = NO",
Doc
blank,
String -> Doc
text String
"# The IMAGE_PATH tag can be used to specify one or more files or directories",
String -> Doc
text String
"# that contain images that are to be included in the documentation (see the",
String -> Doc
text String
"# \\image command).",
Doc
blank,
String -> Doc
text String
"IMAGE_PATH =",
Doc
blank,
String -> Doc
text String
"# The INPUT_FILTER tag can be used to specify a program that doxygen should",
String -> Doc
text String
"# invoke to filter for each input file. Doxygen will invoke the filter program",
String -> Doc
text String
"# by executing (via popen()) the command:",
String -> Doc
text String
"#",
String -> Doc
text String
"# <filter> <input-file>",
String -> Doc
text String
"#",
String -> Doc
text String
"# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the",
String -> Doc
text String
"# name of an input file. Doxygen will then use the output that the filter",
String -> Doc
text String
"# program writes to standard output. If FILTER_PATTERNS is specified, this tag",
String -> Doc
text String
"# will be ignored.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that the filter must not add or remove lines; it is applied before the",
String -> Doc
text String
"# code is scanned, but not when the output code is generated. If lines are added",
String -> Doc
text String
"# or removed, the anchors will not be placed correctly.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that for custom extensions or not directly supported extensions you also",
String -> Doc
text String
"# need to set EXTENSION_MAPPING for the extension otherwise the files are not",
String -> Doc
text String
"# properly processed by doxygen.",
Doc
blank,
String -> Doc
text String
"INPUT_FILTER =",
Doc
blank,
String -> Doc
text String
"# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern",
String -> Doc
text String
"# basis. Doxygen will compare the file name with each pattern and apply the",
String -> Doc
text String
"# filter if there is a match. The filters are a list of the form: pattern=filter",
String -> Doc
text String
"# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how",
String -> Doc
text String
"# filters are used. If the FILTER_PATTERNS tag is empty or if none of the",
String -> Doc
text String
"# patterns match the file name, INPUT_FILTER is applied.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that for custom extensions or not directly supported extensions you also",
String -> Doc
text String
"# need to set EXTENSION_MAPPING for the extension otherwise the files are not",
String -> Doc
text String
"# properly processed by doxygen.",
Doc
blank,
String -> Doc
text String
"FILTER_PATTERNS =",
Doc
blank,
String -> Doc
text String
"# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using",
String -> Doc
text String
"# INPUT_FILTER) will also be used to filter the input files that are used for",
String -> Doc
text String
"# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"FILTER_SOURCE_FILES = NO",
Doc
blank,
String -> Doc
text String
"# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file",
String -> Doc
text String
"# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and",
String -> Doc
text String
"# it is also possible to disable source filtering for a specific pattern using",
String -> Doc
text String
"# *.ext= (so without naming a filter).",
String -> Doc
text String
"# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.",
Doc
blank,
String -> Doc
text String
"FILTER_SOURCE_PATTERNS =",
Doc
blank,
String -> Doc
text String
"# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that",
String -> Doc
text String
"# is part of the input, its contents will be placed on the main page",
String -> Doc
text String
"# (index.html). This can be useful if you have a project on for instance GitHub",
String -> Doc
text String
"# and want to reuse the introduction page also for the doxygen output.",
Doc
blank,
String -> Doc
text String
"USE_MDFILE_AS_MAINPAGE =",
Doc
blank,
String -> Doc
text String
"#---------------------------------------------------------------------------",
String -> Doc
text String
"# Configuration options related to source browsing",
String -> Doc
text String
"#---------------------------------------------------------------------------",
Doc
blank,
String -> Doc
text String
"# If the SOURCE_BROWSER tag is set to YES then a list of source files will be",
String -> Doc
text String
"# generated. Documented entities will be cross-referenced with these sources.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note: To get rid of all source code in the generated output, make sure that",
String -> Doc
text String
"# also VERBATIM_HEADERS is set to NO.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"SOURCE_BROWSER = NO",
Doc
blank,
String -> Doc
text String
"# Setting the INLINE_SOURCES tag to YES will include the body of functions,",
String -> Doc
text String
"# classes and enums directly into the documentation.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"INLINE_SOURCES = NO",
Doc
blank,
String -> Doc
text String
"# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any",
String -> Doc
text String
"# special comment blocks from generated source code fragments. Normal C, C++ and",
String -> Doc
text String
"# Fortran comments will always remain visible.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"STRIP_CODE_COMMENTS = YES",
Doc
blank,
String -> Doc
text String
"# If the REFERENCED_BY_RELATION tag is set to YES then for each documented",
String -> Doc
text String
"# entity all documented functions referencing it will be listed.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"REFERENCED_BY_RELATION = NO",
Doc
blank,
String -> Doc
text String
"# If the REFERENCES_RELATION tag is set to YES then for each documented function",
String -> Doc
text String
"# all documented entities called/used by that function will be listed.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"REFERENCES_RELATION = NO",
Doc
blank,
String -> Doc
text String
"# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set",
String -> Doc
text String
"# to YES then the hyperlinks from functions in REFERENCES_RELATION and",
String -> Doc
text String
"# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will",
String -> Doc
text String
"# link to the documentation.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"REFERENCES_LINK_SOURCE = YES",
Doc
blank,
String -> Doc
text String
"# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the",
String -> Doc
text String
"# source code will show a tooltip with additional information such as prototype,",
String -> Doc
text String
"# brief description and links to the definition and documentation. Since this",
String -> Doc
text String
"# will make the HTML file larger and loading of large files a bit slower, you",
String -> Doc
text String
"# can opt to disable this feature.",
Doc
defYes,
String -> Doc
text String
"# This tag requires that the tag SOURCE_BROWSER is set to YES.",
Doc
blank,
String -> Doc
text String
"SOURCE_TOOLTIPS = YES",
Doc
blank,
String -> Doc
text String
"# If the USE_HTAGS tag is set to YES then the references to source code will",
String -> Doc
text String
"# point to the HTML generated by the htags(1) tool instead of doxygen built-in",
String -> Doc
text String
"# source browser. The htags tool is part of GNU's global source tagging system",
String -> Doc
text String
"# (see https://www.gnu.org/software/global/global.html). You will need version",
String -> Doc
text String
"# 4.8.6 or higher.",
String -> Doc
text String
"#",
String -> Doc
text String
"# To use it do the following:",
String -> Doc
text String
"# - Install the latest version of global",
String -> Doc
text String
"# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file",
String -> Doc
text String
"# - Make sure the INPUT points to the root of the source tree",
String -> Doc
text String
"# - Run doxygen as normal",
String -> Doc
text String
"#",
String -> Doc
text String
"# Doxygen will invoke htags (and that will in turn invoke gtags), so these",
String -> Doc
text String
"# tools must be available from the command line (i.e. in the search path).",
String -> Doc
text String
"#",
String -> Doc
text String
"# The result: instead of the source browser generated by doxygen, the links to",
String -> Doc
text String
"# source code will now point to the output of htags.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag SOURCE_BROWSER is set to YES.",
Doc
blank,
String -> Doc
text String
"USE_HTAGS = NO",
Doc
blank,
String -> Doc
text String
"# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a",
String -> Doc
text String
"# verbatim copy of the header file for each class for which an include is",
String -> Doc
text String
"# specified. Set to NO to disable this.",
String -> Doc
text String
"# See also: Section \\class.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"VERBATIM_HEADERS = YES",
Doc
blank,
String -> Doc
text String
"# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the",
String -> Doc
text String
"# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the",
String -> Doc
text String
"# cost of reduced performance. This can be particularly helpful with template",
String -> Doc
text String
"# rich C++ code for which doxygen's built-in parser lacks the necessary type",
String -> Doc
text String
"# information.",
String -> Doc
text String
"# Note: The availability of this option depends on whether or not doxygen was",
String -> Doc
text String
"# generated with the -Duse_libclang=ON option for CMake.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"CLANG_ASSISTED_PARSING = NO",
Doc
blank,
String -> Doc
text String
"# If clang assisted parsing is enabled you can provide the compiler with command",
String -> Doc
text String
"# line options that you would normally use when invoking the compiler. Note that",
String -> Doc
text String
"# the include paths will already be set by doxygen for the files and directories",
String -> Doc
text String
"# specified with INPUT and INCLUDE_PATH.",
String -> Doc
text String
"# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.",
Doc
blank,
String -> Doc
text String
"CLANG_OPTIONS =",
Doc
blank,
String -> Doc
text String
"# If clang assisted parsing is enabled you can provide the clang parser with the",
String -> Doc
text String
"# path to the compilation database (see:",
String -> Doc
text String
"# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files",
String -> Doc
text String
"# were built. This is equivalent to specifying the \"-p\" option to a clang tool,",
String -> Doc
text String
"# such as clang-check. These options will then be passed to the parser.",
String -> Doc
text String
"# Note: The availability of this option depends on whether or not doxygen was",
String -> Doc
text String
"# generated with the -Duse_libclang=ON option for CMake.",
Doc
blank,
String -> Doc
text String
"CLANG_DATABASE_PATH =",
Doc
blank,
String -> Doc
text String
"#---------------------------------------------------------------------------",
String -> Doc
text String
"# Configuration options related to the alphabetical class index",
String -> Doc
text String
"#---------------------------------------------------------------------------",
Doc
blank,
String -> Doc
text String
"# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all",
String -> Doc
text String
"# compounds will be generated. Enable this if the project contains a lot of",
String -> Doc
text String
"# classes, structs, unions or interfaces.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"ALPHABETICAL_INDEX = YES",
Doc
blank,
String -> Doc
text String
"# In case all classes in a project start with a common prefix, all classes will",
String -> Doc
text String
"# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag",
String -> Doc
text String
"# can be used to specify a prefix (or a list of prefixes) that should be ignored",
String -> Doc
text String
"# while generating the index headers.",
String -> Doc
text String
"# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.",
Doc
blank,
String -> Doc
text String
"IGNORE_PREFIX =",
Doc
blank,
String -> Doc
text String
"#---------------------------------------------------------------------------",
String -> Doc
text String
"# Configuration options related to the HTML output",
String -> Doc
text String
"#---------------------------------------------------------------------------",
Doc
blank,
String -> Doc
text String
"# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"GENERATE_HTML = YES",
Doc
blank,
String -> Doc
text String
"# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a",
String -> Doc
text String
"# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of",
String -> Doc
text String
"# it.",
String -> Doc
text String
"# The default directory is: html.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"HTML_OUTPUT = html",
Doc
blank,
String -> Doc
text String
"# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each",
String -> Doc
text String
"# generated HTML page (for example: .htm, .php, .asp).",
String -> Doc
text String
"# The default value is: .html.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"HTML_FILE_EXTENSION = .html",
Doc
blank,
String -> Doc
text String
"# The HTML_HEADER tag can be used to specify a user-defined HTML header file for",
String -> Doc
text String
"# each generated HTML page. If the tag is left blank doxygen will generate a",
String -> Doc
text String
"# standard header.",
String -> Doc
text String
"#",
String -> Doc
text String
"# To get valid HTML the header file that includes any scripts and style sheets",
String -> Doc
text String
"# that doxygen needs, which is dependent on the configuration options used (e.g.",
String -> Doc
text String
"# the setting GENERATE_TREEVIEW). It is highly recommended to start with a",
String -> Doc
text String
"# default header using",
String -> Doc
text String
"# doxygen -w html new_header.html new_footer.html new_stylesheet.css",
String -> Doc
text String
"# YourConfigFile",
String -> Doc
text String
"# and then modify the file new_header.html. See also section \"Doxygen usage\"",
String -> Doc
text String
"# for information on how to generate the default header that doxygen normally",
String -> Doc
text String
"# uses.",
String -> Doc
text String
"# Note: The header is subject to change so you typically have to regenerate the",
String -> Doc
text String
"# default header when upgrading to a newer version of doxygen. For a description",
String -> Doc
text String
"# of the possible markers and block names see the documentation.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"HTML_HEADER =",
Doc
blank,
String -> Doc
text String
"# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each",
String -> Doc
text String
"# generated HTML page. If the tag is left blank doxygen will generate a standard",
String -> Doc
text String
"# footer. See HTML_HEADER for more information on how to generate a default",
String -> Doc
text String
"# footer and what special commands can be used inside the footer. See also",
String -> Doc
text String
"# section \"Doxygen usage\" for information on how to generate the default footer",
String -> Doc
text String
"# that doxygen normally uses.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"HTML_FOOTER =",
Doc
blank,
String -> Doc
text String
"# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style",
String -> Doc
text String
"# sheet that is used by each HTML page. It can be used to fine-tune the look of",
String -> Doc
text String
"# the HTML output. If left blank doxygen will generate a default style sheet.",
String -> Doc
text String
"# See also section \"Doxygen usage\" for information on how to generate the style",
String -> Doc
text String
"# sheet that doxygen normally uses.",
String -> Doc
text String
"# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as",
String -> Doc
text String
"# it is more robust and this tag (HTML_STYLESHEET) will in the future become",
String -> Doc
text String
"# obsolete.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"HTML_STYLESHEET =",
Doc
blank,
String -> Doc
text String
"# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined",
String -> Doc
text String
"# cascading style sheets that are included after the standard style sheets",
String -> Doc
text String
"# created by doxygen. Using this option one can overrule certain style aspects.",
String -> Doc
text String
"# This is preferred over using HTML_STYLESHEET since it does not replace the",
String -> Doc
text String
"# standard style sheet and is therefore more robust against future updates.",
String -> Doc
text String
"# Doxygen will copy the style sheet files to the output directory.",
String -> Doc
text String
"# Note: The order of the extra style sheet files is of importance (e.g. the last",
String -> Doc
text String
"# style sheet in the list overrules the setting of the previous ones in the",
String -> Doc
text String
"# list). For an example see the documentation.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"HTML_EXTRA_STYLESHEET =",
Doc
blank,
String -> Doc
text String
"# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or",
String -> Doc
text String
"# other source files which should be copied to the HTML output directory. Note",
String -> Doc
text String
"# that these files will be copied to the base HTML output directory. Use the",
String -> Doc
text String
"# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these",
String -> Doc
text String
"# files. In the HTML_STYLESHEET file, use the file name only. Also note that the",
String -> Doc
text String
"# files will be copied as-is; there are no commands or markers available.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"HTML_EXTRA_FILES =",
Doc
blank,
String -> Doc
text String
"# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen",
String -> Doc
text String
"# will adjust the colors in the style sheet and background images according to",
String -> Doc
text String
"# this color. Hue is specified as an angle on a colorwheel, see",
String -> Doc
text String
"# https://en.wikipedia.org/wiki/Hue for more information. For instance the value",
String -> Doc
text String
"# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300",
String -> Doc
text String
"# purple, and 360 is red again.",
String -> Doc
text String
"# Minimum value: 0, maximum value: 359, default value: 220.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"HTML_COLORSTYLE_HUE = 220",
Doc
blank,
String -> Doc
text String
"# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors",
String -> Doc
text String
"# in the HTML output. For a value of 0 the output will use grayscales only. A",
String -> Doc
text String
"# value of 255 will produce the most vivid colors.",
String -> Doc
text String
"# Minimum value: 0, maximum value: 255, default value: 100.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"HTML_COLORSTYLE_SAT = 100",
Doc
blank,
String -> Doc
text String
"# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the",
String -> Doc
text String
"# luminance component of the colors in the HTML output. Values below 100",
String -> Doc
text String
"# gradually make the output lighter, whereas values above 100 make the output",
String -> Doc
text String
"# darker. The value divided by 100 is the actual gamma applied, so 80 represents",
String -> Doc
text String
"# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not",
String -> Doc
text String
"# change the gamma.",
String -> Doc
text String
"# Minimum value: 40, maximum value: 240, default value: 80.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"HTML_COLORSTYLE_GAMMA = 80",
Doc
blank,
String -> Doc
text String
"# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML",
String -> Doc
text String
"# documentation will contain a main index with vertical navigation menus that",
String -> Doc
text String
"# are dynamically created via Javascript. If disabled, the navigation index will",
String -> Doc
text String
"# consists of multiple levels of tabs that are statically embedded in every HTML",
String -> Doc
text String
"# page. Disable this option to support browsers that do not have Javascript,",
String -> Doc
text String
"# like the Qt help browser.",
Doc
defYes,
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"HTML_DYNAMIC_MENUS = YES",
Doc
blank,
String -> Doc
text String
"# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML",
String -> Doc
text String
"# documentation will contain sections that can be hidden and shown after the",
String -> Doc
text String
"# page has loaded.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"HTML_DYNAMIC_SECTIONS = NO",
Doc
blank,
String -> Doc
text String
"# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries",
String -> Doc
text String
"# shown in the various tree structured indices initially; the user can expand",
String -> Doc
text String
"# and collapse entries dynamically later on. Doxygen will expand the tree to",
String -> Doc
text String
"# such a level that at most the specified number of entries are visible (unless",
String -> Doc
text String
"# a fully collapsed tree already exceeds this amount). So setting the number of",
String -> Doc
text String
"# entries 1 will produce a full collapsed tree by default. 0 is a special value",
String -> Doc
text String
"# representing an infinite number of entries and will result in a full expanded",
String -> Doc
text String
"# tree by default.",
String -> Doc
text String
"# Minimum value: 0, maximum value: 9999, default value: 100.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"HTML_INDEX_NUM_ENTRIES = 100",
Doc
blank,
String -> Doc
text String
"# If the GENERATE_DOCSET tag is set to YES, additional index files will be",
String -> Doc
text String
"# generated that can be used as input for Apple's Xcode 3 integrated development",
String -> Doc
text String
"# environment (see: https://developer.apple.com/xcode/), introduced with OSX",
String -> Doc
text String
"# 10.5 (Leopard). To create a documentation set, doxygen will generate a",
String -> Doc
text String
"# Makefile in the HTML output directory. Running make will produce the docset in",
String -> Doc
text String
"# that directory and running make install will install the docset in",
String -> Doc
text String
"# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at",
String -> Doc
text String
"# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy",
String -> Doc
text String
"# genXcode/_index.html for more information.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"GENERATE_DOCSET = NO",
Doc
blank,
String -> Doc
text String
"# This tag determines the name of the docset feed. A documentation feed provides",
String -> Doc
text String
"# an umbrella under which multiple documentation sets from a single provider",
String -> Doc
text String
"# (such as a company or product suite) can be grouped.",
String -> Doc
text String
"# The default value is: Doxygen generated docs.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_DOCSET is set to YES.",
Doc
blank,
String -> Doc
text String
"DOCSET_FEEDNAME = \"Doxygen generated docs\"",
Doc
blank,
String -> Doc
text String
"# This tag specifies a string that should uniquely identify the documentation",
String -> Doc
text String
"# set bundle. This should be a reverse domain-name style string, e.g.",
String -> Doc
text String
"# com.mycompany.MyDocSet. Doxygen will append .docset to the name.",
String -> Doc
text String
"# The default value is: org.doxygen.Project.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_DOCSET is set to YES.",
Doc
blank,
String -> Doc
text String
"DOCSET_BUNDLE_ID = org.doxygen.Project",
Doc
blank,
String -> Doc
text String
"# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify",
String -> Doc
text String
"# the documentation publisher. This should be a reverse domain-name style",
String -> Doc
text String
"# string, e.g. com.mycompany.MyDocSet.documentation.",
String -> Doc
text String
"# The default value is: org.doxygen.Publisher.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_DOCSET is set to YES.",
Doc
blank,
String -> Doc
text String
"DOCSET_PUBLISHER_ID = org.doxygen.Publisher",
Doc
blank,
String -> Doc
text String
"# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.",
String -> Doc
text String
"# The default value is: Publisher.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_DOCSET is set to YES.",
Doc
blank,
String -> Doc
text String
"DOCSET_PUBLISHER_NAME = Publisher",
Doc
blank,
String -> Doc
text String
"# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three",
String -> Doc
text String
"# additional HTML index files: index.hhp, index.hhc, and index.hhk. The",
String -> Doc
text String
"# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop",
String -> Doc
text String
"# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on",
String -> Doc
text String
"# Windows.",
String -> Doc
text String
"#",
String -> Doc
text String
"# The HTML Help Workshop contains a compiler that can convert all HTML output",
String -> Doc
text String
"# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML",
String -> Doc
text String
"# files are now used as the Windows 98 help format, and will replace the old",
String -> Doc
text String
"# Windows help format (.hlp) on all Windows platforms in the future. Compressed",
String -> Doc
text String
"# HTML files also contain an index, a table of contents, and you can search for",
String -> Doc
text String
"# words in the documentation. The HTML workshop also contains a viewer for",
String -> Doc
text String
"# compressed HTML files.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"GENERATE_HTMLHELP = NO",
Doc
blank,
String -> Doc
text String
"# The CHM_FILE tag can be used to specify the file name of the resulting .chm",
String -> Doc
text String
"# file. You can add a path in front of the file if the result should not be",
String -> Doc
text String
"# written to the html output directory.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTMLHELP is set to YES.",
Doc
blank,
String -> Doc
text String
"CHM_FILE =",
Doc
blank,
String -> Doc
text String
"# The HHC_LOCATION tag can be used to specify the location (absolute path",
String -> Doc
text String
"# including file name) of the HTML help compiler (hhc.exe). If non-empty,",
String -> Doc
text String
"# doxygen will try to run the HTML help compiler on the generated index.hhp.",
String -> Doc
text String
"# The file has to be specified with full path.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTMLHELP is set to YES.",
Doc
blank,
String -> Doc
text String
"HHC_LOCATION =",
Doc
blank,
String -> Doc
text String
"# The GENERATE_CHI flag controls if a separate .chi index file is generated",
String -> Doc
text String
"# (YES) or that it should be included in the master .chm file (NO).",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTMLHELP is set to YES.",
Doc
blank,
String -> Doc
text String
"GENERATE_CHI = NO",
Doc
blank,
String -> Doc
text String
"# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)",
String -> Doc
text String
"# and project file content.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTMLHELP is set to YES.",
Doc
blank,
String -> Doc
text String
"CHM_INDEX_ENCODING =",
Doc
blank,
String -> Doc
text String
"# The BINARY_TOC flag controls whether a binary table of contents is generated",
String -> Doc
text String
"# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it",
String -> Doc
text String
"# enables the Previous and Next buttons.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTMLHELP is set to YES.",
Doc
blank,
String -> Doc
text String
"BINARY_TOC = NO",
Doc
blank,
String -> Doc
text String
"# The TOC_EXPAND flag can be set to YES to add extra items for group members to",
String -> Doc
text String
"# the table of contents of the HTML help documentation and to the tree view.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTMLHELP is set to YES.",
Doc
blank,
String -> Doc
text String
"TOC_EXPAND = NO",
Doc
blank,
String -> Doc
text String
"# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and",
String -> Doc
text String
"# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that",
String -> Doc
text String
"# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help",
String -> Doc
text String
"# (.qch) of the generated HTML documentation.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"GENERATE_QHP = NO",
Doc
blank,
String -> Doc
text String
"# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify",
String -> Doc
text String
"# the file name of the resulting .qch file. The path specified is relative to",
String -> Doc
text String
"# the HTML output folder.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_QHP is set to YES.",
Doc
blank,
String -> Doc
text String
"QCH_FILE =",
Doc
blank,
String -> Doc
text String
"# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help",
String -> Doc
text String
"# Project output. For more information please see Qt Help Project / Namespace",
String -> Doc
text String
"# (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).",
String -> Doc
text String
"# The default value is: org.doxygen.Project.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_QHP is set to YES.",
Doc
blank,
String -> Doc
text String
"QHP_NAMESPACE = org.doxygen.Project",
Doc
blank,
String -> Doc
text String
"# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt",
String -> Doc
text String
"# Help Project output. For more information please see Qt Help Project / Virtual",
String -> Doc
text String
"# Folders (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-",
String -> Doc
text String
"# folders).",
String -> Doc
text String
"# The default value is: doc.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_QHP is set to YES.",
Doc
blank,
String -> Doc
text String
"QHP_VIRTUAL_FOLDER = doc",
Doc
blank,
String -> Doc
text String
"# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom",
String -> Doc
text String
"# filter to add. For more information please see Qt Help Project / Custom",
String -> Doc
text String
"# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-",
String -> Doc
text String
"# filters).",
String -> Doc
text String
"# This tag requires that the tag GENERATE_QHP is set to YES.",
Doc
blank,
String -> Doc
text String
"QHP_CUST_FILTER_NAME =",
Doc
blank,
String -> Doc
text String
"# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the",
String -> Doc
text String
"# custom filter to add. For more information please see Qt Help Project / Custom",
String -> Doc
text String
"# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-",
String -> Doc
text String
"# filters).",
String -> Doc
text String
"# This tag requires that the tag GENERATE_QHP is set to YES.",
Doc
blank,
String -> Doc
text String
"QHP_CUST_FILTER_ATTRS =",
Doc
blank,
String -> Doc
text String
"# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this",
String -> Doc
text String
"# project's filter section matches. Qt Help Project / Filter Attributes (see:",
String -> Doc
text String
"# http://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).",
String -> Doc
text String
"# This tag requires that the tag GENERATE_QHP is set to YES.",
Doc
blank,
String -> Doc
text String
"QHP_SECT_FILTER_ATTRS =",
Doc
blank,
String -> Doc
text String
"# The QHG_LOCATION tag can be used to specify the location of Qt's",
String -> Doc
text String
"# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the",
String -> Doc
text String
"# generated .qhp file.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_QHP is set to YES.",
Doc
blank,
String -> Doc
text String
"QHG_LOCATION =",
Doc
blank,
String -> Doc
text String
"# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be",
String -> Doc
text String
"# generated, together with the HTML files, they form an Eclipse help plugin. To",
String -> Doc
text String
"# install this plugin and make it available under the help contents menu in",
String -> Doc
text String
"# Eclipse, the contents of the directory containing the HTML and XML files needs",
String -> Doc
text String
"# to be copied into the plugins directory of eclipse. The name of the directory",
String -> Doc
text String
"# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.",
String -> Doc
text String
"# After copying Eclipse needs to be restarted before the help appears.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"GENERATE_ECLIPSEHELP = NO",
Doc
blank,
String -> Doc
text String
"# A unique identifier for the Eclipse help plugin. When installing the plugin",
String -> Doc
text String
"# the directory name containing the HTML and XML files should also have this",
String -> Doc
text String
"# name. Each documentation set should have its own identifier.",
String -> Doc
text String
"# The default value is: org.doxygen.Project.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.",
Doc
blank,
String -> Doc
text String
"ECLIPSE_DOC_ID = org.doxygen.Project",
Doc
blank,
String -> Doc
text String
"# If you want full control over the layout of the generated HTML pages it might",
String -> Doc
text String
"# be necessary to disable the index and replace it with your own. The",
String -> Doc
text String
"# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top",
String -> Doc
text String
"# of each HTML page. A value of NO enables the index and the value YES disables",
String -> Doc
text String
"# it. Since the tabs in the index contain the same information as the navigation",
String -> Doc
text String
"# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"DISABLE_INDEX = NO",
Doc
blank,
String -> Doc
text String
"# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index",
String -> Doc
text String
"# structure should be generated to display hierarchical information. If the tag",
String -> Doc
text String
"# value is set to YES, a side panel will be generated containing a tree-like",
String -> Doc
text String
"# index structure (just like the one that is generated for HTML Help). For this",
String -> Doc
text String
"# to work a browser that supports JavaScript, DHTML, CSS and frames is required",
String -> Doc
text String
"# (i.e. any modern browser). Windows users are probably better off using the",
String -> Doc
text String
"# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can",
String -> Doc
text String
"# further fine-tune the look of the index. As an example, the default style",
String -> Doc
text String
"# sheet generated by doxygen has an example that shows how to put an image at",
String -> Doc
text String
"# the root of the tree instead of the PROJECT_NAME. Since the tree basically has",
String -> Doc
text String
"# the same information as the tab index, you could consider setting",
String -> Doc
text String
"# DISABLE_INDEX to YES when enabling this option.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"GENERATE_TREEVIEW = NO",
Doc
blank,
String -> Doc
text String
"# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that",
String -> Doc
text String
"# doxygen will group on one line in the generated HTML documentation.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that a value of 0 will completely suppress the enum values from appearing",
String -> Doc
text String
"# in the overview section.",
String -> Doc
text String
"# Minimum value: 0, maximum value: 20, default value: 4.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"ENUM_VALUES_PER_LINE = 4",
Doc
blank,
String -> Doc
text String
"# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used",
String -> Doc
text String
"# to set the initial width (in pixels) of the frame in which the tree is shown.",
String -> Doc
text String
"# Minimum value: 0, maximum value: 1500, default value: 250.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"TREEVIEW_WIDTH = 250",
Doc
blank,
String -> Doc
text String
"# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to",
String -> Doc
text String
"# external symbols imported via tag files in a separate window.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"EXT_LINKS_IN_WINDOW = NO",
Doc
blank,
String -> Doc
text String
"# Use this tag to change the font size of LaTeX formulas included as images in",
String -> Doc
text String
"# the HTML documentation. When you change the font size after a successful",
String -> Doc
text String
"# doxygen run you need to manually remove any form_*.png images from the HTML",
String -> Doc
text String
"# output directory to force them to be regenerated.",
String -> Doc
text String
"# Minimum value: 8, maximum value: 50, default value: 10.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"FORMULA_FONTSIZE = 10",
Doc
blank,
String -> Doc
text String
"# Use the FORMULA_TRANSPARENT tag to determine whether or not the images",
String -> Doc
text String
"# generated for formulas are transparent PNGs. Transparent PNGs are not",
String -> Doc
text String
"# supported properly for IE 6.0, but are supported on all modern browsers.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that when changing this option you need to delete any form_*.png files in",
String -> Doc
text String
"# the HTML output directory before the changes have effect.",
Doc
defYes,
String -> Doc
text String
"# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see",
String -> Doc
text String
"# https://www.mathjax.org) which uses client side Javascript for the rendering",
String -> Doc
text String
"# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX",
String -> Doc
text String
"# installed or if you want to formulas look prettier in the HTML output. When",
String -> Doc
text String
"# enabled you may also need to install MathJax separately and configure the path",
String -> Doc
text String
"# to it using the MATHJAX_RELPATH option.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"USE_MATHJAX = NO",
Doc
blank,
String -> Doc
text String
"# When MathJax is enabled you can set the default output format to be used for",
String -> Doc
text String
"# the MathJax output. See the MathJax site (see:",
String -> Doc
text String
"# http://docs.mathjax.org/en/latest/output.html) for more details.",
String -> Doc
text String
"# Possible values are: HTML-CSS (which is slower, but has the best",
String -> Doc
text String
"# compatibility), NativeMML (i.e. MathML) and SVG.",
String -> Doc
text String
"# The default value is: HTML-CSS.",
String -> Doc
text String
"# This tag requires that the tag USE_MATHJAX is set to YES.",
Doc
blank,
String -> Doc
text String
"MATHJAX_FORMAT = HTML-CSS",
Doc
blank,
String -> Doc
text String
"# When MathJax is enabled you need to specify the location relative to the HTML",
String -> Doc
text String
"# output directory using the MATHJAX_RELPATH option. The destination directory",
String -> Doc
text String
"# should contain the MathJax.js script. For instance, if the mathjax directory",
String -> Doc
text String
"# is located at the same level as the HTML output directory, then",
String -> Doc
text String
"# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax",
String -> Doc
text String
"# Content Delivery Network so you can quickly see the result without installing",
String -> Doc
text String
"# MathJax. However, it is strongly recommended to install a local copy of",
String -> Doc
text String
"# MathJax from https://www.mathjax.org before deployment.",
String -> Doc
text String
"# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.",
String -> Doc
text String
"# This tag requires that the tag USE_MATHJAX is set to YES.",
Doc
blank,
String -> Doc
text String
"MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/",
Doc
blank,
String -> Doc
text String
"# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax",
String -> Doc
text String
"# extension names that should be enabled during MathJax rendering. For example",
String -> Doc
text String
"# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols",
String -> Doc
text String
"# This tag requires that the tag USE_MATHJAX is set to YES.",
Doc
blank,
String -> Doc
text String
"MATHJAX_EXTENSIONS =",
Doc
blank,
String -> Doc
text String
"# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces",
String -> Doc
text String
"# of code that will be used on startup of the MathJax code. See the MathJax site",
String -> Doc
text String
"# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an",
String -> Doc
text String
"# example see the documentation.",
String -> Doc
text String
"# This tag requires that the tag USE_MATHJAX is set to YES.",
Doc
blank,
String -> Doc
text String
"MATHJAX_CODEFILE =",
Doc
blank,
String -> Doc
text String
"# When the SEARCHENGINE tag is enabled doxygen will generate a search box for",
String -> Doc
text String
"# the HTML output. The underlying search engine uses javascript and DHTML and",
String -> Doc
text String
"# should work on any modern browser. Note that when using HTML help",
String -> Doc
text String
"# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)",
String -> Doc
text String
"# there is already a search function so this one should typically be disabled.",
String -> Doc
text String
"# For large projects the javascript based search engine can be slow, then",
String -> Doc
text String
"# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to",
String -> Doc
text String
"# search using the keyboard; to jump to the search box use <access key> + S",
String -> Doc
text String
"# (what the <access key> is depends on the OS and browser, but it is typically",
String -> Doc
text String
"# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down",
String -> Doc
text String
"# key> to jump into the search results window, the results can be navigated",
String -> Doc
text String
"# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel",
String -> Doc
text String
"# the search. The filter options can be selected when the cursor is inside the",
String -> Doc
text String
"# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>",
String -> Doc
text String
"# to select a filter and <Enter> or <escape> to activate or cancel the filter",
String -> Doc
text String
"# option.",
Doc
defYes,
String -> Doc
text String
"# This tag requires that the tag GENERATE_HTML is set to YES.",
Doc
blank,
String -> Doc
text String
"SEARCHENGINE = YES",
Doc
blank,
String -> Doc
text String
"# When the SERVER_BASED_SEARCH tag is enabled the search engine will be",
String -> Doc
text String
"# implemented using a web server instead of a web client using Javascript. There",
String -> Doc
text String
"# are two flavors of web server based searching depending on the EXTERNAL_SEARCH",
String -> Doc
text String
"# setting. When disabled, doxygen will generate a PHP script for searching and",
String -> Doc
text String
"# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing",
String -> Doc
text String
"# and searching needs to be provided by external tools. See the section",
String -> Doc
text String
"# \"External Indexing and Searching\" for details.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag SEARCHENGINE is set to YES.",
Doc
blank,
String -> Doc
text String
"SERVER_BASED_SEARCH = NO",
Doc
blank,
String -> Doc
text String
"# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP",
String -> Doc
text String
"# script for searching. Instead the search results are written to an XML file",
String -> Doc
text String
"# which needs to be processed by an external indexer. Doxygen will invoke an",
String -> Doc
text String
"# external search engine pointed to by the SEARCHENGINE_URL option to obtain the",
String -> Doc
text String
"# search results.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Doxygen ships with an example indexer (doxyindexer) and search engine",
String -> Doc
text String
"# (doxysearch.cgi) which are based on the open source search engine library",
String -> Doc
text String
"# Xapian (see: https://xapian.org/).",
String -> Doc
text String
"#",
String -> Doc
text String
"# See the section \"External Indexing and Searching\" for details.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag SEARCHENGINE is set to YES.",
Doc
blank,
String -> Doc
text String
"EXTERNAL_SEARCH = NO",
Doc
blank,
String -> Doc
text String
"# The SEARCHENGINE_URL should point to a search engine hosted by a web server",
String -> Doc
text String
"# which will return the search results when EXTERNAL_SEARCH is enabled.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Doxygen ships with an example indexer (doxyindexer) and search engine",
String -> Doc
text String
"# (doxysearch.cgi) which are based on the open source search engine library",
String -> Doc
text String
"# Xapian (see: https://xapian.org/). See the section \"External Indexing and",
String -> Doc
text String
"# Searching\" for details.",
String -> Doc
text String
"# This tag requires that the tag SEARCHENGINE is set to YES.",
Doc
blank,
String -> Doc
text String
"SEARCHENGINE_URL =",
Doc
blank,
String -> Doc
text String
"# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed",
String -> Doc
text String
"# search data is written to a file for indexing by an external tool. With the",
String -> Doc
text String
"# SEARCHDATA_FILE tag the name of this file can be specified.",
String -> Doc
text String
"# The default file is: searchdata.xml.",
String -> Doc
text String
"# This tag requires that the tag SEARCHENGINE is set to YES.",
Doc
blank,
String -> Doc
text String
"SEARCHDATA_FILE = searchdata.xml",
Doc
blank,
String -> Doc
text String
"# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the",
String -> Doc
text String
"# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is",
String -> Doc
text String
"# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple",
String -> Doc
text String
"# projects and redirect the results back to the right project.",
String -> Doc
text String
"# This tag requires that the tag SEARCHENGINE is set to YES.",
Doc
blank,
String -> Doc
text String
"EXTERNAL_SEARCH_ID =",
Doc
blank,
String -> Doc
text String
"# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen",
String -> Doc
text String
"# projects other than the one defined by this configuration file, but that are",
String -> Doc
text String
"# all added to the same external search index. Each project needs to have a",
String -> Doc
text String
"# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of",
String -> Doc
text String
"# to a relative location where the documentation can be found. The format is:",
String -> Doc
text String
"# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...",
String -> Doc
text String
"# This tag requires that the tag SEARCHENGINE is set to YES.",
Doc
blank,
String -> Doc
text String
"EXTRA_SEARCH_MAPPINGS =",
Doc
blank,
String -> Doc
text String
"#---------------------------------------------------------------------------",
String -> Doc
text String
"# Configuration options related to the LaTeX output",
String -> Doc
text String
"#---------------------------------------------------------------------------",
Doc
blank,
String -> Doc
text String
"# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"GENERATE_LATEX = YES",
Doc
blank,
String -> Doc
text String
"# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a",
String -> Doc
text String
"# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of",
String -> Doc
text String
"# it.",
String -> Doc
text String
"# The default directory is: latex.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_LATEX is set to YES.",
Doc
blank,
String -> Doc
text String
"LATEX_OUTPUT = latex",
Doc
blank,
String -> Doc
text String
"# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be",
String -> Doc
text String
"# invoked.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that when not enabling USE_PDFLATEX the default is latex when enabling",
String -> Doc
text String
"# USE_PDFLATEX the default is pdflatex and when in the later case latex is",
String -> Doc
text String
"# chosen this is overwritten by pdflatex. For specific output languages the",
String -> Doc
text String
"# default can have been set differently, this depends on the implementation of",
String -> Doc
text String
"# the output language.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_LATEX is set to YES.",
Doc
blank,
String -> Doc
text String
"LATEX_CMD_NAME =",
Doc
blank,
String -> Doc
text String
"# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate",
String -> Doc
text String
"# index for LaTeX.",
String -> Doc
text String
"# Note: This tag is used in the Makefile / make.bat.",
String -> Doc
text String
"# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file",
String -> Doc
text String
"# (.tex).",
String -> Doc
text String
"# The default file is: makeindex.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_LATEX is set to YES.",
Doc
blank,
String -> Doc
text String
"MAKEINDEX_CMD_NAME = makeindex",
Doc
blank,
String -> Doc
text String
"# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to",
String -> Doc
text String
"# generate index for LaTeX.",
String -> Doc
text String
"# Note: This tag is used in the generated output file (.tex).",
String -> Doc
text String
"# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.",
String -> Doc
text String
"# The default value is: \\makeindex.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_LATEX is set to YES.",
Doc
blank,
String -> Doc
text String
"LATEX_MAKEINDEX_CMD = \\makeindex",
Doc
blank,
String -> Doc
text String
"# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX",
String -> Doc
text String
"# documents. This may be useful for small projects and may help to save some",
String -> Doc
text String
"# trees in general.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag GENERATE_LATEX is set to YES.",
Doc
blank,
String -> Doc
text String
"COMPACT_LATEX = NO",
Doc
blank,
String -> Doc
text String
"# The PAPER_TYPE tag can be used to set the paper type that is used by the",
String -> Doc
text String
"# printer.",
String -> Doc
text String
"# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x",
String -> Doc
text String
"# 14 inches) and executive (7.25 x 10.5 inches).",
String -> Doc
text String
"# The default value is: a4.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_LATEX is set to YES.",
Doc
blank,
String -> Doc
text String
"PAPER_TYPE = a4",
Doc
blank,
String -> Doc
text String
"# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names",
String -> Doc
text String
"# that should be included in the LaTeX output. The package can be specified just",
String -> Doc
text String
"# by its name or with the correct syntax as to be used with the LaTeX",
String -> Doc
text String
"# \\usepackage command. To get the times font for instance you can specify :",
String -> Doc
text String
"# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}",
String -> Doc
text String
"# To use the option intlimits with the amsmath package you can specify:",
String -> Doc
text String
"# EXTRA_PACKAGES=[intlimits]{amsmath}",
String -> Doc
text String
"# If left blank no extra packages will be included.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_LATEX is set to YES.",
Doc
blank,
String -> Doc
text String
"EXTRA_PACKAGES =",
Doc
blank,
String -> Doc
text String
"# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the",
String -> Doc
text String
"# generated LaTeX document. The header should contain everything until the first",
String -> Doc
text String
"# chapter. If it is left blank doxygen will generate a standard header. See",
String -> Doc
text String
"# section \"Doxygen usage\" for information on how to let doxygen write the",
String -> Doc
text String
"# default header to a separate file.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note: Only use a user-defined header if you know what you are doing! The",
String -> Doc
text String
"# following commands have a special meaning inside the header: $title,",
String -> Doc
text String
"# $datetime, $date, $doxygenversion, $projectname, $projectnumber,",
String -> Doc
text String
"# $projectbrief, $projectlogo. Doxygen will replace $title with the empty",
String -> Doc
text String
"# string, for the replacement values of the other commands the user is referred",
String -> Doc
text String
"# to HTML_HEADER.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_LATEX is set to YES.",
Doc
blank,
String -> Doc
text String
"LATEX_HEADER =",
Doc
blank,
String -> Doc
text String
"# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the",
String -> Doc
text String
"# generated LaTeX document. The footer should contain everything after the last",
String -> Doc
text String
"# chapter. If it is left blank doxygen will generate a standard footer. See",
String -> Doc
text String
"# LATEX_HEADER for more information on how to generate a default footer and what",
String -> Doc
text String
"# special commands can be used inside the footer.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note: Only use a user-defined footer if you know what you are doing!",
String -> Doc
text String
"# This tag requires that the tag GENERATE_LATEX is set to YES.",
Doc
blank,
String -> Doc
text String
"LATEX_FOOTER =",
Doc
blank,
String -> Doc
text String
"# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined",
String -> Doc
text String
"# LaTeX style sheets that are included after the standard style sheets created",
String -> Doc
text String
"# by doxygen. Using this option one can overrule certain style aspects. Doxygen",
String -> Doc
text String
"# will copy the style sheet files to the output directory.",
String -> Doc
text String
"# Note: The order of the extra style sheet files is of importance (e.g. the last",
String -> Doc
text String
"# style sheet in the list overrules the setting of the previous ones in the",
String -> Doc
text String
"# list).",
String -> Doc
text String
"# This tag requires that the tag GENERATE_LATEX is set to YES.",
Doc
blank,
String -> Doc
text String
"LATEX_EXTRA_STYLESHEET =",
Doc
blank,
String -> Doc
text String
"# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or",
String -> Doc
text String
"# other source files which should be copied to the LATEX_OUTPUT output",
String -> Doc
text String
"# directory. Note that the files will be copied as-is; there are no commands or",
String -> Doc
text String
"# markers available.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_LATEX is set to YES.",
Doc
blank,
String -> Doc
text String
"LATEX_EXTRA_FILES =",
Doc
blank,
String -> Doc
text String
"# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is",
String -> Doc
text String
"# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will",
String -> Doc
text String
"# contain links (just like the HTML output) instead of page references. This",
String -> Doc
text String
"# makes the output suitable for online browsing using a PDF viewer.",
Doc
defYes,
String -> Doc
text String
"# This tag requires that the tag GENERATE_LATEX is set to YES.",
Doc
blank,
String -> Doc
text String
"PDF_HYPERLINKS = YES",
Doc
blank,
String -> Doc
text String
"# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate",
String -> Doc
text String
"# the PDF file directly from the LaTeX files. Set this option to YES, to get a",
String -> Doc
text String
"# higher quality PDF documentation.",
Doc
defYes,
String -> Doc
text String
"# This tag requires that the tag GENERATE_LATEX is set to YES.",
Doc
blank,
String -> Doc
text String
"USE_PDFLATEX = YES",
Doc
blank,
String -> Doc
text String
"# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode",
String -> Doc
text String
"# command to the generated LaTeX files. This will instruct LaTeX to keep running",
String -> Doc
text String
"# if errors occur, instead of asking the user for help. This option is also used",
String -> Doc
text String
"# when generating formulas in HTML.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag GENERATE_LATEX is set to YES.",
Doc
blank,
String -> Doc
text String
"LATEX_BATCHMODE = NO",
Doc
blank,
String -> Doc
text String
"# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the",
String -> Doc
text String
"# index chapters (such as File Index, Compound Index, etc.) in the output.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag GENERATE_LATEX is set to YES.",
Doc
blank,
String -> Doc
text String
"LATEX_HIDE_INDICES = NO",
Doc
blank,
String -> Doc
text String
"# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source",
String -> Doc
text String
"# code with syntax highlighting in the LaTeX output.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that which sources are shown also depends on other settings such as",
String -> Doc
text String
"# SOURCE_BROWSER.",
Doc
defNo,
String -> Doc
text String
"# The LATEX_BIB_STYLE tag can be used to specify the style to use for the",
String -> Doc
text String
"# bibliography, e.g. plainnat, or ieeetr. See",
String -> Doc
text String
"# https://en.wikipedia.org/wiki/BibTeX and \\cite for more info.",
String -> Doc
text String
"# The default value is: plain.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_LATEX is set to YES.",
Doc
blank,
String -> Doc
text String
"LATEX_BIB_STYLE = plain",
Doc
blank,
String -> Doc
text String
"# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)",
String -> Doc
text String
"# path from which the emoji images will be read. If a relative path is entered,",
String -> Doc
text String
"# it will be relative to the LATEX_OUTPUT directory. If left blank the",
String -> Doc
text String
"# LATEX_OUTPUT directory will be used.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_LATEX is set to YES.",
Doc
blank,
String -> Doc
text String
"LATEX_EMOJI_DIRECTORY =",
Doc
blank,
String -> Doc
text String
"#---------------------------------------------------------------------------",
String -> Doc
text String
"# Configuration options related to the RTF output",
String -> Doc
text String
"#---------------------------------------------------------------------------",
Doc
blank,
String -> Doc
text String
"# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The",
String -> Doc
text String
"# RTF output is optimized for Word 97 and may not look too pretty with other RTF",
String -> Doc
text String
"# readers/editors.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"GENERATE_RTF = NO",
Doc
blank,
String -> Doc
text String
"# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a",
String -> Doc
text String
"# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of",
String -> Doc
text String
"# it.",
String -> Doc
text String
"# The default directory is: rtf.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_RTF is set to YES.",
Doc
blank,
String -> Doc
text String
"RTF_OUTPUT = rtf",
Doc
blank,
String -> Doc
text String
"# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF",
String -> Doc
text String
"# documents. This may be useful for small projects and may help to save some",
String -> Doc
text String
"# trees in general.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag GENERATE_RTF is set to YES.",
Doc
blank,
String -> Doc
text String
"COMPACT_RTF = NO",
Doc
blank,
String -> Doc
text String
"# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will",
String -> Doc
text String
"# contain hyperlink fields. The RTF file will contain links (just like the HTML",
String -> Doc
text String
"# output) instead of page references. This makes the output suitable for online",
String -> Doc
text String
"# browsing using Word or some other Word compatible readers that support those",
String -> Doc
text String
"# fields.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note: WordPad (write) and others do not support links.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag GENERATE_RTF is set to YES.",
Doc
blank,
String -> Doc
text String
"RTF_HYPERLINKS = NO",
Doc
blank,
String -> Doc
text String
"# Load stylesheet definitions from file. Syntax is similar to doxygen's",
String -> Doc
text String
"# configuration file, i.e. a series of assignments. You only have to provide",
String -> Doc
text String
"# replacements, missing definitions are set to their default value.",
String -> Doc
text String
"#",
String -> Doc
text String
"# See also section \"Doxygen usage\" for information on how to generate the",
String -> Doc
text String
"# default style sheet that doxygen normally uses.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_RTF is set to YES.",
Doc
blank,
String -> Doc
text String
"RTF_STYLESHEET_FILE =",
Doc
blank,
String -> Doc
text String
"# Set optional variables used in the generation of an RTF document. Syntax is",
String -> Doc
text String
"# similar to doxygen's configuration file. A template extensions file can be",
String -> Doc
text String
"# generated using doxygen -e rtf extensionFile.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_RTF is set to YES.",
Doc
blank,
String -> Doc
text String
"RTF_EXTENSIONS_FILE =",
Doc
blank,
String -> Doc
text String
"# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code",
String -> Doc
text String
"# with syntax highlighting in the RTF output.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that which sources are shown also depends on other settings such as",
String -> Doc
text String
"# SOURCE_BROWSER.",
Doc
defNo,
String -> Doc
text String
"#---------------------------------------------------------------------------",
String -> Doc
text String
"# Configuration options related to the man page output",
String -> Doc
text String
"#---------------------------------------------------------------------------",
Doc
blank,
String -> Doc
text String
"# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for",
String -> Doc
text String
"# classes and files.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"GENERATE_MAN = NO",
Doc
blank,
String -> Doc
text String
"# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a",
String -> Doc
text String
"# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of",
String -> Doc
text String
"# it. A directory man3 will be created inside the directory specified by",
String -> Doc
text String
"# MAN_OUTPUT.",
String -> Doc
text String
"# The default directory is: man.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_MAN is set to YES.",
Doc
blank,
String -> Doc
text String
"MAN_OUTPUT = man",
Doc
blank,
String -> Doc
text String
"# The MAN_EXTENSION tag determines the extension that is added to the generated",
String -> Doc
text String
"# man pages. In case the manual section does not start with a number, the number",
String -> Doc
text String
"# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is",
String -> Doc
text String
"# optional.",
String -> Doc
text String
"# The default value is: .3.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_MAN is set to YES.",
Doc
blank,
String -> Doc
text String
"MAN_EXTENSION = .3",
Doc
blank,
String -> Doc
text String
"# The MAN_SUBDIR tag determines the name of the directory created within",
String -> Doc
text String
"# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by",
String -> Doc
text String
"# MAN_EXTENSION with the initial . removed.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_MAN is set to YES.",
Doc
blank,
String -> Doc
text String
"MAN_SUBDIR =",
Doc
blank,
String -> Doc
text String
"# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it",
String -> Doc
text String
"# will generate one additional man file for each entity documented in the real",
String -> Doc
text String
"# man page(s). These additional files only source the real man page, but without",
String -> Doc
text String
"# them the man command would be unable to find the correct page.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag GENERATE_MAN is set to YES.",
Doc
blank,
String -> Doc
text String
"MAN_LINKS = NO",
Doc
blank,
String -> Doc
text String
"#---------------------------------------------------------------------------",
String -> Doc
text String
"# Configuration options related to the XML output",
String -> Doc
text String
"#---------------------------------------------------------------------------",
Doc
blank,
String -> Doc
text String
"# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that",
String -> Doc
text String
"# captures the structure of the code including all documentation.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"GENERATE_XML = NO",
Doc
blank,
String -> Doc
text String
"# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a",
String -> Doc
text String
"# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of",
String -> Doc
text String
"# it.",
String -> Doc
text String
"# The default directory is: xml.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_XML is set to YES.",
Doc
blank,
String -> Doc
text String
"XML_OUTPUT = xml",
Doc
blank,
String -> Doc
text String
"# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program",
String -> Doc
text String
"# listings (including syntax highlighting and cross-referencing information) to",
String -> Doc
text String
"# the XML output. Note that enabling this will significantly increase the size",
String -> Doc
text String
"# of the XML output.",
Doc
defYes,
String -> Doc
text String
"# This tag requires that the tag GENERATE_XML is set to YES.",
Doc
blank,
String -> Doc
text String
"XML_PROGRAMLISTING = YES",
Doc
blank,
String -> Doc
text String
"# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include",
String -> Doc
text String
"# namespace members in file scope as well, matching the HTML output.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag GENERATE_XML is set to YES.",
Doc
blank,
String -> Doc
text String
"XML_NS_MEMB_FILE_SCOPE = NO",
Doc
blank,
String -> Doc
text String
"#---------------------------------------------------------------------------",
String -> Doc
text String
"# Configuration options related to the DOCBOOK output",
String -> Doc
text String
"#---------------------------------------------------------------------------",
Doc
blank,
String -> Doc
text String
"# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files",
String -> Doc
text String
"# that can be used to generate PDF.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"GENERATE_DOCBOOK = NO",
Doc
blank,
String -> Doc
text String
"# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.",
String -> Doc
text String
"# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in",
String -> Doc
text String
"# front of it.",
String -> Doc
text String
"# The default directory is: docbook.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_DOCBOOK is set to YES.",
Doc
blank,
String -> Doc
text String
"DOCBOOK_OUTPUT = docbook",
Doc
blank,
String -> Doc
text String
"# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the",
String -> Doc
text String
"# program listings (including syntax highlighting and cross-referencing",
String -> Doc
text String
"# information) to the DOCBOOK output. Note that enabling this will significantly",
String -> Doc
text String
"# increase the size of the DOCBOOK output.",
Doc
defNo,
String -> Doc
text String
"#---------------------------------------------------------------------------",
String -> Doc
text String
"# Configuration options for the AutoGen Definitions output",
String -> Doc
text String
"#---------------------------------------------------------------------------",
Doc
blank,
String -> Doc
text String
"# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an",
String -> Doc
text String
"# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures",
String -> Doc
text String
"# the structure of the code including all documentation. Note that this feature",
String -> Doc
text String
"# is still experimental and incomplete at the moment.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"GENERATE_AUTOGEN_DEF = NO",
Doc
blank,
String -> Doc
text String
"#---------------------------------------------------------------------------",
String -> Doc
text String
"# Configuration options related to the Perl module output",
String -> Doc
text String
"#---------------------------------------------------------------------------",
Doc
blank,
String -> Doc
text String
"# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module",
String -> Doc
text String
"# file that captures the structure of the code including all documentation.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that this feature is still experimental and incomplete at the moment.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"GENERATE_PERLMOD = NO",
Doc
blank,
String -> Doc
text String
"# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary",
String -> Doc
text String
"# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI",
String -> Doc
text String
"# output from the Perl module output.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag GENERATE_PERLMOD is set to YES.",
Doc
blank,
String -> Doc
text String
"PERLMOD_LATEX = NO",
Doc
blank,
String -> Doc
text String
"# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely",
String -> Doc
text String
"# formatted so it can be parsed by a human reader. This is useful if you want to",
String -> Doc
text String
"# understand what is going on. On the other hand, if this tag is set to NO, the",
String -> Doc
text String
"# size of the Perl module output will be much smaller and Perl will parse it",
String -> Doc
text String
"# just the same.",
Doc
defYes,
String -> Doc
text String
"# This tag requires that the tag GENERATE_PERLMOD is set to YES.",
Doc
blank,
String -> Doc
text String
"PERLMOD_PRETTY = YES",
Doc
blank,
String -> Doc
text String
"# The names of the make variables in the generated doxyrules.make file are",
String -> Doc
text String
"# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful",
String -> Doc
text String
"# so different doxyrules.make files included by the same Makefile don't",
String -> Doc
text String
"# overwrite each other's variables.",
String -> Doc
text String
"# This tag requires that the tag GENERATE_PERLMOD is set to YES.",
Doc
blank,
String -> Doc
text String
"PERLMOD_MAKEVAR_PREFIX =",
Doc
blank,
String -> Doc
text String
"#---------------------------------------------------------------------------",
String -> Doc
text String
"# Configuration options related to the preprocessor",
String -> Doc
text String
"#---------------------------------------------------------------------------",
Doc
blank,
String -> Doc
text String
"# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all",
String -> Doc
text String
"# C-preprocessor directives found in the sources and include files.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"ENABLE_PREPROCESSING = YES",
Doc
blank,
String -> Doc
text String
"# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names",
String -> Doc
text String
"# in the source code. If set to NO, only conditional compilation will be",
String -> Doc
text String
"# performed. Macro expansion can be done in a controlled way by setting",
String -> Doc
text String
"# EXPAND_ONLY_PREDEF to YES.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.",
Doc
blank,
String -> Doc
text String
"MACRO_EXPANSION = NO",
Doc
blank,
String -> Doc
text String
"# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then",
String -> Doc
text String
"# the macro expansion is limited to the macros specified with the PREDEFINED and",
String -> Doc
text String
"# EXPAND_AS_DEFINED tags.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.",
Doc
blank,
String -> Doc
text String
"EXPAND_ONLY_PREDEF = NO",
Doc
blank,
String -> Doc
text String
"# If the SEARCH_INCLUDES tag is set to YES, the include files in the",
String -> Doc
text String
"# INCLUDE_PATH will be searched if a #include is found.",
Doc
defYes,
String -> Doc
text String
"# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.",
Doc
blank,
String -> Doc
text String
"SEARCH_INCLUDES = YES",
Doc
blank,
String -> Doc
text String
"# The INCLUDE_PATH tag can be used to specify one or more directories that",
String -> Doc
text String
"# contain include files that are not input files but should be processed by the",
String -> Doc
text String
"# preprocessor.",
String -> Doc
text String
"# This tag requires that the tag SEARCH_INCLUDES is set to YES.",
Doc
blank,
String -> Doc
text String
"INCLUDE_PATH =",
Doc
blank,
String -> Doc
text String
"# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard",
String -> Doc
text String
"# patterns (like *.h and *.hpp) to filter out the header-files in the",
String -> Doc
text String
"# directories. If left blank, the patterns specified with FILE_PATTERNS will be",
String -> Doc
text String
"# used.",
String -> Doc
text String
"# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.",
Doc
blank,
String -> Doc
text String
"INCLUDE_FILE_PATTERNS =",
Doc
blank,
String -> Doc
text String
"# The PREDEFINED tag can be used to specify one or more macro names that are",
String -> Doc
text String
"# defined before the preprocessor is started (similar to the -D option of e.g.",
String -> Doc
text String
"# gcc). The argument of the tag is a list of macros of the form: name or",
String -> Doc
text String
"# name=definition (no spaces). If the definition and the \"=\" are omitted, \"=1\"",
String -> Doc
text String
"# is assumed. To prevent a macro definition from being undefined via #undef or",
String -> Doc
text String
"# recursively expanded use the := operator instead of the = operator.",
String -> Doc
text String
"# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.",
Doc
blank,
String -> Doc
text String
"PREDEFINED =",
Doc
blank,
String -> Doc
text String
"# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this",
String -> Doc
text String
"# tag can be used to specify a list of macro names that should be expanded. The",
String -> Doc
text String
"# macro definition that is found in the sources will be used. Use the PREDEFINED",
String -> Doc
text String
"# tag if you want to use a different macro definition that overrules the",
String -> Doc
text String
"# definition found in the source code.",
String -> Doc
text String
"# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.",
Doc
blank,
String -> Doc
text String
"EXPAND_AS_DEFINED =",
Doc
blank,
String -> Doc
text String
"# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will",
String -> Doc
text String
"# remove all references to function-like macros that are alone on a line, have",
String -> Doc
text String
"# an all uppercase name, and do not end with a semicolon. Such function macros",
String -> Doc
text String
"# are typically used for boiler-plate code, and will confuse the parser if not",
String -> Doc
text String
"# removed.",
Doc
defYes,
String -> Doc
text String
"# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.",
Doc
blank,
String -> Doc
text String
"SKIP_FUNCTION_MACROS = YES",
Doc
blank,
String -> Doc
text String
"#---------------------------------------------------------------------------",
String -> Doc
text String
"# Configuration options related to external references",
String -> Doc
text String
"#---------------------------------------------------------------------------",
Doc
blank,
String -> Doc
text String
"# The TAGFILES tag can be used to specify one or more tag files. For each tag",
String -> Doc
text String
"# file the location of the external documentation should be added. The format of",
String -> Doc
text String
"# a tag file without this location is as follows:",
String -> Doc
text String
"# TAGFILES = file1 file2 ...",
String -> Doc
text String
"# Adding location for the tag files is done as follows:",
String -> Doc
text String
"# TAGFILES = file1=loc1 \"file2 = loc2\" ...",
String -> Doc
text String
"# where loc1 and loc2 can be relative or absolute paths or URLs. See the",
String -> Doc
text String
"# section \"Linking to external documentation\" for more information about the use",
String -> Doc
text String
"# of tag files.",
String -> Doc
text String
"# Note: Each tag file must have a unique name (where the name does NOT include",
String -> Doc
text String
"# the path). If a tag file is not located in the directory in which doxygen is",
String -> Doc
text String
"# run, you must also specify the path to the tagfile here.",
Doc
blank,
String -> Doc
text String
"TAGFILES =",
Doc
blank,
String -> Doc
text String
"# When a file name is specified after GENERATE_TAGFILE, doxygen will create a",
String -> Doc
text String
"# tag file that is based on the input files it reads. See section \"Linking to",
String -> Doc
text String
"# external documentation\" for more information about the usage of tag files.",
Doc
blank,
String -> Doc
text String
"GENERATE_TAGFILE =",
Doc
blank,
String -> Doc
text String
"# If the ALLEXTERNALS tag is set to YES, all external class will be listed in",
String -> Doc
text String
"# the class index. If set to NO, only the inherited external classes will be",
String -> Doc
text String
"# listed.",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"ALLEXTERNALS = NO",
Doc
blank,
String -> Doc
text String
"# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed",
String -> Doc
text String
"# in the modules index. If set to NO, only the current project's groups will be",
String -> Doc
text String
"# listed.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"EXTERNAL_GROUPS = YES",
Doc
blank,
String -> Doc
text String
"# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in",
String -> Doc
text String
"# the related pages index. If set to NO, only the current project's pages will",
String -> Doc
text String
"# be listed.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"EXTERNAL_PAGES = YES",
Doc
blank,
String -> Doc
text String
"#---------------------------------------------------------------------------",
String -> Doc
text String
"# Configuration options related to the dot tool",
String -> Doc
text String
"#---------------------------------------------------------------------------",
Doc
blank,
String -> Doc
text String
"# You can include diagrams made with dia in doxygen documentation. Doxygen will",
String -> Doc
text String
"# then run dia to produce the diagram and insert it in the documentation. The",
String -> Doc
text String
"# DIA_PATH tag allows you to specify the directory where the dia binary resides.",
String -> Doc
text String
"# If left empty dia is assumed to be found in the default search path.",
Doc
blank,
String -> Doc
text String
"DIA_PATH =",
Doc
blank,
String -> Doc
text String
"# If set to YES the inheritance and collaboration graphs will hide inheritance",
String -> Doc
text String
"# and usage relations if the target is undocumented or is not a class.",
Doc
defYes,
Doc
blank,
String -> Doc
text String
"HIDE_UNDOC_RELATIONS = YES",
Doc
blank,
String -> Doc
text String
"# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is",
String -> Doc
text String
"# available from the path. This tool is part of Graphviz (see:",
String -> Doc
text String
"# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent",
String -> Doc
text String
"# Bell Labs. The other options in this section have no effect if this option is",
String -> Doc
text String
"# set to NO",
Doc
defNo,
Doc
blank,
String -> Doc
text String
"HAVE_DOT = NO",
Doc
blank,
String -> Doc
text String
"# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed",
String -> Doc
text String
"# to run in parallel. When set to 0 doxygen will base this on the number of",
String -> Doc
text String
"# processors available in the system. You can set it explicitly to a value",
String -> Doc
text String
"# larger than 0 to get control over the balance between CPU load and processing",
String -> Doc
text String
"# speed.",
String -> Doc
text String
"# Minimum value: 0, maximum value: 32, default value: 0.",
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"DOT_NUM_THREADS = 0",
Doc
blank,
String -> Doc
text String
"# By default doxygen will tell dot to use the default font as specified with",
String -> Doc
text String
"# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set",
String -> Doc
text String
"# the path where dot can find it using this tag.",
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"DOT_FONTPATH =",
Doc
blank,
String -> Doc
text String
"# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for",
String -> Doc
text String
"# each documented class showing the direct and indirect inheritance relations.",
String -> Doc
text String
"# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.",
Doc
defYes,
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"CLASS_GRAPH = YES",
Doc
blank,
String -> Doc
text String
"# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a",
String -> Doc
text String
"# graph for each documented class showing the direct and indirect implementation",
String -> Doc
text String
"# dependencies (inheritance, containment, and class references variables) of the",
String -> Doc
text String
"# class with other documented classes.",
Doc
defYes,
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"COLLABORATION_GRAPH = YES",
Doc
blank,
String -> Doc
text String
"# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for",
String -> Doc
text String
"# groups, showing the direct groups dependencies.",
Doc
defYes,
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"GROUP_GRAPHS = YES",
Doc
blank,
String -> Doc
text String
"# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and",
String -> Doc
text String
"# collaboration diagrams in a style similar to the OMG's Unified Modeling",
String -> Doc
text String
"# Language.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"UML_LOOK = NO",
Doc
blank,
String -> Doc
text String
"# If the UML_LOOK tag is enabled, the fields and methods are shown inside the",
String -> Doc
text String
"# class node. If there are many fields or methods and many nodes the graph may",
String -> Doc
text String
"# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the",
String -> Doc
text String
"# number of items for each type to make the size more manageable. Set this to 0",
String -> Doc
text String
"# for no limit. Note that the threshold may be exceeded by 50% before the limit",
String -> Doc
text String
"# is enforced. So when you set the threshold to 10, up to 15 fields may appear,",
String -> Doc
text String
"# but if the number exceeds 15, the total amount of fields shown is limited to",
String -> Doc
text String
"# 10.",
String -> Doc
text String
"# Minimum value: 0, maximum value: 100, default value: 10.",
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"UML_LIMIT_NUM_FIELDS = 10",
Doc
blank,
String -> Doc
text String
"# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and",
String -> Doc
text String
"# collaboration graphs will show the relations between templates and their",
String -> Doc
text String
"# instances.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"TEMPLATE_RELATIONS = NO",
Doc
blank,
String -> Doc
text String
"# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to",
String -> Doc
text String
"# YES then doxygen will generate a graph for each documented file showing the",
String -> Doc
text String
"# direct and indirect include dependencies of the file with other documented",
String -> Doc
text String
"# files.",
Doc
defYes,
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"INCLUDE_GRAPH = YES",
Doc
blank,
String -> Doc
text String
"# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are",
String -> Doc
text String
"# set to YES then doxygen will generate a graph for each documented file showing",
String -> Doc
text String
"# the direct and indirect include dependencies of the file with other documented",
String -> Doc
text String
"# files.",
Doc
defYes,
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"INCLUDED_BY_GRAPH = YES",
Doc
blank,
String -> Doc
text String
"# If the CALL_GRAPH tag is set to YES then doxygen will generate a call",
String -> Doc
text String
"# dependency graph for every global function or class method.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that enabling this option will significantly increase the time of a run.",
String -> Doc
text String
"# So in most cases it will be better to enable call graphs for selected",
String -> Doc
text String
"# functions only using the \\callgraph command. Disabling a call graph can be",
String -> Doc
text String
"# accomplished by means of the command \\hidecallgraph.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"CALL_GRAPH = NO",
Doc
blank,
String -> Doc
text String
"# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller",
String -> Doc
text String
"# dependency graph for every global function or class method.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that enabling this option will significantly increase the time of a run.",
String -> Doc
text String
"# So in most cases it will be better to enable caller graphs for selected",
String -> Doc
text String
"# functions only using the \\callergraph command. Disabling a caller graph can be",
String -> Doc
text String
"# accomplished by means of the command \\hidecallergraph.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"CALLER_GRAPH = NO",
Doc
blank,
String -> Doc
text String
"# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical",
String -> Doc
text String
"# hierarchy of all classes instead of a textual one.",
Doc
defYes,
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"GRAPHICAL_HIERARCHY = YES",
Doc
blank,
String -> Doc
text String
"# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the",
String -> Doc
text String
"# dependencies a directory has on other directories in a graphical way. The",
String -> Doc
text String
"# dependency relations are determined by the #include relations between the",
String -> Doc
text String
"# files in the directories.",
Doc
defYes,
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"DIRECTORY_GRAPH = YES",
Doc
blank,
String -> Doc
text String
"# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images",
String -> Doc
text String
"# generated by dot. For an explanation of the image formats see the section",
String -> Doc
text String
"# output formats in the documentation of the dot tool (Graphviz (see:",
String -> Doc
text String
"# http://www.graphviz.org/)).",
String -> Doc
text String
"# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order",
String -> Doc
text String
"# to make the SVG files visible in IE 9+ (other browsers do not have this",
String -> Doc
text String
"# requirement).",
String -> Doc
text String
"# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,",
String -> Doc
text String
"# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and",
String -> Doc
text String
"# png:gdiplus:gdiplus.",
String -> Doc
text String
"# The default value is: png.",
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"DOT_IMAGE_FORMAT = png",
Doc
blank,
String -> Doc
text String
"# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to",
String -> Doc
text String
"# enable generation of interactive SVG images that allow zooming and panning.",
String -> Doc
text String
"#",
String -> Doc
text String
"# Note that this requires a modern browser other than Internet Explorer. Tested",
String -> Doc
text String
"# and working are Firefox, Chrome, Safari, and Opera.",
String -> Doc
text String
"# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make",
String -> Doc
text String
"# the SVG files visible. Older versions of IE do not have SVG support.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"INTERACTIVE_SVG = NO",
Doc
blank,
String -> Doc
text String
"# The DOT_PATH tag can be used to specify the path where the dot tool can be",
String -> Doc
text String
"# found. If left blank, it is assumed the dot tool can be found in the path.",
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"DOT_PATH =",
Doc
blank,
String -> Doc
text String
"# The DOTFILE_DIRS tag can be used to specify one or more directories that",
String -> Doc
text String
"# contain dot files that are included in the documentation (see the \\dotfile",
String -> Doc
text String
"# command).",
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"DOTFILE_DIRS =",
Doc
blank,
String -> Doc
text String
"# The MSCFILE_DIRS tag can be used to specify one or more directories that",
String -> Doc
text String
"# contain msc files that are included in the documentation (see the \\mscfile",
String -> Doc
text String
"# command).",
Doc
blank,
String -> Doc
text String
"MSCFILE_DIRS =",
Doc
blank,
String -> Doc
text String
"# The DIAFILE_DIRS tag can be used to specify one or more directories that",
String -> Doc
text String
"# contain dia files that are included in the documentation (see the \\diafile",
String -> Doc
text String
"# command).",
Doc
blank,
String -> Doc
text String
"DIAFILE_DIRS =",
Doc
blank,
String -> Doc
text String
"# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the",
String -> Doc
text String
"# path where java can find the plantuml.jar file. If left blank, it is assumed",
String -> Doc
text String
"# PlantUML is not used or called during a preprocessing step. Doxygen will",
String -> Doc
text String
"# generate a warning when it encounters a \\startuml command in this case and",
String -> Doc
text String
"# will not generate output for the diagram.",
Doc
blank,
String -> Doc
text String
"PLANTUML_JAR_PATH =",
Doc
blank,
String -> Doc
text String
"# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a",
String -> Doc
text String
"# configuration file for plantuml.",
Doc
blank,
String -> Doc
text String
"PLANTUML_CFG_FILE =",
Doc
blank,
String -> Doc
text String
"# When using plantuml, the specified paths are searched for files specified by",
String -> Doc
text String
"# the !include statement in a plantuml block.",
Doc
blank,
String -> Doc
text String
"PLANTUML_INCLUDE_PATH =",
Doc
blank,
String -> Doc
text String
"# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes",
String -> Doc
text String
"# that will be shown in the graph. If the number of nodes in a graph becomes",
String -> Doc
text String
"# larger than this value, doxygen will truncate the graph, which is visualized",
String -> Doc
text String
"# by representing a node as a red box. Note that doxygen if the number of direct",
String -> Doc
text String
"# children of the root node in a graph is already larger than",
String -> Doc
text String
"# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that",
String -> Doc
text String
"# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.",
String -> Doc
text String
"# Minimum value: 0, maximum value: 10000, default value: 50.",
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"DOT_GRAPH_MAX_NODES = 50",
Doc
blank,
String -> Doc
text String
"# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs",
String -> Doc
text String
"# generated by dot. A depth value of 3 means that only nodes reachable from the",
String -> Doc
text String
"# root by following a path via at most 3 edges will be shown. Nodes that lay",
String -> Doc
text String
"# further from the root node will be omitted. Note that setting this option to 1",
String -> Doc
text String
"# or 2 may greatly reduce the computation time needed for large code bases. Also",
String -> Doc
text String
"# note that the size of a graph can be further restricted by",
String -> Doc
text String
"# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.",
String -> Doc
text String
"# Minimum value: 0, maximum value: 1000, default value: 0.",
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"MAX_DOT_GRAPH_DEPTH = 0",
Doc
blank,
String -> Doc
text String
"# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output",
String -> Doc
text String
"# files in one run (i.e. multiple -o and -T options on the command line). This",
String -> Doc
text String
"# makes dot run faster, but since only newer versions of dot (>1.8.10) support",
String -> Doc
text String
"# this, this feature is disabled by default.",
Doc
defNo,
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"DOT_MULTI_TARGETS = NO",
Doc
blank,
String -> Doc
text String
"# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page",
String -> Doc
text String
"# explaining the meaning of the various boxes and arrows in the dot generated",
String -> Doc
text String
"# graphs.",
Doc
defYes,
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"GENERATE_LEGEND = YES",
Doc
blank,
String -> Doc
text String
"# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot",
String -> Doc
text String
"# files that are used to generate the various graphs.",
Doc
defYes,
String -> Doc
text String
"# This tag requires that the tag HAVE_DOT is set to YES.",
Doc
blank,
String -> Doc
text String
"DOT_CLEANUP = YES"]