Context navigation

← Previous change
Next change →

Changeset 1313 in 3DVCSoftware for trunk/doc

Timestamp:

13 Aug 2015, 17:38:13 (10 years ago)

Author:

tech

Message:

Merged 14.1-update-dev1@1312.

Location:

trunk/doc

Files:

: 4 edited

Doxyfile (modified) (6 diffs)
mainpage.h (modified) (2 diffs)
software-manual.pdf (modified) (previous)
software-manual.tex (modified) (94 diffs)

Legend:

: Unmodified
: Added
: Removed

trunk/doc/Doxyfile

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

trunk/doc/mainpage.h

r872	r1313
16	16	*
17	17	* For <b>bug reporting and known issues</b> see:
18		* http~~://hevc.kw.bbc.co.uk/trac/~~
	18	* https://hevc.hhi.fraunhofer.de/trac/hevc
19	19	*
20	20	* \section License
…	…
25	25	* granted under this license.
26	26	*
27		* Copyright (c) 2010-2014, ITU/ISO/IEC
	27	* Copyright (c) 2010-2015, ITU/ISO/IEC
28	28	* All rights reserved.
29	29	*

trunk/doc/software-manual.tex

-                      r964
+                      r1313
+}
+\newenvironment{OptionTableNoShorthand}[2]{%
+        \footnotesize
+        \def\arraystretch{1.8}
+        \clearOptions
+        \begin{longtable}{l<{\makecell[tl]{\optOption}}%
+                          c<{\makecell[tc]{\optDefault}}%
+                          >{\def\arraystretch{1.0}}p{0.5\textwidth}<{\clearOptions}}
+        \caption{#1} \label{#2} \\
+        \hspace*{12em}&\hspace*{8em}&\kill
+        \hline
+         \thead{Option} &
+         \thead{Default} &
+         \thead{Description} \\
+        \hline
+        \endfirsthead
+        \caption[]{#1 (Continued)} \\
+        \hspace*{12em}&\hspace*{8em}&\kill
+        \hline
+         \thead{Option} &
+         \thead{Default} &
+         \thead{Description} \\
+        \hline
+        \endhead
+         \multicolumn{3}{r}{Continued...}\\
+         \hline
+        \endfoot
+         \hline
+        \endlastfoot
+}{%
+        \hline
+        \end{longtable}
+}
+\newenvironment{SEIListTable}[1]{%
+        \footnotesize
+        \def\arraystretch{1.8}
+        \clearOptions
+        \begin{longtable}{c<{\makecell[tl]{\optOption}}%
+                          l<{\makecell[tc]{\optDefault}}%
+                          >{\def\arraystretch{1.0}}p{0.3\textwidth}<{\clearOptions}}
+        \caption{#1} \\
+        \hspace*{12em}&\hspace*{8em}&\kill
+        \hline
+         \thead{SEI Number} &
+         \thead{SEI Name} &
+         \thead{Table number of encoder controls, if available} \\
+        \hline
+        \endfirsthead
+        \caption[]{#1 (Continued)} \\
+        \hspace*{12em}&\hspace*{8em}&\kill
+        \hline
+         \thead{SEI Number} &
+         \thead{SEI Name} &
+         \thead{Table number of encoder controls, if available} \\
+        \hline
+        \endhead
+         \multicolumn{3}{r}{Continued...}\\
+         \hline
+        \endfoot
+         \hline
+        \endlastfoot
+}{%
+        \hline
+        \end{longtable}
+}
 \newenvironment{MacroTable}[1]{%
         \footnotesize
 …
         \email{dflynn@blackberry.com}
         \and
+  Karl Sharman
+        \email{karl.sharman@eu.sony.com}
+        \and
         Karsten S\"uhring
         \email{karsten.suehring@hhi.fraunhofer.de}
 …
 \begin{abstract}
 This document is a user manual describing usage of reference software
 for the HEVC project. It applies to version 14.0
+for the HEVC project. It applies to version 16.6
 of the software.
 \end{abstract}
 …
 \listoftables
 \section{General Information}
 Reference software is being made available to provide a reference
 implementation of the draft HEVC standard being developed by the Joint
+implementation of the HEVC standard being developed by the Joint
 Collaborative Team on Video Coding (JCT-VC) regrouping experts from
 ITU-T SG 16 and ISO/IEC SC29 WG11. One of the main goals of the
 …
 MS Visual Studio 8   & build/HM_vc8.sln \\
 MS Visual Studio 9   & build/HM_vc9.sln \\
+MS Visual Studio 10  & build/HM_vc10.sln \\
 Xcode                & HM.xcodeproj \\
 Linux                & build/linux/makefile \\
 …
 \section{Using the encoder}
 \begin{verbatim}
 TAppEncoder     [-h] [-c config.cfg] [--parameter=value]
+TAppEncoder     [--help] [-c config.cfg] [--parameter=value]
 \end{verbatim}
 …
  \thead{Description} \\
 \hline
 \texttt{-h} & Prints parameter usage. \\
+\texttt{--help} & Prints parameter usage. \\
 \texttt{-c} & Defines configuration file to use.  Multiple configuration files
      may be used with repeated --c options. \\
 …
     & Assigns value to a given parameter as further described below.
       Some parameters are also supported by shorthand
+      "--\em{opt}~\emph{value}".\\
+      "--\em{opt}~\emph{value}". These are shown in brackets after the parameter
+      name in the tables of this document\\
 \hline
 \end{tabular}
 …
 Sample configuration files are provided in the cfg/ folder.
+Parameters are defined by the last value encountered on the command line.
+Therefore if a setting is set via a configuration file, and then a subsequent
+command line parameter changes that same setting, the command line parameter
+value will be used.
 \subsection{GOP structure table}
 …
 includes pictures that are used for reference for the current
 picture as well as pictures that will be used for reference in
 the future. The encoder will not automatically calculate what
 pictures that has to be kept for future references, they have to
+the future. The encoder will not automatically calculate which
+pictures have to be kept for future references, they must
 be specified. Note that some specified reference frames for
 pictures encoded in the very first GOP after an IDR frame might
 …
 %% File, I/O and source parameters
 %%
+\begin{OptionTable}{File, I/O and source parameters}
+\Option{InputFile} &
+\ShortOption{-i} &
+Shorthand alternatives for the parameter that can be used on the command line are shown in brackets after the parameter name.
+\begin{OptionTableNoShorthand}{File, I/O and source parameters.}{tab:fileIO}
+\Option{InputFile (-i)} &
+%\ShortOption{-i} &
 \Default{\NotSet} &
 Specifies the input video file.
 Video data must be in a raw 4:2:0 planar format (Y$'$CbCr).
+Video data must be in a raw 4:2:0, or 4:2:2 planar format, 4:4:4 planar format (Y$'$CbCr, RGB or GBR), or in a raw 4:0:0 format.
 Note: When the bit depth of samples is larger than 8, each sample is encoded in
 …
 \\
 \Option{BitstreamFile} &
 \ShortOption{-b} &
+\Option{BitstreamFile (-b)} &
+%\ShortOption{-b} &
 \Default{\NotSet} &
 Specifies the output coded bit stream file.
 \\
 \Option{ReconFile} &
 \ShortOption{-o} &
+\Option{ReconFile (-o)} &
+%\ShortOption{-o} &
 \Default{\NotSet} &
 Specifies the output locally reconstructed video file.
 \\
 \Option{SourceWidth}%
 \Option{SourceHeight} &
 \ShortOption{-wdt}%
 \ShortOption{-hgt} &
+\Option{SourceWidth (-wdt)}%
+\Option{SourceHeight (-hgt)} &
+%\ShortOption{-wdt}%
+%\ShortOption{-hgt} &
 \Default{0}%
 \Default{0} &
 …
 \\
+\Option{InputBitDepth} &
+\ShortOption{\None} &
+\Option{InputBitDepth}
+ &
+%\ShortOption{\None} &
 \Default{8} &
 Specifies the bit depth of the input video.
 \\
+\Option{MSBExtendedBitDepth} &
+%\ShortOption{\None} &
+\Default{0} &
+Extends the input video by adding MSBs of value 0. When 0, no extension is applied and the InputBitDepth is used.
+The MSBExtendedBitDepth becomes the effective file InputBitDepth for subsequent processing.
+\\
 \Option{InternalBitDepth} &
+\ShortOption{\None} &
+\Default{0 \\ (InputBitDepth)} &
+Specifies the bit depth used for coding.
+%\ShortOption{\None} &
+\Default{0} &
+Specifies the bit depth used for coding. When 0, the setting defaults to the
+value of the MSBExtendedBitDepth.
 If the input video is a different bit depth to InternalBitDepth, it is
 …
 \left\lfloor
  \frac{\mathrm{Pel} * 2^{\mathrm{InternalBitDepth}}}{
 ^{\mathrm{InputBitDepth}}}
+^{\mathrm{MSBExtendedBitDepth}}}
 \right\rfloor
 \end{displaymath}
 Note: The effect of this option is as if the input video is externally
+converted to the InternalBitDepth and then coded with this value as
+InputBitDepth.  The codec has no notion of two different bit depths.
+converted to the MSBExtendedBitDepth and then to the InternalBitDepth
+and then coded with this value as InputBitDepth. The codec has no
+notion of different bit depths.
 \\
 \Option{OutputBitDepth} &
 \ShortOption{\None} &
 \Default{0 \\ (InternalBitDepth)} &
+%\ShortOption{\None} &
+\Default{0} &
 Specifies the bit depth of the output locally reconstructed video file.
+When 0, the setting defaults to the value of InternalBitDepth.
 Note: This option has no effect on the decoding process.
 \\
 \Option{InputBitDepthC}%
+\Option{MSBExtendedBitDepthC}%
 \Option{InternalBitDepthC}%
 \Option{OutputBitDepthC} &
+\ShortOption{\None} &
+\Default{(InputBitDepth)}%
+\Default{(InternalBitDepth)}%
+\Default{(InternalBitDepthC)} &
+%\ShortOption{\None} &
+\Default{0}%
+\Default{0}%
+\Default{0}%
+\Default{0} &
 Specifies the various bit-depths for chroma components.  These only need
 to be specified if non-equal luma and chroma bit-depth processing is
+required.
+\\
+\Option{ConformanceMode} &
+\ShortOption{\None} &
+\Default{0} &
+Specifies the conformance mode (cropping/padding parameters) to be applied to the input
+video. The following modes are available:
+\par
+\begin{tabular}{cp{0.45\textwidth}}
+required. When 0, the setting defaults to the corresponding non-Chroma value.
+\\
+\Option{InputColourSpaceConvert} &
+%\ShortOption{\None} &
+\Default{\NotSet} &
+The colour space conversion to apply to input video. Permitted values are:
+\par
+\begin{tabular}{lp{0.3\textwidth}}
+  UNCHANGED & No colour space conversion is applied \\
+  YCbCrToYCrCb & Swap the second and third components \\
+  YCbCrtoYYY & Set the second and third components to the values in the first \\
+  RGBtoGBR & Reorder the three components \\
+\end{tabular}
+\par
+If no value is specified, no colour space conversion is applied. The list may eventually also include RGB to YCbCr or YCgCo conversions.
+\\
+\Option{SNRInternalColourSpace} &
+%\ShortOption{\None} &
+\Default{false} &
+When this is set true, then no colour space conversion is applied prior to PSNR calculation, otherwise the inverse of InputColourSpaceConvert is applied.
+\\
+\Option{OutputInternalColourSpace} &
+%\ShortOption{\None} &
+\Default{false} &
+When this is set true, then no colour space conversion is applied to the reconstructed video, otherwise the inverse of InputColourSpaceConvert is applied.
+\\
+\Option{InputChromaFormat} &
+%\ShortOption{\None} &
+\Default{420} &
+Specifies the chroma format used in the input file. Permitted values (depending on the profile) are 400, 420, 422 or 444.
+\\
+\Option{ChromaFormatIDC (-cf)} &
+%\ShortOption{-cf} &
+\Default{0} &
+Specifies the chroma format to use for processing. Permitted values (depending on the profile) are 400, 420, 422 or 444; the value of 0 indicates that the value of InputChromaFormat should be used instead.
+\\
+\Option{MSEBasedSequencePSNR} &
+%\ShortOption{\None} &
+\Default{false} &
+When 0, the PSNR output is a linear average of the frame PSNRs; when 1, additional PSNRs are output which are formed from the average MSE of all the frames. The latter is useful when coding near-losslessly, where occasional frames become lossless.
+\\
+\Option{PrintFrameMSE} &
+%\ShortOption{\None} &
+\Default{false} &
+When 1, the Mean Square Error (MSE) values of each frame will also be output alongside the default PSNR values.
+\\
+\Option{PrintSequenceMSE} &
+%\ShortOption{\None} &
+\Default{false} &
+When 1, the Mean Square Error (MSE) values of the entire sequence will also be output alongside the default PSNR values.
+\\
+\Option{SummaryOutFilename} &
+%\ShortOption{\None} &
+\Default{false} &
+Filename to use for producing summary output file. If empty, do not produce a file.
+\\
+\Option{SummaryPicFilenameBase} &
+%\ShortOption{\None} &
+\Default{false} &
+Base filename to use for producing summary picture output files. The actual filenames used will have I.txt, P.txt and B.txt appended. If empty, do not produce a file.
+\\
+\Option{SummaryVerboseness} &
+%\ShortOption{\None} &
+\Default{false} &
+Specifies the level of the verboseness of the text output.
+\\
+\Option{CabacZeroWordPaddingEnabled} &
+%\ShortOption{\None} &
+\Default{false} &
+When 1, CABAC zero word padding will be enabled. This is currently not the default value for the setting.
+\\
+\Option{ConformanceWindowMode} &
+%\ShortOption{\None} &
+\Default{0} &
+Specifies how the parameters related to the conformance window are interpreted (cropping/padding).
+The following modes are available:
+\par
+\begin{tabular}{cp{0.43\textwidth}}
 & No cropping / padding \\
 & Automatic padding to the next minimum CU size \\
 & Padding according to parameters HorizontalPadding and VerticalPadding \\
 & Cropping according to parameters ConfLeft, ConfRight, ConfTop and ConfBottom \\
 \end{tabular}
 \\
 \Option{HorizontalPadding}%
 \Option{VerticalPadding} &
 \ShortOption{-pdx}%
 \ShortOption{-pdy} &
+& Cropping according to parameters ConfWinLeft, ConfWinRight, ConfWinTop and ConfWinBottom \\
+\end{tabular}
+\\
+\Option{HorizontalPadding (-pdx)}%
+\Option{VerticalPadding (-pdy)} &
+%\ShortOption{-pdx}%
+%\ShortOption{-pdy} &
 \Default{0} &
 Specifies the horizontal and vertical padding to be applied to the input
 video in luma samples.  Must be a multiple of the chroma resolution
 (e.g. a multiple of two for 4:2:0).
 \\
 \Option{ConfLeft}%
 \Option{ConfRight}%
 \Option{ConfTop}%
 \Option{ConfBottom} &
 \ShortOption{\None} &
+video in luma samples when ConformanceWindowMode is 2.  Must be a multiple of
+the chroma resolution (e.g. a multiple of two for 4:2:0).
+\\
+\Option{ConfWinLeft}%
+\Option{ConfWinRight}%
+\Option{ConfWinTop}%
+\Option{ConfWinBottom} &
+%\ShortOption{\None} &
 \Default{0} &
 Specifies the horizontal and vertical cropping to be applied to the
+input video in luma samples.  Must be a multiple of the chroma
+resolution (e.g. a multiple of two for 4:2:0).
+\\
+\Option{FrameRate} &
+\ShortOption{-fr} &
+input video in luma samples when ConformanceWindowMode is 3.
+Must be a multiple of the chroma resolution (e.g. a multiple of
+two for 4:2:0).
+\\
+\Option{FrameRate (-fr)} &
+%\ShortOption{-fr} &
 \Default{0} &
 Specifies the frame rate of the input video.
 …
 \\
 \Option{FrameSkip} &
 \ShortOption{-fs} &
+\Option{FrameSkip (-fs)} &
+%\ShortOption{-fs} &
 \Default{0} &
 Specifies a number of frames to skip at beginning of input video file.
 \\
+\Option{FramesToBeEncoded} &
+\ShortOption{-f} &
+\Default{0 \\ (all)} &
+Specifies the number of frames to be encoded.
+\\
+\end{OptionTable}
+\Option{FramesToBeEncoded (-f)} &
+%\ShortOption{-f} &
+\Default{0} &
+Specifies the number of frames to be encoded. When 0, all frames are coded.
+\\
+\Option{FieldCoding} &
+%\ShortOption{\None} &
+\Default{false} &
+When 1, indicates that field-based coding is to be applied.
+\\
+\Option{TopFieldFirst (-Tff)} &
+%\ShortOption{\None} &
+\Default{0} &
+Indicates the order of the fields packed into the input frame. When 1, the top field is temporally first.
+\\
+\Option{ClipInputVideoToRec709Range} &
+%\ShortOption{\None} &
+\Default{0} &
+If 1 then clip input video to the Rec. 709 Range on loading when InternalBitDepth is less than MSBExtendedBitDepth.
+\\
+\Option{ClipOutputVideoToRec709Range} &
+%\ShortOption{\None} &
+\Default{0} &
+If 1 then clip output video to the Rec. 709 Range on saving when OutputBitDepth is less than InternalBitDepth.
+\\
+\Option{EfficientFieldIRAPEnabled} &
+%\ShortOption{\None} &
+\Default{1} &
+Enable to code fields in a specific, potentially more efficient, order.
+\\
+\Option{HarmonizeGopFirstFieldCoupleEnabled} &
+%\ShortOption{\None} &
+\Default{1} &
+Enables harmonization of Gop first field couple.
+\\
+\end{OptionTableNoShorthand}
 %%
 %% profile, level and conformance options
 %%
 \begin{OptionTable}{Profile and level parameters}
+\begin{OptionTableNoShorthand}{Profile and level parameters}{tab:profile}
 \Option{Profile} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{none} &
 Specifies the profile to which the encoded bitstream complies.
+Valid values are: none, main, main10, main-still-picture.
+Valid HEVC Ver. 1 values are: none, main, main10, main-still-picture
+Valid HEVC Ver. 2 (RExt) values are: main-RExt, high-throughput-RExt,
+monochrome, monochrome12, monochrome16, main12, main_422_10,
+main_422_12, main_444, main_444_10, main_444_12, main_444_16,
+main_intra, main_10_intra, main_12_intra, main_422_10_intra, main_422_12_intra,
+main_444_intra, main_444_10_intra, main_444_12_intra, main_444_16_intra.
+When main-RExt is specified, the constraint flags are either manually specified, or calculated via the other supplied settings.
 Compatibility flags are automatically determined according to the profile.
+If --Profile=main, then main10 will always be signalled as compatible.
+If --Profile=main10, then main will be signalled as compatible if the bit-depth is 8-bit.
+NB: There is currently no validation that the encoder configuration complies with the profile and level constraints.
+NB: There is currently only limited validation that the encoder configuration complies with the profile, level and tier constraints.
 \\
 \Option{Level} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{none} &
 Specifies the level to which the encoded bitstream complies.
 Valid values are: none, 1, 2, 2.1, 3, 3.1, 4, 4.1, 5, 5.1, 5.2, 6, 6.1, 6.2.
 NB: There is currently no validation that the encoder configuration complies with the profile and level constraints.
+Valid values are: none, 1, 2, 2.1, 3, 3.1, 4, 4.1, 5, 5.1, 5.2, 6, 6.1, 6.2, 8.5
+NB: There is currently only limited validation that the encoder configuration complies with the profile, level and tier constraints.
 \\
 \Option{Tier} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{main} &
 Specifies the level tier to which the encoded bitsream complies.
 Valid values are: main, high.
+NB: There is currently no validation that the encoder configuration complies with the profile and level constraints.
+NB: There is currently only limited validation that the encoder configuration complies with the profile, level and tier constraints.
+\\
+\Option{MaxBitDepthConstraint} &
+%\ShortOption{\None} &
+\Default{0} &
+For --profile=main-RExt, specifies the value to use to derive the general_max_bit_depth constraint flags for RExt profiles; when 0, use $\max(InternalBitDepth, InternalBitDepthC)$
+\\
+\Option{MaxChromaFormatConstraint} &
+%\ShortOption{\None} &
+\Default{0} &
+For --profile=main-RExt, specifies the chroma-format to use for the general profile constraints for RExt profiles; when 0, use the value of ChromaFormatIDC.
+\\
+\Option{IntraConstraintFlag} &
+%\ShortOption{\None} &
+\Default{false} &
+For --profile=main-RExt, specifies the value of general_intra_constraint_flag to use for RExt profiles.
+\\
+\Option{OnePictureOnlyConstraintFlag} &
+%\ShortOption{\None} &
+\Default{false} &
+For --profile=main-RExt, specifies the value of general_one_picture_only_constraint_flag to use for RExt profiles.
+\\
+\Option{LowerBitRateConstraintFlag} &
+%\ShortOption{\None} &
+\Default{true} &
+Specifies the value of general_lower_bit_constraint_flag to use for RExt profiles.
 \\
 \Option{ProgressiveSource} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{false} &
 Specifies the value of general_progressive_source_flag
 …
 \Option{InterlacedSource} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{false} &
 Specifies the value of general_interlaced_source_flag
 …
 \Option{NonPackedSource} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{false} &
 Specifies the value of general_non_packed_constraint_flag
 …
 \Option{FrameOnly} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{false} &
 Specifies the value of general_frame_only_constraint_flag
 \\
 \end{OptionTable}
+\end{OptionTableNoShorthand}
 …
 %% Unit definition parameters
 %%
+\begin{OptionTable}{Unit definition parameters}
+\begin{OptionTableNoShorthand}{Unit definition parameters}{tab:unit}
 \Option{MaxCUWidth} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{64} &
 Defines the maximum CU width.
 …
 \Option{MaxCUHeight} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{64} &
 Defines the maximum CU height.
 \\
 \Option{MaxCUSize} &
 \ShortOption{\None} &
+\Option{MaxCUSize (-s)} &
+%\ShortOption{\None} &
 \Default{64} &
 Defines the maximum CU size.
 \\
 \Option{MaxPartitionDepth} &
 \ShortOption{-h} &
+\Option{MaxPartitionDepth (-h)} &
+%\ShortOption{-h} &
 \Default{4} &
 Defines the depth of the CU tree.
 …
 \Option{QuadtreeTULog2MaxSize} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{6 \\ ($= \mathrm{log}_2(64)$)} &
 Defines the Maximum TU size in logarithm base 2.
 …
 \Option{QuadtreeTULog2MinSize} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{2 \\ ($= \mathrm{log}_2(4)$)} &
 Defines the Minimum TU size in logarithm base 2.
 …
 \Option{QuadtreeTUMaxDepthIntra} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{1} &
 Defines the depth of the TU tree for intra CUs.
 …
 \Option{QuadtreeTUMaxDepthInter} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{2} &
 Defines the depth of the TU tree for inter CUs.
 \\
+\end{OptionTable}
+\end{OptionTableNoShorthand}
 …
 %% Coding structure parameters
 %%
+\begin{OptionTable}{Coding structure parameters}
+\Option{IntraPeriod} &
+\ShortOption{-ip} &
+\begin{OptionTableNoShorthand}{Coding structure parameters}{tab:coding-structure}
+\Option{IntraPeriod (-ip)} &
+%\ShortOption{-ip} &
 \Default{$-1$} &
 Specifies the intra frame period.
 …
 \\
 \Option{DecodingRefreshType} &
 \ShortOption{-dr} &
+\Option{DecodingRefreshType (-dr)} &
+%\ShortOption{-dr} &
 \Default{0} &
 Specifies the type of decoding refresh to apply at the intra frame period
 …
 \par
 \begin{tabular}{cp{0.45\textwidth}}
+& Applies an I picture (not a clean random access point). \\
+& Applies a non-IDR clean random access point (open GOP). \\
+& Applies an IDR random access point (closed GOP). \\
+\end{tabular}
+\\
+\Option{GOPSize} &
+\ShortOption{-g} &
+& Applies an I picture (not a intra random access point). \\
+& Applies a CRA intra random access point (open GOP). \\
+& Applies an IDR intra random access point (closed GOP). \\
+& Use recovery point SEI messages to indicate random access. \\
+\end{tabular}
+\\
+\Option{GOPSize (-g)} &
+%\ShortOption{-g} &
 \Default{1} &
 Specifies the size of the cyclic GOP structure.
 …
 \Option{Frame\emph{N}} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{\NotSet} &
 Multiple options that define the cyclic GOP structure that will be used
 …
 See section~\ref{sec:gop-structure} for further details.
 \\
+\Option{ListCombination} &
+\ShortOption{-lc} &
+\Default{true} &
+Enables or disables the use of the combined reference list for uni-prediction
+in B-slices.
+\par
+\begin{tabular}{cp{0.45\textwidth}}
+& Reference list~0 and reference list~1 are identical and reference
+      list~0 is used as the combined reference list. \\
+& The combined reference list is derived from reference list~0 and
+      reference list~1. \\
+\end{tabular}
+NB: LComb can only be 0 in low delay coding (more precisely, when list 0
+and list 1 are the same)
+\\
+\end{OptionTable}
+\end{OptionTableNoShorthand}
 %%
 %% Motion estimation parameters
 %%
+\begin{OptionTable}{Motion estimation parameters}
+\begin{OptionTableNoShorthand}{Motion estimation parameters}{tab:motion-estimation}
 \Option{FastSearch} &
 \ShortOption{\None} &
 \Default{true} &
+%\ShortOption{\None} &
+\Default{1} &
 Enables or disables the use of a fast motion search.
 \par
 …
 & Full search method \\
 & Fast search method \\
+\end{tabular}
+\\
+\Option{SearchRange} &
+\ShortOption{-sr} &
+& Previous motion vector fast search method \\
+\end{tabular}
+\\
+\Option{SearchRange (-sr)} &
+%\ShortOption{-sr} &
 \Default{96} &
 Specifies the search range used for motion estimation.
 …
 \Option{BipredSearchRange} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{4} &
 Specifies the search range used for bi-prediction refinement in motion
 …
 \\
+\Option{ClipForBiPredMEEnabled} &
+%\ShortOption{\None} &
+\Default{0} &
+Enables clipping in the Bi-Pred ME, which prevents values over- or under-flowing. It is usually disabled to reduce encoder run-time.
+\\
+\Option{FastMEAssumingSmootherMVEnabled} &
+%\ShortOption{\None} &
+\Default{0} &
+Enables fast ME assuming a smoother MV.
+\\
 \Option{HadamardME} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{true} &
 Enables or disables the use of the Hadamard transform in fractional-pel motion
 …
 \Option{ASR} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{false} &
 Enables or disables the use of adaptive search ranges, where the motion
 …
 \end{displaymath}
 \\
+\end{OptionTable}
+\Option{MaxNumMergeCand} &
+%\ShortOption{\None} &
+\Default{5} &
+Specifies the maximum number of merge candidates to use.
+\\
+\Option{DisableIntraInInter} &
+%\ShortOption{\None} &
+\Default{0} &
+Flag to disable intra PUs in inter slices.
+\\
+\end{OptionTableNoShorthand}
 …
 %% Mode decision parameters
 %%
+\begin{OptionTable}{Mode decision parameters}
+\Option{LambdaModifier$N$} &
+\ShortOption{-LM$N$} &
+\begin{OptionTableNoShorthand}{Mode decision parameters}{tab:mode-decision}
+\Option{LambdaModifier$N$ (-LM$N$)} &
+%\ShortOption{-LM$N$} &
 \Default{1.0} &
 Specifies a value that is multiplied with the Lagrange multiplier
 …
 when encoding temporal layer~$N$.
 \par
+$N$ may be in the range 0--7.
+$N$ may be in the range 0 (inclusive) to 7 (exclusive).
+\\
+\Option{ECU} &
+%\ShortOption{\None} &
+\Default{false} &
+Enables or disables the use of early CU determination.  When enabled, skipped CUs will not be split further.
+\\
+\Option{CFM} &
+%\ShortOption{\None} &
+\Default{false} &
+Enables or disables the use of Cbf-based fast encoder mode.  When enabled, once a 2Nx2N CU has been evaluated, if the RootCbf is 0, further PU splits will not be evaluated.
+\\
+\Option{ESD} &
+%\ShortOption{\None} &
+\Default{false} &
+Enables or disables the use of early skip detection.  When enabled, the skip mode will be tested before any other.
 \\
 \Option{FEN} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{false} &
 Enables or disables the use of fast encoder mode.  When enabled,
 …
 \Option{FDM} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{true} &
 Enables or disables the use of fast encoder decisions for 2Nx2N merge
 …
 \Option{RDpenalty} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{0} &
 RD-penalty for 32x32 TU for intra in non-intra slices.
 …
 \\
 \end{OptionTable}
+\end{OptionTableNoShorthand}
 %%
 %% Quantization parameters
 %%
 \begin{OptionTable}{Quantization parameters}
 \Option{QP} &
 \ShortOption{-q} &
+\begin{OptionTableNoShorthand}{Quantization parameters}{tab:quantization}
+\Option{QP (-q)} &
+%\ShortOption{-q} &
 \Default{30.0} &
 Specifies the base value of the quantization parameter.
 \\
 \Option{CbQpOffset}%
 \Option{CrQpOffset} &
 \ShortOption{-cbqpofs}%
 \ShortOption{-crqpofs} &
+Specifies the base value of the quantization parameter. If it is non-integer, the QP is switched once during encoding.
+\\
+\Option{CbQpOffset (-cbqpofs)}%
+\Option{CrQpOffset (-crqpofs)} &
+%\ShortOption{-cbqpofs}%
+%\ShortOption{-crqpofs} &
 \Default{0}%
 \Default{0} &
 …
 \\
 \Option{MaxCuDQPDepth} &
 \ShortOption{\None} &
+\Option{MaxCuDQPDepth (-dqd)} &
+%\ShortOption{\None} &
 \Default{0} &
 Defines maximum depth of a minimum CuDQP for sub-LCU-level delta QP.
 …
 \Option{RDOQ} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{true} &
 Enables or disables rate-distortion-optimized quantization.
+Enables or disables rate-distortion-optimized quantization for transformed TUs.
 \\
 \Option{RDOQTS} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{true} &
 Enables or disables rate-distortion-optimized quantization for transform-skipped TUs.
 \\
+\Option{DeltaQpRD} &
+\ShortOption{-dqr} &
+\Option{SelectiveRDOQ} &
+%\ShortOption{\None} &
+\Default{false} &
+Enables or disables selective rate-distortion-optimized quantization.
+A simple quantization is use to pre-analyze, whether to bypass the RDOQ process or not.
+If all the coefficients are quantized to 0, the RDOQ process is bypassed.
+Otherwise, the RDOQ process is performed as usual.
+\\
+\Option{DeltaQpRD (-dqr)} &
+%\ShortOption{-dqr} &
 \Default{0} &
 Specifies the maximum QP offset at slice level for multi-pass slice
 …
 \\
 \Option{MaxDeltaQP} &
 \ShortOption{-d} &
+\Option{MaxDeltaQP (-d)} &
+%\ShortOption{-d} &
 \Default{0} &
 Specifies the maximum QP offset at the largest coding unit level for
 …
 \\
 \Option{dQPFile} &
 \ShortOption{-m} &
+\Option{dQPFile (-m)} &
+%\ShortOption{-m} &
 \Default{\NotSet} &
 Specifies a file containing a list of QP deltas. The $n$-th line
 …
 \\
+\Option{AdaptiveQpSelection} &
+\ShortOption{-aqps} &
+\Option{AdaptiveQp (-aq)} &
+%\ShortOption{-aq} &
+\Default{false} &
+Enable or disable QP adaptation based upon a psycho-visual model.
+\\
+\Option{MaxQPAdaptationRange (-aqr)} &
+%\ShortOption{-aqps} &
+\Default{6} &
+Specifies the maximum QP adaptation range.
+\\
+\Option{AdaptiveQpSelection (-aqps)} &
+%\ShortOption{-aqps} &
 \Default{false} &
 Specifies whether QP values for non-I frames will be calculated on the
 fly based on statistics of previously coded frames.
 \\
+\Option{RecalculateQPAccordingToLambda} &
+\ShortOption{\None} &
+\Option{RecalculateQP...} \Option{AccordingToLambda} &
+%\ShortOption{\None} &
 \Default{false} &
 Recalculate QP values according to lambda values. Do not suggest to be enabled in all intra case.
 \\
+\end{OptionTable}
+\Option{ScalingList} &
+%\ShortOption{\None} &
+\Default{0} &
+Controls the specification of scaling lists:
+\par
+\begin{tabular}{cp{0.45\textwidth}}
+& Scaling lists are disabled \\
+& Use default scaling lists \\
+& Scaling lists are specified in the file indicated by ScalingListFile \\
+\end{tabular}
+\\
+\Option{ScalingListFile} &
+%\ShortOption{\None} &
+\Default{\NotSet} &
+When ScalingList is set to 2, this parameter indicates the name of the file, which contains the defined scaling lists.
+If ScalingList is set to 2 and this parameter is an empty string, information on the format of the scaling list file
+is output and the encoder stops.
+\\
+\Option{MaxCUChromaQpAdjustmentDepth} &
+%\ShortOption{\None} &
+\Default{-1} &
+Specifies the maximum depth for CU chroma QP adjustment; if negative, CU chroma QP adjustment is disabled.
+\\
+\end{OptionTableNoShorthand}
 …
 %% Slice coding parameters
 %%
 \begin{OptionTable}{Slice coding parameters}
+\begin{OptionTableNoShorthand}{Slice coding parameters}{tab:slice-coding}
 %\Option{SliceGranularity} &
 %\ShortOption{\None} &
 …
 \Option{SliceMode} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{0} &
 Controls the slice partitioning method in conjunction with
 …
 \Option{SliceArgument} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{\NotSet} &
 Specifies the maximum number of CTUs, bytes or tiles in a slice depending on the
 …
 \Option{SliceSegmentMode} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{0} &
 Enables (dependent) slice segment coding in conjunction with
 …
 \Option{SliceSegmentArgument} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{\NotSet} &
 Defines the maximum number of CTUs, bytes or tiles a slice segment
 …
 \Option{WaveFrontSynchro} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{false} &
 Enables the use of specific CABAC probabilities synchronization at the
 …
 \\
+\Option{TileUniformSpacing} &
+%\ShortOption{\None} &
+\Default{false} &
+Controls the mode used to determine per row and column tile sizes.
+\par
+\begin{tabular}{cp{0.45\textwidth}}
+& Each tile column width and tile row height is explicitly set
+     by TileColumnWidthArray and TileRowHeightArray respectively \\
+& Tile columns and tile rows are uniformly spaced. \\
+\end{tabular}
+\\
 \Option{NumTileColumnsMinus1}%
 \Option{NumTileRowsMinus1} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{0} &
 Specifies the tile based picture partitioning geometry as
 …
 \\
+\Option{UniformSpacingIdc} &
+\ShortOption{\None} &
+\Default{0} &
+Controls the mode used to determine per row and column tile sizes.
+\par
+\begin{tabular}{cp{0.45\textwidth}}
+& Each tile column width and tile row height is explicitly set
+     by ColumnWidthArray and RowHeightArray respectively \\
+& Tile columns and tile rows are uniformly spaced. \\
+\end{tabular}
+\\
+\Option{ColumnWidthArray}%
+\Option{RowHeightArray} &
+\ShortOption{\None} &
+\Option{TileColumnWidthArray}%
+\Option{TileRowHeightArray} &
+%\ShortOption{\None} &
 \Default{\NotSet} &
 Specifies a space or comma separated list of widths and heights,
 …
 list corresponds to the leftmost tile column or topmost tile row.
 \\
 \end{OptionTable}
+\end{OptionTableNoShorthand}
 …
 %% Deblocking filter parameters
 %%
 \begin{OptionTable}{Deblocking filter parameters}
+\begin{OptionTableNoShorthand}{Deblocking filter parameters}{tab:deblocking-filter}
 \Option{LoopFilterDisable} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{false} &
 Enables or disables the in-loop deblocking filter.
 …
 \Option{LFCrossSliceBoundaryFlag} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{true} &
 Enables or disables the use of in-loop filtering across slice
 …
 \\
-\Option{DeblockingFilterControlPresent}&
-\ShortOption{\None}&
-\Default{false}&
-Enables or disables the presence of the deblocking filter control
-parameters in the picture parameter set and in the slice segment header.
-When disabled, the default deblocking filter parameters are used.
-\\
 \Option{LoopFilterOffsetInPPS}&
 \ShortOption{\None}&
+%\ShortOption{\None}&
 \Default{false}&
 If enabled, the in-loop deblocking filter control parameters are sent in PPS.
 …
 \Option{LoopFilterTcOffset_div2}&
 \ShortOption{\None}&
+%\ShortOption{\None}&
 \Default{0}&
 Specifies the base value for the in-loop deblocking filter parameter tc_offset_div2. The final value of tc_offset_div2
 …
 \Option{LoopFilterBetaOffset_div2}&
 \ShortOption{\None}&
+%\ShortOption{\None}&
 \Default{0}&
 Specifies the base value for the in-loop deblocking filter parameter beta_offset_div2. The final value of beta_offset_div2
 …
 \\
+\end{OptionTable}
+\Option{DeblockingFilterMetric}&
+%\ShortOption{\None}&
+\Default{false}&
+Enables or disables the use of a deblocking filter metric to evaluate the suitability of deblocking. If enabled then
+LoopFilterOffsetInPPS and LoopFilterDisable must be 0.
+\\
+\Option{LFCrossSliceBoundaryFlag}&
+%\ShortOption{\None}&
+\Default{true}&
+Enables or disables the use of a deblocking across tile boundaries.
+\\
+\end{OptionTableNoShorthand}
 …
 %% Coding tools parameters
 %%
+\begin{OptionTable}{Coding tools parameters}
+%\Option{ALF} &
+%\ShortOption{\None} &
+%\Default{true} &
+%Enables or disables the adaptive loop filter.
+%\\
+%\Option{ALFLowLatencyEncode} &
+%\ShortOption{\None} &
+%\Default{false} &
+%Specifies the operating mode (low latency or high efficiency) of the
+%adaptive loop filter.
+%\\
+\begin{OptionTableNoShorthand}{Coding tools parameters}{tab:coding-tools}
+\Option{AMP} &
+%\ShortOption{\None} &
+\Default{true} &
+Enables or disables the use of asymmetric motion partitions.
+\\
 \Option{SAO} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{true} &
 Enables or disables the sample adaptive offset (SAO) filter.
 \\
+\Option{TestSAODisableAtPictureLevel} &
+%\ShortOption{\None} &
+\Default{false} &
+Enables the testing of disabling SAO at the picture level after having analysed all blocks.
+\\
+\Option{SaoEncodingRate} &
+%\ShortOption{\None} &
+\Default{0.75} &
+When >0 SAO early picture termination is enabled for luma and chroma.
+\\
+\Option{SaoEncodingRateChroma} &
+%\ShortOption{\None} &
+\Default{0.5} &
+The SAO early picture termination rate to use for chroma (when m_SaoEncodingRate is >0). If <=0, use results for luma.
+\\
 \Option{SAOLcuBoundary} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{false} &
 Enables or disables SAO parameter estimation using non-deblocked pixels
 …
 \\
-%\Option{LMChroma} &
-%\ShortOption{\None} &
-%\Default{true} &
-%Enables or disables the intra chroma-from-luma prediction mode.
-%\\
-%\Option{NSQT} &
-%\ShortOption{\None} &
-%\Default{true} &
-%Enables or disables the non-square quadtree transform.
-%\\
 \Option{ConstrainedIntraPred} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{false} &
 Enables or disables constrained intra prediction.  Constrained intra
 …
 \\
+\Option{FastUDIUseMPMEnabled} &
+%\ShortOption{\None} &
+\Default{true} &
+If enabled, adapt intra direction search, accounting for MPM
+\\
+\Option{FastMEForGenBLowDelayEnabled} &
+%\ShortOption{\None} &
+\Default{true} &
+If enabled use a fast ME for generalised B Low Delay slices
+\\
+\Option{UseBLambdaForNonKeyLowDelayPictures} &
+%\ShortOption{\None} &
+\Default{true} &
+Enables use of B-Lambda for non-key low-delay pictures
+\\
 \Option{TransquantBypassEnableFlag} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{false} &
 Enables or disables the ability to bypass the transform,
 …
 \Option{CUTransquantBypassFlagForce} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{0} &
 Controls the per CU transformation, quantization and filtering
 …
 \Option{PCMEnabledFlag} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{false} &
 Enables or disables the use of PCM. The encoder will use cost measures on a CU-by-CU basis to determine if PCM mode is to be applied.
 …
 \Option{PCMLog2MaxSize} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{5 \\ ($= \mathrm{log}_2(32)$)} &
 Specifies log2 of the maximum PCM block size. When PCM is enabled, the
 …
 \Option{PCMLog2MinSize} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{3} &
 Specifies log2 of the minimum PCM block size. When PCM is enabled, the
 …
 \Option{PCMInputBitDepthFlag} &
 \ShortOption{\None} &
 \Default{1} &
+%\ShortOption{\None} &
+\Default{true} &
 If enabled specifies that PCM sample bit-depth is set equal to
 InputBitDepth. Otherwise, it specifies that PCM sample bit-depth is set
 …
 \Option{PCMFilterDisableFlag} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{false} &
 If enabled specifies that loop-filtering on reconstructed samples of PCM
 …
 \\
 \Option{WeightedPredP} &
 \ShortOption{-wpP} &
+\Option{WeightedPredP (-wpP)} &
+%\ShortOption{-wpP} &
 \Default{false} &
 Enables the use of weighted prediction in P slices.
 \\
 \Option{WeightedPredB} &
 \ShortOption{-wpB} &
+\Option{WeightedPredB (-wpB)} &
+%\ShortOption{-wpB} &
 \Default{false} &
 Enables the use of weighted prediction in B slices.
 \\
+\Option{SignHideFlag} &
+\ShortOption{-SBH} &
+\Option{Log2ParallelMergeLevel} &
+%\ShortOption{\None} &
+\Default{2} &
+Defines the PPS-derived Log2ParMrgLevel variable.
+\\
+\Option{SignHideFlag (-SBH)} &
+%\ShortOption{-SBH} &
 \Default{true} &
 If enabled specifies that for each 4x4 coefficient group for which the
 …
 \\
 \Option{StrongIntraSmoothing} &
 \ShortOption{-sis} &
+\Option{StrongIntraSmoothing (-sis)} &
+%\ShortOption{-sis} &
 \Default{true} &
 If enabled specifies that for 32x32 intra prediction block, the intra smoothing
 …
 \Option{TMVPMode} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{1} &
 Controls the temporal motion vector prediction mode.
 …
 \Option{TransformSkip} &
+\ShortOption{\None} &
+\Default{false} &
+Enables or disables transform-skipping mode decision for 4x4 TUs
+\footnote{Enables transform_skip_enabled and per 4x4 TU tests}.
+%\ShortOption{\None} &
+\Default{false} &
+Enables or disables transform-skipping mode decision.
 \\
 \Option{TransformSkipFast} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{false} &
 Enables or disables reduced testing of the transform-skipping mode
 …
 This option has no effect if TransformSkip is disabled.
 \\
 \end{OptionTable}
+\end{OptionTableNoShorthand}
 %%
 %% Rate control parameters
 %%
+\begin{OptionTable}{Rate control parameters}
+\begin{OptionTableNoShorthand}{Rate control parameters}{tab:rate-control}
 \Option{RateControl} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{false} &
 Rate control: enables rate control or not.
 …
 \Option{TargetBitrate} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{0} &
 Rate control: target bitrate, in bps.
 …
 \Option{KeepHierarchicalBit} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{0} &
 Rate control: 0: equal bit allocation among pictures;
 …
 \Option{LCULevelRateControl} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{true} &
 Rate control: true: LCU level RC; false: picture level RC.
 …
 \Option{RCLCUSeparateModel} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{true} &
 Rate control: use LCU level separate R-lambda model or not.
 …
 \Option{InitialQP} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{0} &
 Rate control: initial QP value for the first picture.
 …
 \Option{RCForceIntraQP} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{false} &
 Rate control: force intra QP to be equal to initial QP or not.
 \\
 \end{OptionTable}
+\end{OptionTableNoShorthand}
 %%
 %% VUI parameters
 %%
+\begin{OptionTable}{VUI parameters}
+\Option{VuiParametersPresent} &
+\ShortOption{-vui} &
+\begin{OptionTableNoShorthand}{VUI parameters}{tab:VUI}
+\Option{VuiParametersPresent (-vui)} &
 \Default{false} &
 Enable generation of vui_parameters().
 \\
 \Option{AspectRatioInfoPresent} &
-\ShortOption{} &
 \Default{false} &
 Signals whether aspect_ratio_idc is present.
 \\
 \Option{AspectRatioIdc} &
-\ShortOption{} &
 \Default{0} &
 aspect_ratio_idc
 \\
 \Option{SarWidth} &
-\ShortOption{} &
 \Default{0} &
 Specifies the horizontal size of the sample aspect ratio.
 \\
 \Option{SarHeight} &
-\ShortOption{} &
 \Default{0} &
 Specifies the vertical size of the sample aspect ratio.
 \\
 \Option{OverscanInfoPresent} &
-\ShortOption{} &
 \Default{false} &
 Signals whether overscan_info_present_flag is present.
 \\
 \Option{OverscanAppropriate} &
-\ShortOption{} &
 \Default{false} &
 Indicates whether cropped decoded pictures are suitable for display using overscan.
 …
 \\
 \Option{VideoSignalTypePresent} &
-\ShortOption{} &
 \Default{false} &
 Signals whether video_format, video_full_range_flag, and colour_description_present_flag are present.
 \\
 \Option{VideoFormat} &
-\ShortOption{} &
 \Default{5} &
 Indicates representation of pictures.
 \\
 \Option{VideoFullRange} &
-\ShortOption{} &
 \Default{false} &
 Indicates the black level and range of luma and chroma signals.
 …
 \\
 \Option{ColourDescriptionPresent} &
-\ShortOption{} &
 \Default{false} &
 Signals whether colour_primaries, transfer_characteristics and matrix_coefficients are present.
 \\
 \Option{ColourPrimaries} &
-\ShortOption{} &
 \Default{2} &
 Indicates chromaticity coordinates of the source primaries.
 \\
 \Option{TransferCharateristics} &
-\ShortOption{} &
 \Default{2} &
 Indicates the opto-electronic transfer characteristics of the source.
 \\
 \Option{MatrixCoefficients} &
-\ShortOption{} &
 \Default{2} &
 Describes the matrix coefficients used in deriving luma and chroma from RGB primaries.
 \\
 \Option{ChromaLocInfoPresent} &
-\ShortOption{} &
 \Default{false} &
 Signals whether chroma_sample_loc_type_top_field and chroma_sample_loc_type_bottom_field are present.
 \\
 \Option{ChromaSampleLocTypeTopField} &
-\ShortOption{} &
 \Default{0} &
 Specifies the location of chroma samples for top field.
 \\
 \Option{ChromaSampleLocTypeBottomField} &
-\ShortOption{} &
 \Default{0} &
 Specifies the location of chroma samples for bottom field.
 \\
 \Option{NeutralChromaIndication} &
-\ShortOption{} &
 \Default{false} &
 Indicates that the value of all decoded chroma samples is equal to 1<<(BitDepthCr-1).
 …
 \Option{DefaultDisplayWindowFlag} &
+\ShortOption{\None} &
+\Default{0} &
+\Default{flag} &
 Indicates the presence of the Default Window parameters.
 \par
 \begin{tabular}{cp{0.45\textwidth}}
 & Disabled \\
 & Enabled \\
+false & Disabled \\
+true & Enabled \\
 \end{tabular}
 \\
 …
 \Option{DefDispWinTopOffset}%
 \Option{DefDispWinBottomOffset} &
-\ShortOption{\None} &
 \Default{0} &
 Specifies the horizontal and vertical offset to be applied to the
 …
 \\
+\Option{FrameFieldInfoPresentFlag} &
+\Default{false} &
+Specificies the value of the VUI syntax element `frame_field_info_present_flag', which indicates that pic_struct and field coding related values are present in picture timing SEI messages.
+\\
+\Option{PocProportionalToTimingFlag} &
+\Default{false} &
+Specificies the value of the VUI syntax element `vui_poc_proportional_to_timing_flag', which indicates that the POC value is proportional to the output time with respect to the first picture in the CVS.
+\\
+\Option{NumTicksPocDiffOneMinus} &
+\Default{0} &
+Specificies the value of the VUI syntax element `vui_num_ticks_poc_diff_one_minus1', which specifies the number of clock ticks corresponding to a difference of picture order count values equal to 1, and is used only when PocProportionalToTimingFlag is true.
+\\
 \Option{BitstreamRestriction} &
-\ShortOption{} &
 \Default{false} &
 Signals whether bitstream restriction parameters are present.
 \\
 \Option{TilesFixedStructure} &
-\ShortOption{} &
 \Default{false} &
 Indicates that each active picture parameter set has the same values of the syntax elements related to tiles.
 \\
 \Option{MotionVectorsOverPicBoundaries} &
-\ShortOption{} &
 \Default{false} &
 Indicates that no samples outside the picture boundaries are used for inter prediction.
 \\
 \Option{MaxBytesPerPicDenom} &
-\ShortOption{} &
 \Default{2} &
 Indicates a number of bytes not exceeded by the sum of the sizes of the VCL NAL units associated with any coded picture.
 \\
 \Option{MaxBitsPerMinCuDenom} &
-\ShortOption{} &
 \Default{1} &
 Indicates an upper bound for the number of bits of coding_unit() data.
 \\
 \Option{Log2MaxMvLengthHorizontal} &
-\ShortOption{} &
 \Default{15} &
 Indicate the maximum absolute value of a decoded horizontal MV component in quarter-pel luma units.
 \\
 \Option{Log2MaxMvLengthVertical} &
-\ShortOption{} &
 \Default{15} &
 Indicate the maximum absolute value of a decoded vertical MV component in quarter-pel luma units.
 \\
+\end{OptionTable}
+\end{OptionTableNoShorthand}
+\begin{OptionTableNoShorthand}{Range Extensions (Version 2) tool parameters}{tab:rext-tools}
+\Option{CostMode} &
+\Default{lossy} &
+Specifies the cost mode to use.
+\par
+\begin{tabular}{lp{0.3\textwidth}}
+  lossy                   & $cost=distortion+\lambda \times bits$ \\
+  sequence_level_lossless & $cost=distortion / \lambda + bits$. \\
+  lossless                & As with sequence_level_lossless, but QP is also set to 0 (this will be deprecated in the future) \\
+  mixed_lossless_lossy    & As with sequence_level_lossless, but QP'=4 is used for pre-estimates of transquant-bypass blocks \\
+\end{tabular}
+\\
+\Option{ExtendedPrecision} &
+\Default{false} &
+Specifies the use of extended_precision_processing flag. Note that unless the HIGH_BIT_DEPTH_SUPPORT macro in TypeDef.h is enabled, all internal bit depths must be 8 when the ExtendedPrecision setting is enabled.
+This setting is only valid for the 16-bit RExt profiles.
+\\
+\Option{HighPrecisionPredictionWeighting} &
+\Default{false} &
+Specifies the value of high_precision_prediction_weighting_flag. This setting is only valid for the 16-bit or 4:4:4 RExt profiles.
+\\
+\Option{CrossComponentPrediction} &
+\Default{false} &
+When true, specifies the use of the cross component prediction tool (4:4:4 processing only). Version 1 and some Version 2 (RExt) profiles require this to be false.
+\\
+\Option{ReconBasedCrossCPredictionEstimate} &
+\Default{false} &
+If true, then when determining the alpha value for cross-component prediction, use the reconstructed residual rather than the pre-transform encoder-side residual
+\\
+\Option{SaoLumaOffsetBitShift}
+\Option{SaoChromaOffsetBitShift}&
+\Default{0}
+\Default{0} &
+Specifies the shift to apply to the SAO parameters. If negative, an estimate will be calculated based upon the initial QP. Version 1 and some Version 2 (RExt) profiles require this to be 0.
+\\
+\Option{TransformSkipLog2MaxSize} &
+\Default{2} &
+Specifies the maximum TU size for which transform-skip can be used; the minimum value is 2. Version 1 and some Version 2 (RExt) profiles require this to be 2.
+\\
+\Option{ImplicitResidualDPCM} &
+\Default{false} &
+When true, specifies the use of the implicitly signalled residual RDPCM tool (for intra). Version 1 and some Version 2 (RExt) profiles require this to be false.
+\\
+\Option{ExplicitResidualDPCM} &
+\Default{false} &
+When true, specifies the use of the explicitly signalled residual RDPCM tool (for intra-block-copy and inter). Version 1 and some Version 2 (RExt) profiles require this to be false.
+\\
+\Option{ResidualRotation} &
+\Default{false} &
+When true, specifies the use of the residual rotation tool. Version 1 and some Version 2 (RExt) profiles require this to be false.
+\\
+\Option{SingleSignificanceMapContext} &
+\Default{false} &
+When true, specifies the use of a single significance map context for transform-skipped and transquant-bypassed TUs. Version 1 and some Version 2 (RExt) profiles require this to be false.
+\\
+\Option{GolombRiceParameterAdaptation} &
+\Default{false} &
+When true, enable the adaptation of the Golomb-Rice parameter over the course of each slice. Version 1 and some Version 2 (RExt) profiles require this to be false.
+\\
+\Option{AlignCABACBeforeBypass} &
+\Default{false} &
+When true, align the CABAC engine to a defined fraction of a bit prior to coding bypass data (including sign bits) when coeff_abs_level_remaining syntax elements are present in the group.
+This must always be true for the high-throughput-RExt profile, and false otherwise.
+\\
+\Option{IntraReferenceSmoothing} &
+\Default{true} &
+When true, enable intra reference smoothing, otherwise disable it. Version 1 and some Version 2 (RExt) profiles require this to be true.
+\\
+\end{OptionTableNoShorthand}
+\subsection{Encoder SEI parameters}
+The table below lists the SEI messages defined for Version 1 and Range-Extensions, and if available, the respective table that lists the controls within the HM Encoder to include the messages within the bit stream.
+\begin{SEIListTable}{List of Version 1 and RExt SEI messages}
+& Buffering period                         & Table \ref{tab:sei-buffering-period} \\
+& Picture timing                           & Table \ref{tab:sei-picture-timing} \\
+& Pan-scan rectangle                       & (Not handled)\\
+& Filler payload                           & (Not handled)\\
+& User data registered by Rec. ITU-T T.35  & (Not handled)\\
+& User data unregistered                   & Decoded only\\
+& Recovery point                           & Table \ref{tab:sei-recovery-point} \\
+& Scene information                        & (Not handled)\\
+& Picture snapshot                         & (Not handled)\\
+& Progressive refinement segment start     & (Not handled)\\
+& Progressive refinement segment end       & (Not handled)\\
+& Film grain characteristics               & (Not handled)\\
+& Post-filter hint                         & (Not handled)\\
+& Tone mapping information                 & Table \ref{tab:sei-tone-mapping-info} \\
+& Frame packing arrangement                & Table \ref{tab:sei-frame-packing-arrangement} \\
+& Display orientation                      & Table \ref{tab:sei-display-orientation} \\
+& Structure of pictures information        & Table \ref{tab:sei-sop-info} \\
+& Active parameter sets                    & Table \ref{tab:sei-active-parameter-sets} \\
+& Decoding unit information                & Table \ref{tab:sei-decoding-unit-info} \\
+& Temporal sub-layer zero index            & Table \ref{tab:sei-temporal-level-0} \\
+& Decoded picture hash                     & Table \ref{tab:sei-decoded-picture-hash} \\
+& Scalable nesting                         & Table \ref{tab:sei-scalable-nesting} \\
+& Region refresh information               & Table \ref{tab:sei-region-refresh-info} \\
+& No display                               & Table \ref{tab:sei-no-display} \\
+& Time code                                & Table \ref{tab:sei-time-code} \\
+& Mastering display colour volume          & Table \ref{tab:sei-mastering-display-colour-volume} \\
+& Segmented rectangular frame packing arrangement & Table \ref{tab:sei-seg-rect-fpa}\\
+& Temporal motion-constrained tile sets    & Table \ref{tab:sei-tmcts} \\
+& Chroma resampling filter hint            & Table \ref{tab:chroma-resampling-filter-hint} \\
+& Knee function information                & Table \ref{tab:sei-knee-function} \\
+& Colour remapping information             & (Not handled)\\
+& Deinterlaced field identification        & (Not handled)\\
+\end{SEIListTable}
 %%
 %% SEI messages
 %%
+\begin{OptionTable}{SEI messages}
+\begin{OptionTableNoShorthand}{Buffering period SEI message encoder parameters}{tab:sei-buffering-period}
+\Option{SEIBufferingPeriod} &
+\Default{0} &
+Enables or disables the insertion of the Buffering period
+SEI messages. This option has no effect if VuiParametersPresent is disabled.
+SEIBufferingPeriod requires SEIActiveParameterSets to be enabled.
+\\
+\end{OptionTableNoShorthand}
+\begin{OptionTableNoShorthand}{Picture timing SEI message encoder parameters}{tab:sei-picture-timing}
+\Option{SEIPictureTiming} &
+\Default{0} &
+Enables or disables the insertion of the Picture timing
+SEI messages. This option has no effect if VuiParametersPresent is disabled.
+\\
+\end{OptionTableNoShorthand}
+\begin{OptionTableNoShorthand}{Recovery point SEI message encoder parameters}{tab:sei-recovery-point}
+\Option{SEIRecoveryPoint} &
+\Default{0} &
+Enables or disables the insertion of the Recovery point
+SEI messages.
+\\
+\end{OptionTableNoShorthand}
+\begin{OptionTableNoShorthand}{Tone mapping information SEI message encoder parameters}{tab:sei-tone-mapping-info}
+\Option{SEIToneMappingInfo} &
+\Default{0} &
+Enables or disables the insertion of the Tone Mapping SEI message.
+\\
+\Option{SEIToneMapId} &
+\Default{0} &
+Specifies Id of Tone Mapping SEI message for a given session.
+\\
+\Option{SEIToneMapCancelFlag} &
+\Default{false} &
+Indicates that Tone Mapping SEI message cancels the persistance or follows.
+\\
+\Option{SEIToneMapPersistenceFlag} &
+\Default{true} &
+Specifies the persistence of the Tone Mapping SEI message.
+\\
+\Option{SEIToneMapCodedDataBitDepth} &
+\Default{8} &
+Specifies Coded Data BitDepth of Tone Mapping SEI messages.
+\\
+\Option{SEIToneMapTargetBitDepth} &
+\Default{8} &
+Specifies Output BitDepth of Tome mapping function.
+\\
+\Option{SEIToneMapModelId} &
+\Default{0} &
+Specifies Model utilized for mapping coded data into
+target_bit_depth range.
+\par
+\begin{tabular}{cp{0.35\textwidth}}
+& linear mapping with clipping \\
+& sigmoidal mapping \\
+& user-defined table mapping \\
+& piece-wise linear mapping \\
+& luminance dynamic range mapping \\
+\end{tabular}
+\\
+\Option{SEIToneMapMinValue} &
+\Default{0} &
+Specifies the minimum value in mode 0.
+\\
+\Option{SEIToneMapMaxValue} &
+\Default{1023} &
+Specifies the maxmum value in mode 0.
+\\
+\Option{SEIToneMapSigmoidMidpoint} &
+\Default{512} &
+Specifies the centre point in mode 1.
+\\
+\Option{SEIToneMapSigmoidWidth} &
+\Default{960} &
+Specifies the distance between 5% and 95% values of
+the target_bit_depth in mode 1.
+\\
+\Option{SEIToneMapStartOfCodedInterval} &
+\Default{\None} &
+Array of user-defined mapping table.
+Default table can be set to the following:
+\par
+\begin{tabular}{cp{0.35\textwidth}}
+12 24 36 48 60 72 84 96 108 120 132 144 156 168 180
+\\
+192 196 204 208 216 220 228 232 240 248 252 260 264
+\\
+276 284 292 292 296 300 304 308 312 320 324 328 332
+\\
+344 348 352 356 360 368 372 376 380 384 388 396 400
+\\
+408 412 420 424 428 432 436 444 444 444 448 452 456
+\\
+464 468 472 476 476 480 484 488 492 496 500 504 508
+\\
+512 516 520 524 528 532 536 540 540 544 548 552 556
+\\
+564 568 572 572 576 580 584 588 592 596 600 604 604
+\\
+612 616 620 624 628 632 636 636 640 644 648 652 656
+\\
+664 668 672 672 672 676 680 680 684 688 692 692 696
+\\
+704 704 708 712 716 716 720 724 724 728 732 736 736
+\\
+744 748 748 752 756 760 760 764 768 768 772 776 780
+\\
+784 788 792 792 796 800 804 804 808 812 812 816 820
+\\
+824 828 832 836 836 840 844 848 848 852 856 860 860
+\\
+864 864 868 872 872 876 880 880 884 884 888 892 892
+\\
+900 900 904 908 908 912 912 916 920 920 924 928 928
+\\
+936 936 940 940 944 948 948 952 956 956 960 964 964
+\\
+968 972 976 976 980 984 984 988 992 992 996 996 1000
+\\
+1004 1008 1012 1012 1016 1020 1024
+\\
+\end{tabular}
+\\
+\Option{SEIToneMapNumPivots} &
+\Default{0} &
+Specifies the number of pivot points in mode 3.
+\\
+\Option{SEIToneMapCodedPivotValue} &
+\Default{\None} &
+Array of coded pivot point in mode 3.
+A suggested table is:
+\par
+\begin{tabular}{cp{0.45\textwidth}}
+128 256 512 768
+\end{tabular}
+\\
+\Option{SEIToneMapTargetPivotValue} &
+\Default{\None} &
+Array of target pivot point in mode 3.
+A suggested table is:
+\par
+\begin{tabular}{cp{0.45\textwidth}}
+73 111 168 215
+\end{tabular}
+\\
+\Option{SEIToneMap...} \Option{CameraIsoSpeedIdc} &
+\Default{0} &
+Indicates the camera ISO speed for daylight illumination.
+\\
+\Option{SEIToneMap...} \Option{CameraIsoSpeedValue} &
+\Default{400} &
+Specifies the camera ISO speed for daylight illumination of Extended_ISO.
+\\
+\Option{SEIToneMap...} \Option{ExposureIndexIdc} &
+\Default{0} &
+Indicates the exposure index setting of the camera.
+\\
+\Option{SEIToneMap...} \Option{ExposureIndexValue} &
+\Default{400} &
+Specifies the exposure index setting of the cameran of Extended_ISO.
+\\
+\Option{SEIToneMapExposure...} \Option{CompensationValueSignFlag} &
+\Default{0} &
+Specifies the sign of ExposureCompensationValue.
+\\
+\Option{SEIToneMapExposure...} \Option{CompensationValueNumerator} &
+\Default{0} &
+Specifies the numerator of ExposureCompensationValue.
+\\
+\Option{SEIToneMapExposure...} \Option{CompensationValueDenomIdc} &
+\Default{2} &
+Specifies the denominator of ExposureCompensationValue.
+\\
+\Option{SEIToneMapRef...} \Option{ScreenLuminanceWhite} &
+\Default{350} &
+Specifies reference screen brightness setting in units of candela per square metre.
+\\
+\Option{SEIToneMapExtended...} \Option{RangeWhiteLevel} &
+\Default{800} &
+Indicates the luminance dynamic range.
+\\
+\Option{SEIToneMapNominal...} \Option{BlackLevelLumaCodeValue} &
+\Default{16} &
+Specifies luma sample value of the nominal black level assigned decoded pictures.
+\\
+\Option{SEIToneMapNominal...} \Option{WhiteLevelLumaCodeValue} &
+\Default{235} &
+Specifies luma sample value of the nominal white level assigned decoded pictures.
+\\
+\Option{SEIToneMapExtended...} \Option{WhiteLevelLumaCodeValue} &
+\Default{300} &
+Specifies luma sample value of the extended dynamic range assigned decoded pictures.
+\\
+\end{OptionTableNoShorthand}
+\begin{OptionTableNoShorthand}{Frame packing arrangement SEI message encoder parameters}{tab:sei-frame-packing-arrangement}
+\Option{SEIFramePacking} &
+\Default{0} &
+Enables or disables the insertion of the Frame packing arrangement SEI messages.
+\\
+\Option{SEIFramePackingType} &
+\Default{0} &
+Indicates the arrangement type in the Frame packing arrangement SEI message.
+This option has no effect if SEIFramePacking is disabled.
+\par
+\begin{tabular}{cp{0.35\textwidth}}
+& Side by Side \\
+& Top Bottom \\
+& Frame Alternate \\
+\end{tabular}
+\\
+\Option{SEIFramePackingInterpretation} &
+\Default{0} &
+Indicates the constituent frames relationship in the Frame packing arrangement SEI message.
+This option has no effect if SEIFramePacking is disabled.
+\par
+\begin{tabular}{cp{0.35\textwidth}}
+& Unspecified \\
+& Frame 0 is associated with the left view of a stereo pair \\
+& Frame 0 is associated with the right view of a stereo pair \\
+\end{tabular}
+\\
+\Option{SEIFramePackingQuincunx} &
+\Default{0} &
+Enables or disables the quincunx_sampling signalling in the
+Frame packing arrangement SEI messages. This option has no
+effect if SEIFramePacking is disabled.
+\\
+\Option{SEIFramePackingId} &
+\Default{0} &
+Indicates the session number in the Frame packing arrangement
+SEI messages. This option has no effect if SEIFramePacking is
+disabled.
+\\
+\end{OptionTableNoShorthand}
+\begin{OptionTableNoShorthand}{Display orientation SEI message encoder parameters}{tab:sei-display-orientation}
+\Option{SEIDisplayOrientation} &
+\Default{0} &
+Enables or disables the insertion of the Display orientation
+SEI messages.
+\par
+\begin{tabular}{cp{0.20\textwidth}}
+& Disabled \\
+  N: $0 < N < (2^{16} - 1)$ & Enable display orientation SEI message with
+  \mbox{anticlockwise_rotation = N}
+  and \mbox{display_orientation_repetition_period = 1} \\
+\end{tabular}
+\\
+\end{OptionTableNoShorthand}
+\begin{OptionTableNoShorthand}{Structure of pictures information SEI message encoder parameters}{tab:sei-sop-info}
+\Option{SEISOPDescription} &
+\Default{0} &
+Enables or disables the insertion of the Structure of pictures information SEI messages.
+\\
+\end{OptionTableNoShorthand}
+\begin{OptionTableNoShorthand}{Active parameter sets SEI message encoder parameters}{tab:sei-active-parameter-sets}
+\Option{SEIActiveParameterSets} &
+\Default{0} &
+Enables or disables the insertion of the Active parameter sets
+SEI messages.
+\\
+\end{OptionTableNoShorthand}
+\begin{OptionTableNoShorthand}{Decoding unit information SEI message encoder parameters}{tab:sei-decoding-unit-info}
+\Option{SEIDecodingUnitInfo} &
+\Default{0} &
+Enables or disables the insertion of the Decoding unit information
+SEI messages. This option has no effect if VuiParametersPresent is disabled.
+\\
+\end{OptionTableNoShorthand}
+\begin{OptionTableNoShorthand}{Temporal sub-layer zero index SEI message encoder parameters}{tab:sei-temporal-level-0}
+\Option{SEITemporalLevel0Index} &
+\Default{0} &
+Enables or disables the insertion of the Temporal level zero index
+SEI messages.
+\\
+\end{OptionTableNoShorthand}
+\begin{OptionTableNoShorthand}{Decoded picture hash SEI message encoder parameters}{tab:sei-decoded-picture-hash}
 \Option{SEIDecodedPictureHash} &
-\ShortOption{\None} &
 \Default{0} &
 Enables or disables the calculation and insertion of the Decoded picture hash
 SEI messages.
 \par
 \begin{tabular}{cp{0.45\textwidth}}
+\begin{tabular}{cp{0.35\textwidth}}
 & Disabled \\
 & Transmits MD5 in SEI message and writes the value to the encoder
 …
 \end{tabular}
 \\
+\Option{SEIpictureDigest} &
+\ShortOption{\None} &
+\Default{0} &
+Deprecated alias for SEIDecodedPictureHash.
+Do not use anymore.
+\\
+\Option{SEIRecoveryPoint} &
+\ShortOption{\None} &
+\Default{0} &
+Enables or disables the insertion of the Recovery point
+SEI messages.
+\\
+\Option{SEIActiveParameterSets} &
+\ShortOption{\None} &
+\Default{0} &
+Enables or disables the insertion of the Active parameter sets
+SEI messages.
+\\
+\Option{SEIBufferingPeriod} &
+\ShortOption{\None} &
+\Default{0} &
+Enables or disables the insertion of the Buffering period
+SEI messages. This option has no effect if VuiParametersPresent is disabled.
+SEIBufferingPeriod requires SEIActiveParameterSets to be enabled.
+\\
+\Option{SEIPictureTiming} &
+\ShortOption{\None} &
+\Default{0} &
+Enables or disables the insertion of the Picture timing
+SEI messages. This option has no effect if VuiParametersPresent is disabled.
+\\
+\Option{SEIDecodingUnitInfo} &
+\ShortOption{\None} &
+\Default{0} &
+Enables or disables the insertion of the Decoding unit information
+SEI messages. This option has no effect if VuiParametersPresent is disabled.
+\\
+\end{OptionTableNoShorthand}
+\begin{OptionTableNoShorthand}{Scalable nesting SEI message encoder parameters}{tab:sei-scalable-nesting}
+\Option{SEIScalableNesting} &
+\Default{0} &
+Enables or disables the use of the scalable nesting SEI messages.
+\\
+\end{OptionTableNoShorthand}
+\begin{OptionTableNoShorthand}{Region refresh information SEI message encoder parameters}{tab:sei-region-refresh-info}
 \Option{SEIGradualDecodingRefreshInfo} &
-\ShortOption{\None} &
 \Default{0} &
 Enables or disables the insertion of the Gradual decoding refresh information
 SEI messages.
 \\
+\Option{SEITemporalLevel0Index} &
+\ShortOption{\None} &
+\Default{0} &
+Enables or disables the insertion of the Temporal level zero index
+SEI messages.
+\\
+\Option{SEIDisplayOrientation} &
+\ShortOption{\None} &
+\Default{0} &
+Enables or disables the insertion of the Display orientation
+SEI messages.
+\par
+\begin{tabular}{cp{0.30\textwidth}}
+& Disabled \\
+  N: $0 < N < (2^{16} - 1)$ & Enable display orientation SEI message with
+  \mbox{anticlockwise_rotation = N}
+  and \mbox{display_orientation_repetition_period = 1} \\
+\end{tabular}
+\\
+\Option{SEIFramePacking} &
+\ShortOption{\None} &
+\Default{0} &
+Enables or disables the insertion of the Frame packing arrangement SEI messages.
+\\
+\Option{SEIFramePackingType} &
+\ShortOption{\None} &
+\Default{0} &
+Indicates the arrangement type in the Frame packing arrangement SEI message.
+This option has no effect if SEIFramePacking is disabled.
+\end{OptionTableNoShorthand}
+\begin{OptionTableNoShorthand}{No display SEI message encoder parameters}{tab:sei-no-display}
+\Option{SEINoDisplay} &
+\Default{0} &
+When non-zero, generate no-display SEI message for temporal layer N or higher.
+\\
+\end{OptionTableNoShorthand}
+\begin{OptionTableNoShorthand}{Time code SEI message encoder parameters}{tab:sei-time-code}
+\Option{SEITimeCodeEnabled} &
+\Default{false} &
+When true (non-zero), generate Time code SEI messages.
+\\
+\Option{SEITimeCodeNumClockTs} &
+\Default{0} &
+Number of clock time sets, in the range of 0 to 3 (inclusive).
+\\
+\Option{SEITimeCodeTimeStampFlag} &
+\Default{\None} &
+Time stamp flag associated to each time set (comma or space separated list of entries).
+\\
+\Option{SEITimeCodeFieldBasedFlag} &
+\Default{\None} &
+Field based flag associated to each time set (comma or space separated list of entries).
+\\
+\Option{SEITimeCodeCountingType} &
+\Default{\None} &
+Counting type associated to each time set (comma or space separated list of entries).
+\\
+\Option{SEITimeCodeFullTsFlag} &
+\Default{\None} &
+Full time stamp flag associated to each time set (comma or space separated list of entries).
+\\
+\Option{SEITimeCodeDiscontinuityFlag} &
+\Default{\None} &
+Discontinuity flag associated to each time set (comma or space separated list of entries).
+\\
+\Option{SEITimeCodeCntDroppedFlag} &
+\Default{\None} &
+Counter dropped flag associated to each time set (comma or space separated list of entries).
+\\
+\Option{SEITimeCodeNumFrames} &
+\Default{\None} &
+Number of frames associated to each time set (comma or space separated list of entries).
+\\
+\Option{SEITimeCodeSecondsFlag} &
+\Default{\None} &
+Flag to signal seconds value presence in each time set (comma or space separated list of entries).
+\\
+\Option{SEITimeCodeMinutesFlag} &
+\Default{\None} &
+Flag to signal minutes value presence in each time set (comma or space separated list of entries).
+\\
+\Option{SEITimeCodeHoursFlag} &
+\Default{\None} &
+Flag to signal hours value presence in each time set (comma or space separated list of entries).
+\\
+\Option{SEITimeCodeSecondsValue} &
+\Default{\None} &
+Seconds value for each time set (comma or space separated list of entries).
+\\
+\Option{SEITimeCodeMinutesValue} &
+\Default{\None} &
+Minutes value for each time set (comma or space separated list of entries).
+\\
+\Option{SEITimeCodeHoursValue} &
+\Default{\None} &
+Hours value for each time set (comma or space separated list of entries).
+\\
+\Option{SEITimeCodeOffsetLength} &
+\Default{\None} &
+Time offset length associated to each time set (comma or space separated list of entries).
+\\
+\Option{SEITimeCodeTimeOffset} &
+\Default{\None} &
+Time offset associated to each time set (comma or space separated list of entries).
+\\
+\end{OptionTableNoShorthand}
+\begin{OptionTableNoShorthand}{Mastering display colour volume SEI message encoder parameters}{tab:sei-mastering-display-colour-volume}
+\Option{SEIMasteringDisplayColourVolume} &
+\Default{false} &
+When true (non-zero), generate Mastering display colour volume SEI message.
+\\
+\Option{SEIMasteringDisplayMaxLuminance} &
+\Default{10000} &
+Specifies the mastering display maximum luminance value in units of 1/10000 candela per square metre.
+\\
+\Option{SEIMasteringDisplayMinLuminance} &
+\Default{0} &
+Specifies the mastering display minimum luminance value in units of 1/10000 candela per square metre.
+\\
+\Option{SEIMasteringDisplayPrimaries} &
+\Default{0,50000, 0,0, 50000,0} &
+Mastering display primaries for all three colour planes in CIE xy coordinates in increments of 1/50000 (results in the ranges 0 to 50000 inclusive).
+\\
+\Option{SEIMasteringDisplayWhitePoint} &
+\Default{16667, 16667} &
+Mastering display white point CIE xy coordinates in normalized increments of 1/50000 (e.g. 0.333 = 16667).
+\\
+\end{OptionTableNoShorthand}
+\begin{OptionTableNoShorthand}{Segmented rectangular frame packing arrangement SEI message encoder parameters}{tab:sei-seg-rect-fpa}
+\Option{SEISegmentedRectFramePacking} &
+\Default{0} &
+Controls generation of segmented rectangular frame packing SEI messages.
+\\
+\Option{SEISegmentedRectFramePackingCancel} &
+\Default{false} &
+If true, cancels the persistence of any previous SRFPA SEI message.
+\\
+\Option{SEISegmentedRectFramePackingType} &
+\Default{0} &
+Specifies the arrangement of the frames in the reconstructed picture.
+\\
+\Option{SEISegmentedRectFramePackingPersistence} &
+\Default{false} &
+If false the SEI applies to the current frame only.
+\\
+\end{OptionTableNoShorthand}
+\begin{OptionTableNoShorthand}{Temporal motion-constrained tile sets SEI message encoder parameters}{tab:sei-tmcts}
+\Option{SEITempMotionConstrainedTileSets} &
+\Default{false} &
+When true (non-zero), generates example temporal motion constrained tile sets SEI messages.
+\\
+\end{OptionTableNoShorthand}
+\begin{OptionTableNoShorthand}{Chroma resampling filter hint SEI message encoder parameters}{tab:chroma-resampling-filter-hint}
+\Option{SEIChromaSamplingFilterHint} &
+\Default{false} &
+When true (non-zero), generates example chroma sampling filter hint SEI messages.
+\\
+\Option{SEIChromaSamplingHorizontalFilterType} &
+\Default{2} &
+Defines the index of the chroma sampling horizontal filter:
+\par
+\begin{tabular}{cp{0.35\textwidth}}
+& Unspecified \\
+& Filters signalled within the SEI message \\
+& Filters as described by SMPTE RP 2050-1:2012\\
+\end{tabular}
+\\
+\Option{SEIChromaSamplingVerticalFilterType} &
+\Default{2} &
+Defines the index of the chroma sampling vertical filter:
+\par
+\begin{tabular}{cp{0.35\textwidth}}
+& Unspecified \\
+& Filters signalled within the SEI message \\
+& Filters as described in the 5/3 filter description of ITU-T Rec. T.800 | ISO/IEC 15444-1\\
+\end{tabular}
+\\
+\end{OptionTableNoShorthand}
+\begin{OptionTableNoShorthand}{Knee function SEI message encoder parameters}{tab:sei-knee-function}
+\Option{SEIKneeFunctionInfo} &
+\Default{false} &
+Enables (true) or disables (false) the insertion of the Knee function SEI messages.
+\\
+\Option{SEIKneeFunctionId} &
+\Default{0} &
+Specifies Id of Knee function SEI message for a given session.
+\\
+\Option{SEIKneeFunctionCancelFlag} &
+\Default{false} &
+Indicates that Knee function SEI message cancels the persistance (true) or follows (false).
+\\
+\Option{SEIKneeFunctionPersistenceFlag} &
+\Default{true} &
+Specifies the persistence of the Knee function SEI message.
+\\
+\Option{SEIKneeFunctionInputDrange} &
+\Default{1000} &
+Specifies the peak luminance level for the input picture of Knee function SEI messages.
+\\
+\Option{SEIKneeFunctionInputDispLuminance} &
+\Default{100} &
+Specifies the expected display brightness for the input picture of Knee function SEI messages.
+\\
+\Option{SEIKneeFunctionOutputDrange} &
+\Default{4000} &
+Specifies the peak luminance level for the output picture of Knee function SEI messages.
+\\
+\Option{SEIKneeFunctionOutputDispLuminance} &
+\Default{800} &
+Specifies the expected display brightness for the output picture of Knee function SEI messages.
+\\
+\Option{SEIKneeFunctionNumKneePointsMinus1} &
+\Default{2} &
+Specifies the number of knee points - 1.
+\\
+\Option{SEIKneeFunctionInputKneePointValue} &
+\Default{} &
+Array of input knee point. Default table can be set to the following:
 \par
 \begin{tabular}{cp{0.45\textwidth}}
+& Side by Side \\
+& Top Bottom \\
+& Frame Alternate \\
+\end{tabular}
+\\
+\Option{SEIFramePackingInterpretation} &
+\ShortOption{\None} &
+\Default{0} &
+Indicates the constituent frames relationship in the Frame packing arrangement SEI message.
+This option has no effect if SEIFramePacking is disabled.
+800 900
+\end{tabular}
+\\
+\Option{SEIKneeFunctionOutputKneePointValue} &
+\Default{} &
+Array of output knee point. Default table can be set to the following:
 \par
 \begin{tabular}{cp{0.45\textwidth}}
+& Unspecified \\
+& Frame 0 is associated with the left view of a stereo pair \\
+& Frame 0 is associated with the right view of a stereo pair \\
+\end{tabular}
+\\
+\Option{SEIFramePackingQuincunx} &
+\ShortOption{\None} &
+\Default{0} &
+Enables or disables the quincunx_sampling signalling in the
+Frame packing arrangement SEI messages. This option has no
+effect if SEIFramePacking is disabled.
+\\
+\Option{SEIFramePackingId} &
+\ShortOption{\None} &
+\Default{0} &
+Indicates the session number in the Frame packing arrangement
+SEI messages. This option has no effect if SEIFramePacking is
+disabled.
+\\
+\Option{SEIToneMappingInfo} &
+\ShortOption{\None} &
+\Default{0} &
+Enables or disables the insertion of the Tone Mapping SEI message.
+\\
+\Option{SEIToneMapId} &
+\ShortOption{\None} &
+\Default{0} &
+Specifies Id of Tone Mapping SEI message for a given session.
+\\
+\Option{SEIToneMapCancelFlag} &
+\ShortOption{\None} &
+\Default{0} &
+Indicates that Tone Mapping SEI message cancels the persistance or follows.
+\\
+\Option{SEIToneMapPersistenceFlag} &
+\ShortOption{\None} &
+\Default{1} &
+Specifies the persistence of the Tone Mapping SEI message.
+\\
+\Option{SEIToneMapCodedDataBitDepth} &
+\ShortOption{\None} &
+\Default{10} &
+Specifies Coded Data BitDepth of Tone Mapping SEI messages.
+\\
+\Option{SEIToneMapTargetBitDepth} &
+\ShortOption{\None} &
+\Default{8} &
+Specifies Output BitDepth of Tome mapping function.
+\\
+\Option{SEIToneMapModelId} &
+\ShortOption{\None} &
+\Default{0} &
+Specifies Model utilized for mapping coded data into
+target_bit_depth range.
+\par
+\begin{tabular}{cp{0.45\textwidth}}
+& linear mapping with clipping \\
+& sigmoidal mapping \\
+& user-defined table mapping \\
+& piece-wise linear mapping \\
+& luminance dynamic range mapping \\
+\end{tabular}
+\\
+\Option{SEIToneMapMinValue} &
+\ShortOption{\None} &
+\Default{0} &
+Specifies the minimum value in mode 0.
+\\
+\Option{SEIToneMapMaxValue} &
+\ShortOption{\None} &
+\Default{1023} &
+Specifies the maxmum value in mode 0.
+\\
+\Option{SEIToneMapSigmoidMidpoint} &
+\ShortOption{\None} &
+\Default{512} &
+Specifies the centre point in mode 1.
+\\
+\Option{SEIToneMapSigmoidWidth} &
+\ShortOption{\None} &
+\Default{960} &
+Specifies the distance between 5% and 95% values of
+the target_bit_depth in mode 1.
+\\
+\Option{SEIToneMapStartOfCodedInterval} &
+\ShortOption{\None} &
+\Default{\None} &
+Array of user-defined mapping table.
+Default table can be set to the following:
+\par
+\begin{tabular}{cp{0.45\textwidth}}
+12 24 36 48 60 72 84 96 108 120 132 144 156 168 180
+192 196 204 208 216 220 228 232 240 248 252 260 264
+276 284 292 292 296 300 304 308 312 320 324 328 332
+344 348 352 356 360 368 372 376 380 384 388 396 400
+408 412 420 424 428 432 436 444 444 444 448 452 456
+464 468 472 476 476 480 484 488 492 496 500 504 508
+512 516 520 524 528 532 536 540 540 544 548 552 556
+564 568 572 572 576 580 584 588 592 596 600 604 604
+612 616 620 624 628 632 636 636 640 644 648 652 656
+664 668 672 672 672 676 680 680 684 688 692 692 696
+704 704 708 712 716 716 720 724 724 728 732 736 736
+744 748 748 752 756 760 760 764 768 768 772 776 780
+784 788 792 792 796 800 804 804 808 812 812 816 820
+824 828 832 836 836 840 844 848 848 852 856 860 860
+864 864 868 872 872 876 880 880 884 884 888 892 892
+900 900 904 908 908 912 912 916 920 920 924 928 928
+936 936 940 940 944 948 948 952 956 956 960 964 964
+968 972 976 976 980 984 984 988 992 992 996 996 1000
+1004 1008 1012 1012 1016 1020 1024
+\end{tabular}
+\\
+\Option{SEIToneMapNumPivots} &
+\ShortOption{\None} &
+\Default{5} &
+Specifies the number of pivot points in mode 3.
+\\
+\Option{SEIToneMapCodedPivotValue} &
+\ShortOption{\None} &
+\Default{\None} &
+Array of coded pivot point in mode 3.
+Default table can be set to the following:
+\par
+\begin{tabular}{cp{0.45\textwidth}}
+128 256 512 768
+\end{tabular}
+\\
+\Option{SEIToneMapTargetPivotValue} &
+\ShortOption{\None} &
+\Default{\None} &
+Array of target pivot point in mode 3.
+Default table can be set to the following:
+\par
+\begin{tabular}{cp{0.45\textwidth}}
+73 111 168 215
+\end{tabular}
+\\
+\Option{SEIToneMapCameraIsoSpeedIdc} &
+\ShortOption{\None} &
+\Default{0} &
+Indicates the camera ISO speed for daylight illumination.
+\\
+\Option{SEIToneMapCameraIsoSpeedValue} &
+\ShortOption{\None} &
+\Default{400} &
+Specifies the camera ISO speed for daylight illumination of Extended_ISO.
+\\
+\Option{SEIToneMapExposureIndexIdc} &
+\ShortOption{\None} &
+\Default{0} &
+Indicates the exposure index setting of the camera.
+\\
+\Option{SEIToneMapExposureIndexValue} &
+\ShortOption{\None} &
+\Default{400} &
+Specifies the exposure index setting of the cameran of Extended_ISO.
+\\
+\Option{SEIToneMapExposureCompensationValueSignFlag} &
+\ShortOption{\None} &
+\Default{0} &
+Specifies the sign of ExposureCompensationValue.
+\\
+\Option{SEIToneMapExposureCompensationValueNumerator} &
+\ShortOption{\None} &
+\Default{0} &
+Specifies the numerator of ExposureCompensationValue.
+\\
+\Option{SEIToneMapExposureCompensationValueDenomIdc} &
+\ShortOption{\None} &
+\Default{2} &
+Specifies the denominator of ExposureCompensationValue.
+\\
+\Option{SEIToneMapRefScreenLuminanceWhite} &
+\ShortOption{\None} &
+\Default{350} &
+Specifies reference screen brightness setting in units of candela per square metre.
+\\
+\Option{SEIToneMapExtendedRangeWhiteLevel} &
+\ShortOption{\None} &
+\Default{800} &
+Indicates the luminance dynamic range.
+\\
+\Option{SEIToneMapNominalBlackLevelLumaCodeValue} &
+\ShortOption{\None} &
+\Default{16} &
+Specifies luma sample value of the nominal black level assigned decoded pictures.
+\\
+\Option{SEIToneMapNominalWhiteLevelLumaCodeValue} &
+\ShortOption{\None} &
+\Default{235} &
+Specifies luma sample value of the nominal white level assigned decoded pictures.
+\\
+\Option{SEIToneMapExtendedWhiteLevelLumaCodeValue} &
+\ShortOption{\None} &
+\Default{300} &
+Specifies luma sample value of the extended dynamic range assigned decoded pictures.
+\\
+\end{OptionTable}
+250 450
+\end{tabular}
+\\
+\end{OptionTableNoShorthand}
+%\Option{SEITimeCode} &
+%\Default{false} &
+%When true, generate time code SEI messages.
+%\\
 %%
 …
 \\
-HB_LAMBDA_FOR_LDC &
-on &
-use of B-style lambda for non-key pictures in low-delay mode
-\\
-GPB_SIMPLE &
-on &
-Fast estimation of generalized B in low-delay mode
-\\
-GPB_SIMPLE_UNI &
-on &
-Fast estimation of generalized B in low-delay mode for uni-direction
-\\
-FASTME_SMOOTHER_MV &
-on &
-Fast ME using smoother MV assumption
-\\
 ADAPT_SR_SCALE &
 on &
 …
 \\
-CLIP_TO_709_RANGE &
-off &
-\\
 EARLY_SKIP_THRES &
 .5 &
 …
 \url{source/Lib/TLibCommon/TypeDef.h}.
 %%
 %%
 …
 \clearpage
 \section{Using the decoder}
+\subsection{General}
 \begin{verbatim}
 TAppDecoder -b str.bin -o dec.yuv [options]
 \end{verbatim}
 \begin{OptionTable}{Decoder options}
 \Option{} &
 \ShortOption{-h} &
+\begin{OptionTableNoShorthand}{Decoder options}{tab:decoder-options}
+\Option{(--help)} &
+%\ShortOption{\None} &
 \Default{\None} &
 Prints usage information.
 \\
 \Option{} &
 \ShortOption{-o} &
+\Option{BitStreamFile (-b)} &
+%\ShortOption{-b} &
 \Default{\NotSet} &
+Defines reconstructed YUV file name.
+\\
+\Option{} &
+\ShortOption{-s} &
+Defines the input bit stream file name.
+\\
+\Option{ReconFile (-o)} &
+%\ShortOption{-o} &
+\Default{\NotSet} &
+Defines reconstructed YUV file name. If empty, no file is generated.
+\\
+\Option{SkipFrames (-s)} &
+%\ShortOption{-s} &
 \Default{0} &
 Defines the number of pictures in decoding order to skip.
 \\
+\Option{OutputBitDepth} &
+\ShortOption{-d} &
+\Option{MaxTemporalLayer (-t)} &
+%\ShortOption{-t} &
+\Default{-1} &
+Defines the maximum temporal layer to be decoded. If -1, then all layers are decoded.
+\\
+\Option{TarDecLayerIdSetFile (-l)} &
+%\ShortOption{-t} &
+\Default{\NotSet} &
+Specifies the targetDecLayerIdSet file name. The file would contain white-space separated LayerId values of the layers that are to be decoded.
+Omitting the parameter, or using a value of -1 in the file decodes all layers.
+\\
+\Option{OutputBitDepth (-d)} &
+%\ShortOption{-d} &
 \Default{0 \\ (Native)} &
 Specifies the luma bit-depth of the reconstructed YUV file (the value 0 indicates
 …
 \Option{OutputBitDepthC} &
 \ShortOption{\None} &
+%\ShortOption{\None} &
 \Default{0 \\ (Native)} &
 Defines the chroma bit-depth of the reconstructed YUV file (the value 0 indicates
 …
 \\
 \Option{SEIPictureDigest} &
 \ShortOption{\None} &
+\Option{SEIDecodedPictureHash} &
+%\ShortOption{\None} &
 \Default{1} &
 Enable or disable verification of any Picture hash SEI messages. When
 …
 \begin{itemize}
 \item
   If Picture hash SEI messages are included in the bitstream, the same type
+  If Picture hash SEI messages are included in the bit stream, the same type
   of hash is calculated for each decoded picture and written to the
   log together with an indication whether the calculted value matches
 …
 \\
+\Option{RespectDefDispWindow} &
+\ShortOption{-w} &
+\Option{OutputDecodedSEIMessagesFilename} &
+%\ShortOption{\None} &
+\Default{\NotSet} &
+When a non-empty file name is specified, information regarding any decoded SEI messages will be output to the indicated file. If the file name is '-', then stdout is used instead.
+\\
+\Option{RespectDefDispWindow (-w)} &
+%\ShortOption{-w} &
 \Default{0} &
 Video region to be output by the decoder.
 …
 \\
+\end{OptionTable}
+\Option{OutputColourSpaceConvert} &
+\Default{\NotSet} &
+Specifies the colour space conversion to apply to 444 video. Permitted values are:
+\par
+\begin{tabular}{lp{0.45\textwidth}}
+  UNCHANGED   & No colour space conversion is applied \\
+  YCrCbToYCbCr & Swap the second and third components \\
+  GBRtoRGB     & Reorder the three components \\
+\end{tabular}
+If no value is specified, no colour space conversion is applied. The list may eventually also include RGB to YCbCr or YCgCo conversions.\\
+\\
+\Option{SEINoDisplay} &
+\Default{false} &
+When true, do not output frames for which there is an SEI NoDisplay message.
+\\
+\Option{ClipOutputVideoToRec709Range} &
+%\ShortOption{\None} &
+\Default{0} &
+If 1 then clip output video to the Rec. 709 Range on saving when OutputBitDepth is less than InternalBitDepth.
+\\
+\end{OptionTableNoShorthand}
+\subsection{Using the decoder analyser}
+If the decoder is compiled with the macro RExt__DECODER_DEBUG_BIT_STATISTICS defined as 1 (either externally, or by editing TypeDef.h), the decoder will gather fractional bit counts associated with the different syntax elements, producing a table of the number of bits per syntax element, and where appropriate, according to block size and colour component/channel.
+The Linux makefile will compile both the analyser and standard version when the `all' or `everything' target is used (where the latter will also build  high-bit-depth executables).

Note: See TracChangeset for help on using the changeset viewer.

JCT-3V 3D-HEVC

Context navigation

Changeset 1313 in 3DVCSoftware for trunk/doc

Legend:

trunk/doc/Doxyfile

trunk/doc/mainpage.h

trunk/doc/software-manual.tex

Download in other formats: