From 366f50351f1520f82cff93a1954a14f110a34c34 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Wed, 26 Jun 2024 15:44:47 -0400 Subject: [PATCH] docs(src): add examples alias and general cleanup --- docs/Doxyfile | 14 +- docs/Doxyfile-1.10.0-default | 2894 +++++++++++++++++++++ docs/source/conf.py | 7 + docs/source/source_code/source_code.rst | 106 +- src/audio.h | 22 +- src/config.cpp | 104 +- src/config.h | 12 +- src/confighttp.cpp | 4 +- src/entry_handler.cpp | 115 +- src/entry_handler.h | 125 +- src/file_handler.cpp | 33 +- src/file_handler.h | 38 +- src/input.cpp | 65 +- src/logging.cpp | 23 +- src/main.cpp | 14 +- src/network.cpp | 41 +- src/network.h | 24 +- src/nvhttp.cpp | 28 +- src/nvhttp.h | 2 +- src/platform/common.h | 114 +- src/platform/linux/graphics.cpp | 6 +- src/platform/linux/input/legacy_input.cpp | 90 +- src/platform/linux/misc.cpp | 10 +- src/platform/linux/misc.h | 6 +- src/platform/linux/publish.cpp | 184 +- src/platform/linux/wayland.cpp | 2 +- src/platform/linux/wayland.h | 12 +- src/platform/macos/publish.cpp | 184 +- src/platform/windows/audio.cpp | 13 +- src/platform/windows/display.h | 12 +- src/platform/windows/display_vram.cpp | 4 +- src/platform/windows/display_wgc.cpp | 2 +- src/platform/windows/misc.cpp | 16 +- src/platform/windows/misc.h | 4 +- src/process.cpp | 2 +- src/process.h | 6 +- src/rtsp.cpp | 18 +- src/stream.cpp | 8 +- src/stream.h | 8 +- src/system_tray.cpp | 2 +- src/task_pool.h | 2 +- src/upnp.cpp | 2 +- src/utility.h | 2 +- src/video.cpp | 48 +- src/video.h | 12 +- tools/audio.cpp | 2 +- tools/ddprobe.cpp | 2 +- 47 files changed, 3638 insertions(+), 806 deletions(-) create mode 100644 docs/Doxyfile-1.10.0-default diff --git a/docs/Doxyfile b/docs/Doxyfile index 281b84291d6..f987656d046 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -24,9 +24,11 @@ # must be first DOXYFILE_ENCODING = UTF-8 -# https://breathe.readthedocs.io/en/latest/markups.html#aliases -ALIASES = "rst=^^\verbatim embed:rst:leading-asterisk^^" -ALIASES += "endrst=\endverbatim" +ALIASES = "" +ALIASES += "examples=^^**Examples**^^@code{.cpp}" +ALIASES += "examples_end=@endcode^^" +ALIASES += "rst=^^\verbatim embed:rst:leading-asterisk^^" +ALIASES += "rst_end=\endverbatim" DISABLE_INDEX = NO DOCBOOK_OUTPUT = doxydocbook @@ -79,4 +81,10 @@ WARN_AS_ERROR = FAIL_ON_WARNINGS # TODO: Enable this when we have complete documentation WARN_IF_UNDOCUMENTED = NO +WARN_IF_DOC_ERROR = YES +WARN_IF_INCOMPLETE_DOC = YES +WARN_IF_UNDOC_ENUM_VAL = YES +WARN_NO_PARAMDOC = YES +WARNINGS = YES + XML_OUTPUT = doxyxml diff --git a/docs/Doxyfile-1.10.0-default b/docs/Doxyfile-1.10.0-default new file mode 100644 index 00000000000..c539dbeee7d --- /dev/null +++ b/docs/Doxyfile-1.10.0-default @@ -0,0 +1,2894 @@ +# Doxyfile 1.10.0 + +# This file describes the settings to be used by the documentation system +# 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 (\" \"). +# +# Note: +# +# Use doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# 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 +# https://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 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 = "My Project" + +# 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 = + +# 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 = + +# With the PROJECT_ICON tag one can specify an icon that is included in the tabs +# when the HTML document is shown. Doxygen will copy the logo to the output +# directory. + +PROJECT_ICON = + +# 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 up to 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. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + +# 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, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, 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, 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, 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 and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + 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 +# 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 +# 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, 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 + +# 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 = + +# 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-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 JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = 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 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 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 + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# 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. +# 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. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# 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:^^" +# 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:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +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. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# 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. 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. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = 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, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, 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). 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. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +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 https://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 the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to +# generate identifiers for the Markdown headings. Note: Every identifier is +# unique. +# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a +# sequence number starting at 0 and GITHUB use the lower case version of title +# with any whitespace replaced by '-' and punctuation characters removed. +# The default value is: DOXYGEN. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_ID_STYLE = DOXYGEN + +# 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 = NO + +# 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 (see: +# https://www.riverbankcomputing.com/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 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 +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# 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). +# +# 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 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 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 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 + +# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +# If the TIMESTAMP tag is set different from NO then each generated page will +# contain the date or date and time when the page was generated. Setting this to +# NO can help when comparing the output of multiple runs. +# Possible values are: YES, NO, DATETIME and DATE. +# The default value is: NO. + +TIMESTAMP = NO + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# 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 = NO + +# 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 = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# 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 = NO + +# 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. 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 namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# 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, these classes will be included in the various overviews. This option +# will also hide undocumented C++ concepts if enabled. 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 +# 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, 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 then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. + +CASE_SENSE_NAMES = SYSTEM + +# 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 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_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# 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 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 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 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 +# 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 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 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 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. +# 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 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 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 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 default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# 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 +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = 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 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. 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. See also section "Changing the +# layout of pages" for information. +# +# 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 https://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 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 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 the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# 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 parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about +# undocumented enumeration values. If set to NO, doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not +# write the warning messages in between other messages but write them at the end +# of a run, in case a WARN_LOGFILE is defined the warning messages will be +# besides being in the defined file also be shown at the end of a run, unless +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case +# the behavior will remain as with the setting FAIL_ON_WARNINGS. +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. +# The default value is: NO. + +WARN_AS_ERROR = 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) +# See also: WARN_LINE_FORMAT +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + +# 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). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# 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. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = + +# 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: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding +# "INPUT_ENCODING" for further information on supported encodings. + +INPUT_FILE_ENCODING = + +# 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. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, +# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, +# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, +# *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to +# be provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cxxm \ + *.cpp \ + *.cppm \ + *.ccm \ + *.c++ \ + *.c++m \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.ixx \ + *.l \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# 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 = NO + +# 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/* + +EXCLUDE_PATTERNS = + +# 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, +# ANamespace::AClass, 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. + +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. +# 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 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. +# +# Note that doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +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. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +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 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 = + +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + +#--------------------------------------------------------------------------- +# 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 = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# multi-line macros, enums or list initialized variables directly into the +# documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# 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 +# entity 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. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# 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 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 https://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 configuration 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 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 + +# 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 +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS +# tag is set to YES then doxygen will add the directory of each input to the +# include path. +# The default value is: YES. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_ADD_INC_PATHS = YES + +# 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 = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the directory containing a file called compile_commands.json. This +# file is the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the +# options used when the source files were built. This is equivalent to +# specifying the -p option to a clang tool, such as clang-check. These options +# will then be passed to the parser. Any options specified with CLANG_OPTIONS +# will be added as well. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# 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 + +# 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. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. +# 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. +# 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). +# 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 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). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. 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 tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generate light mode output, DARK always +# generate dark mode output, AUTO_LIGHT automatically set the mode according to +# the user preference, use light mode if no preference is set (the default), +# AUTO_DARK automatically set the mode according to the user preference, use +# dark mode if no preference is set and TOGGLE allow to user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + +# 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 color-wheel, see +# https://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 gray-scales 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. +# 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_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = 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. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be +# dynamically folded and expanded in the generated HTML source code. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_CODE_FOLDING = YES + +# If the HTML_COPY_CLIPBOARD tag is set to YES then doxygen will show an icon in +# the top right corner of code and text fragments that allows the user to copy +# its content to the clipboard. Note this only works if supported by the browser +# and the web page is served via a secure context (see: +# https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file: +# protocol. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COPY_CLIPBOARD = YES + +# Doxygen stores a couple of settings persistently in the browser (via e.g. +# cookies). By default these settings apply to all HTML pages generated by +# doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store +# the settings under a project specific key, such that the user preferences will +# be stored separately. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_PROJECT_COOKIE = + +# 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: +# https://developer.apple.com/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 https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# 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" + +# This tag determines the URL 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. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# 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 + +# 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 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 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 +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# 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 + +# 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. +# 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 main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# 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 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 + +# The SITEMAP_URL tag is used to specify the full URL of the place where the +# generated documentation will be placed on the server by the user during the +# deployment of the documentation. The generated sitemap is called sitemap.xml +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL +# is specified no sitemap is generated. For information about the sitemap +# protocol see https://www.sitemaps.org +# This tag requires that the tag GENERATE_HTML is set to YES. + +SITEMAP_URL = + +# 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. +# 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: +# https://doc.qt.io/archives/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 Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/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 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: +# https://doc.qt.io/archives/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: +# https://doc.qt.io/archives/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: +# https://doc.qt.io/archives/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 (absolute path +# including file name) 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. 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 + +# 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 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 (see "Fine-tuning the output"). 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 + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = 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 + +# 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 + +# 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 + +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# 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 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://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 + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) 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 https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# 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/v2.7-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 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 + +# 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: +# https://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: +# https://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 = YES + +# 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. +# +# Note that when not enabling USE_PDFLATEX the default is latex when enabling +# USE_PDFLATEX the default is pdflatex and when in the later case latex is +# chosen this is overwritten by pdflatex. For specific output languages the +# default can have been set differently, this depends on the implementation of +# the output language. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_CMD_NAME = + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate +# index for LaTeX. +# Note: This tag is used in the Makefile / make.bat. +# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file +# (.tex). +# The default file is: makeindex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +MAKEINDEX_CMD_NAME = makeindex + +# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to +# generate index for LaTeX. In case there is no backslash (\) as first character +# it will be automatically added in the LaTeX code. +# Note: This tag is used in the generated output file (.tex). +# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. +# The default value is: makeindex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_MAKEINDEX_CMD = 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. +# 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 (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 used to specify one or more LaTeX package names +# that should be included in the LaTeX output. The package can be specified just +# by its name or with the correct syntax as to be used with the LaTeX +# \usepackage command. To get the times font for instance you can specify : +# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} +# To use the option intlimits with the amsmath package you can specify: +# EXTRA_PACKAGES=[intlimits]{amsmath} +# 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 user-defined 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. It +# is highly recommended to start with a default header using +# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty +# and then modify the file new_header.tex. See also section "Doxygen usage" for +# information on how to generate the default header that doxygen normally uses. +# +# Note: Only use a user-defined header if you know what you are doing! +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. The following +# commands have a special meaning inside the header (and footer): For a +# description of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a user-defined 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. See also section "Doxygen +# usage" for information on how to generate the default footer that doxygen +# normally uses. 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, doxygen will use the engine as +# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX +# files. Set this option to YES, to get a higher quality PDF documentation. +# +# See also section LATEX_CMD_NAME for selecting the engine. +# The default value is: YES. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +USE_PDFLATEX = YES + +# The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error. +# Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch +# mode nothing is printed on the terminal, errors are scrolled as if <return> is +# hit at every error; missing files that TeX tries to input or request from +# keyboard input (\read on a not open input stream) cause the job to abort, +# NON_STOP In nonstop mode the diagnostic message will appear on the terminal, +# but there is no possibility of user interaction just like in batch mode, +# SCROLL In scroll mode, TeX will stop only for missing files to input or if +# keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at +# each error, asking for user intervention. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_BATCHMODE = NO + +# 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 + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. See +# https://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 + +# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) +# path from which the emoji images will be read. If a relative path is entered, +# it will be relative to the LATEX_OUTPUT directory. If left blank the +# LATEX_OUTPUT directory will be used. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EMOJI_DIRECTORY = + +#--------------------------------------------------------------------------- +# 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. +# 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. +# 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 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 +# configuration 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 configuration 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 = + +#--------------------------------------------------------------------------- +# 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. 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. 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 + +# 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. +# 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. +# The default directory is: xml. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_OUTPUT = xml + +# 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 + +# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include +# namespace members in file scope as well, matching the HTML output. +# The default value is: NO. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_NS_MEMB_FILE_SCOPE = NO + +#--------------------------------------------------------------------------- +# 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 + +#--------------------------------------------------------------------------- +# Configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an +# AutoGen Definitions (see https://autogen.sourceforge.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 Sqlite3 output +#--------------------------------------------------------------------------- + +# If the GENERATE_SQLITE3 tag is set to YES doxygen will generate a Sqlite3 +# database with symbols found by doxygen stored in tables. +# The default value is: NO. + +GENERATE_SQLITE3 = NO + +# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database 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: sqlite3. +# This tag requires that the tag GENERATE_SQLITE3 is set to YES. + +SQLITE3_OUTPUT = sqlite3 + +# The SQLITE3_RECREATE_DB tag is set to YES, the existing doxygen_sqlite3.db +# database file will be recreated with each doxygen run. If set to NO, doxygen +# will warn if a database file is already found and not modify it. +# The default value is: YES. +# This tag requires that the tag GENERATE_SQLITE3 is set to YES. + +SQLITE3_RECREATE_DB = YES + +#--------------------------------------------------------------------------- +# 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. +# 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. +# 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. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# 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 = NO + +# 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. Note that the INCLUDE_PATH is not recursive, so the setting of +# RECURSIVE has no effect here. +# This tag requires that the tag SEARCH_INCLUDES is set to YES. + +INCLUDE_PATH = + +# 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 classes and namespaces +# will be listed in the class and namespace 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 topic 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 + +#--------------------------------------------------------------------------- +# Configuration options related to diagram generator tools +#--------------------------------------------------------------------------- + +# 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: +# https://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 = NO + +# 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 + +# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of +# subgraphs. When you want a differently looking font in the dot files that +# doxygen generates you can specify fontname, fontcolor and fontsize attributes. +# For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node, +# Edge and Graph Attributes specification</a> 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. Default graphviz fontsize is 14. +# The default value is: fontname=Helvetica,fontsize=10. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" + +# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can +# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a +# href=https://graphviz.org/doc/info/arrows.html>Complete documentation about +# arrows shapes.</a> +# The default value is: labelfontname=Helvetica,labelfontsize=10. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10" + +# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes +# around nodes set 'shape=plain' or 'shape=plaintext' <a +# href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a> +# The default value is: shape=box,height=0.2,width=0.4. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" + +# You can set the path where dot can find font specified with fontname in +# DOT_COMMON_ATTR and others dot attributes. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTPATH = + +# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will +# generate a graph for each documented class showing the direct and indirect +# inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and +# HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case +# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the +# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used. +# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance +# relations will be shown as texts / links. Explicit enabling an inheritance +# graph or choosing a different representation for an inheritance graph of a +# specific class, can be accomplished by means of the command \inheritancegraph. +# Disabling an inheritance graph can be accomplished by means of the command +# \hideinheritancegraph. +# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN. +# The default value is: 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. Explicit enabling a collaboration graph, +# when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the +# command \collaborationgraph. Disabling a collaboration graph can be +# accomplished by means of the command \hidecollaborationgraph. +# 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. Explicit enabling a group +# dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means +# of the command \groupgraph. Disabling a directory graph can be accomplished by +# means of the command \hidegroupgraph. See also the chapter Grouping in the +# manual. +# 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 UML_LOOK is set to YES. + +UML_LIMIT_NUM_FIELDS = 10 + +# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and +# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS +# tag is set to YES, doxygen will add type and arguments for attributes and +# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen +# will not generate fields with class member information in the UML graphs. The +# class diagrams will look similar to the default class diagrams but using UML +# notation for the relationships. +# Possible values are: NO, YES and NONE. +# The default value is: NO. +# This tag requires that the tag UML_LOOK is set to YES. + +DOT_UML_DETAILS = NO + +# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters +# to display on a single line. If the actual line length exceeds this threshold +# significantly it will be wrapped across multiple lines. Some heuristics are +# applied to avoid ugly line breaks. +# Minimum value: 0, maximum value: 1000, default value: 17. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_WRAP_THRESHOLD = 17 + +# 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. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO, +# can be accomplished by means of the command \includegraph. Disabling an +# include graph can be accomplished by means of the command \hideincludegraph. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +INCLUDE_GRAPH = YES + +# 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. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set +# to NO, can be accomplished by means of the command \includedbygraph. Disabling +# an included by graph can be accomplished by means of the command +# \hideincludedbygraph. +# 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 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. Disabling a call graph can be +# accomplished by means of the command \hidecallgraph. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +CALL_GRAPH = NO + +# 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. Disabling a caller graph can be +# accomplished by means of the command \hidecallergraph. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +CALLER_GRAPH = NO + +# 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 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. Explicit enabling a directory graph, when +# DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command +# \directorygraph. Disabling a directory graph can be accomplished by means of +# the command \hidedirectorygraph. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +DIRECTORY_GRAPH = YES + +# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels +# of child directories generated in directory dependency graphs by dot. +# Minimum value: 1, maximum value: 25, default value: 1. +# This tag requires that the tag DIRECTORY_GRAPH is set to YES. + +DIR_GRAPH_MAX_DEPTH = 1 + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. For an explanation of the image formats see the section +# output formats in the documentation of the dot tool (Graphviz (see: +# https://www.graphviz.org/)). +# 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, svg, png:gd, png:gd:gd, png:cairo, +# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and +# png:gdiplus:gdiplus. +# 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. +# 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 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. +# 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 = + +# 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 = + +# 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 or to the filename of jar file +# to be used. 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 PLANTUML_CFG_FILE tag can be used to specify a +# configuration file for plantuml. + +PLANTUML_CFG_FILE = + +# 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 = 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 +# 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_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 doxygen will generate a legend page +# explaining the meaning of the various boxes and arrows in the dot generated +# graphs. +# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal +# graphical representation for inheritance and collaboration diagrams is used. +# 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, doxygen will remove the intermediate +# files that are used to generate the various graphs. +# +# Note: This setting is not only used for dot files but also for msc temporary +# files. +# The default value is: YES. + +DOT_CLEANUP = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will +# use a built-in version of mscgen tool to produce the charts. Alternatively, +# the MSCGEN_TOOL tag can also specify the name an external tool. For instance, +# specifying prog as the value, doxygen will call the tool as prog -T +# <outfile_format> -o <outputfile> <inputfile>. The external tool should support +# output file formats "png", "eps", "svg", and "ismap". + +MSCGEN_TOOL = + +# 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 = diff --git a/docs/source/conf.py b/docs/source/conf.py index eb3845e65a5..8307055c0a0 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -7,6 +7,7 @@ # standard imports from datetime import datetime import os +import shutil import subprocess from typing import Mapping, Optional @@ -148,6 +149,12 @@ def _run_subprocess( exist_ok=True, ) +# remove existing html files +# doxygen builds will not re-generated if the html directory already exists +html_dir = os.path.join(source_dir, 'build', 'html') +if os.path.exists(html_dir): + shutil.rmtree(html_dir) + # run doxygen doxy_proc = _run_subprocess( args_list=[doxygen_cmd, 'Doxyfile'], diff --git a/docs/source/source_code/source_code.rst b/docs/source/source_code/source_code.rst index 467f331c768..18f975ed066 100644 --- a/docs/source/source_code/source_code.rst +++ b/docs/source/source_code/source_code.rst @@ -1,66 +1,76 @@ Source Code =========== We are in process of improving the source code documentation. Code should be documented using Doxygen syntax. -Some examples exist in `main.h` and `main.cpp`. In order for documentation within the code to appear in the -rendered docs, the definition of the object must be in a header file, although the documentation itself can (and -should) be in the source file. +Many examples exist throughout the codebase. -Example Documentation Blocks ----------------------------- +Source +------ +For generated docs, refer to the `Doxygen Documentation <../doxyhtml/index.html>`_. -**file.h** +Guidelines +---------- -.. code-block:: c +Doxygen Comments +^^^^^^^^^^^^^^^^ - // functions - int main(int argc, char *argv[]); +- Use Doxygen comments to document all functions, classes, and variables. +- `Inline documentation block <Inline Documentation Blocks>`_ should use the following format: -**file.cpp** (with markdown) + .. code-block:: cpp -.. code-block:: cpp + ///< A brief description of the member. + +- Multi-line comments, such as for a `documentation block <Documentation Blocks>`_, should use the following format: + + .. code-block:: cpp + + /** + * @brief A brief description of the member. + * More detailed description of the member. + */ - /** - * @brief Main application entry point. - * @param argc The number of arguments. - * @param argv The arguments. - * - * EXAMPLES: - * ```cpp - * main(1, const char* args[] = {"hello", "markdown", nullptr}); - * ``` - */ - int main(int argc, char *argv[]) { - // do stuff - } - -**file.cpp** (with ReStructuredText) + +Documentation Blocks +^^^^^^^^^^^^^^^^^^^^ +Documentation blocks should be placed above the declaration of the function, class, or variable. Below is an example +of a documentation block for the main function. .. code-block:: cpp - /** - * @brief Main application entry point. - * @param argc The number of arguments. - * @param argv The arguments. - * @rst - * EXAMPLES: - * - * .. code-block:: cpp - * main(1, const char* args[] = {"hello", "rst", nullptr}); - * @endrst - */ - int main(int argc, char *argv[]) { - // do stuff - } + /** + * @brief Main application entry point. + * @param argc The number of arguments. + * @param argv The arguments. + * @return The exit code. + * @examples + * main(1, const char* args[] = {"hello", "markdown", nullptr}); + * @end_examples + */ + int main(int argc, char *argv[]); -Source ------- +.. attention:: The `@examples` and `@end_examples` tags are not standard Doxygen tags. They are custom aliases + we have specified to simplify documenting examples. Do not confuse this with the standard `@example` tag. + +Inline Documentation Blocks +^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Inline comments can be used to describe enum values, variables, and other code constructs. +To document the members of a file, struct, union, class, or enum, it is sometimes desired to place the documentation +block after the member instead of before. For this purpose you have to put an additional `<` marker in the comment +block. Below is an example of an inline comment for an enum value. -Please refer to the `Doxygen Documentation <../doxyhtml/index.html>`_ for more details. +.. code-block:: cpp -.. todo:: Sphinx and Breathe do not support the Objective-C Domain. - See https://github.com/breathe-doc/breathe/issues/129 + enum class MyEnum + { + FIRST_VALUE, ///< A brief description of the FIRST_VALUE + SECOND_VALUE ///< A brief description of the SECOND_VALUE + }; -.. .. doxygenindex:: -.. :allow-dot-graphs: +Custom Aliases +^^^^^^^^^^^^^^ +We have defined some custom aliases to simplify documenting examples. -.. Ideally, we would use `doxygenfile` with `:allow-dot-graphs:`, but sphinx complains about duplicated namespaces... +- ``@examples`` - Start of an example block. This will format the following text as ``cpp``. +- ``@examples_end`` - End of an example block. +- ``@rst`` - Start of a reStructuredText block. This will format the following text as reStructuredText. +- ``@rst_end`` - End of a reStructuredText block. diff --git a/src/audio.h b/src/audio.h index cbe4ae98b1c..9d096f122b7 100644 --- a/src/audio.h +++ b/src/audio.h @@ -8,13 +8,13 @@ #include "utility.h" namespace audio { enum stream_config_e : int { - STEREO, - HIGH_STEREO, - SURROUND51, - HIGH_SURROUND51, - SURROUND71, - HIGH_SURROUND71, - MAX_STREAM_CONFIG + STEREO, ///< Stereo + HIGH_STEREO, ///< High stereo + SURROUND51, ///< Surround 5.1 + HIGH_SURROUND51, ///< High surround 5.1 + SURROUND71, ///< Surround 7.1 + HIGH_SURROUND71, ///< High surround 7.1 + MAX_STREAM_CONFIG ///< Maximum audio stream configuration }; struct opus_stream_config_t { @@ -37,10 +37,10 @@ namespace audio { struct config_t { enum flags_e : int { - HIGH_QUALITY, - HOST_AUDIO, - CUSTOM_SURROUND_PARAMS, - MAX_FLAGS + HIGH_QUALITY, ///< High quality audio + HOST_AUDIO, ///< Host audio + CUSTOM_SURROUND_PARAMS, ///< Custom surround parameters + MAX_FLAGS ///< Maximum number of flags }; int packetDuration; diff --git a/src/config.cpp b/src/config.cpp index a466eb12a62..c5452354e3c 100644 --- a/src/config.cpp +++ b/src/config.cpp @@ -107,72 +107,72 @@ namespace config { #endif enum class quality_av1_e : int { - speed = AMF_VIDEO_ENCODER_AV1_QUALITY_PRESET_SPEED, - quality = AMF_VIDEO_ENCODER_AV1_QUALITY_PRESET_QUALITY, - balanced = AMF_VIDEO_ENCODER_AV1_QUALITY_PRESET_BALANCED + speed = AMF_VIDEO_ENCODER_AV1_QUALITY_PRESET_SPEED, ///< Speed preset + quality = AMF_VIDEO_ENCODER_AV1_QUALITY_PRESET_QUALITY, ///< Quality preset + balanced = AMF_VIDEO_ENCODER_AV1_QUALITY_PRESET_BALANCED ///< Balanced preset }; enum class quality_hevc_e : int { - speed = AMF_VIDEO_ENCODER_HEVC_QUALITY_PRESET_SPEED, - quality = AMF_VIDEO_ENCODER_HEVC_QUALITY_PRESET_QUALITY, - balanced = AMF_VIDEO_ENCODER_HEVC_QUALITY_PRESET_BALANCED + speed = AMF_VIDEO_ENCODER_HEVC_QUALITY_PRESET_SPEED, ///< Speed preset + quality = AMF_VIDEO_ENCODER_HEVC_QUALITY_PRESET_QUALITY, ///< Quality preset + balanced = AMF_VIDEO_ENCODER_HEVC_QUALITY_PRESET_BALANCED ///< Balanced preset }; enum class quality_h264_e : int { - speed = AMF_VIDEO_ENCODER_QUALITY_PRESET_SPEED, - quality = AMF_VIDEO_ENCODER_QUALITY_PRESET_QUALITY, - balanced = AMF_VIDEO_ENCODER_QUALITY_PRESET_BALANCED + speed = AMF_VIDEO_ENCODER_QUALITY_PRESET_SPEED, ///< Speed preset + quality = AMF_VIDEO_ENCODER_QUALITY_PRESET_QUALITY, ///< Quality preset + balanced = AMF_VIDEO_ENCODER_QUALITY_PRESET_BALANCED ///< Balanced preset }; enum class rc_av1_e : int { - cbr = AMF_VIDEO_ENCODER_AV1_RATE_CONTROL_METHOD_CBR, - cqp = AMF_VIDEO_ENCODER_AV1_RATE_CONTROL_METHOD_CONSTANT_QP, - vbr_latency = AMF_VIDEO_ENCODER_AV1_RATE_CONTROL_METHOD_LATENCY_CONSTRAINED_VBR, - vbr_peak = AMF_VIDEO_ENCODER_AV1_RATE_CONTROL_METHOD_PEAK_CONSTRAINED_VBR + cbr = AMF_VIDEO_ENCODER_AV1_RATE_CONTROL_METHOD_CBR, ///< CBR + cqp = AMF_VIDEO_ENCODER_AV1_RATE_CONTROL_METHOD_CONSTANT_QP, ///< CQP + vbr_latency = AMF_VIDEO_ENCODER_AV1_RATE_CONTROL_METHOD_LATENCY_CONSTRAINED_VBR, ///< VBR with latency constraints + vbr_peak = AMF_VIDEO_ENCODER_AV1_RATE_CONTROL_METHOD_PEAK_CONSTRAINED_VBR ///< VBR with peak constraints }; enum class rc_hevc_e : int { - cbr = AMF_VIDEO_ENCODER_HEVC_RATE_CONTROL_METHOD_CBR, - cqp = AMF_VIDEO_ENCODER_HEVC_RATE_CONTROL_METHOD_CONSTANT_QP, - vbr_latency = AMF_VIDEO_ENCODER_HEVC_RATE_CONTROL_METHOD_LATENCY_CONSTRAINED_VBR, - vbr_peak = AMF_VIDEO_ENCODER_HEVC_RATE_CONTROL_METHOD_PEAK_CONSTRAINED_VBR + cbr = AMF_VIDEO_ENCODER_HEVC_RATE_CONTROL_METHOD_CBR, ///< CBR + cqp = AMF_VIDEO_ENCODER_HEVC_RATE_CONTROL_METHOD_CONSTANT_QP, ///< CQP + vbr_latency = AMF_VIDEO_ENCODER_HEVC_RATE_CONTROL_METHOD_LATENCY_CONSTRAINED_VBR, ///< VBR with latency constraints + vbr_peak = AMF_VIDEO_ENCODER_HEVC_RATE_CONTROL_METHOD_PEAK_CONSTRAINED_VBR ///< VBR with peak constraints }; enum class rc_h264_e : int { - cbr = AMF_VIDEO_ENCODER_RATE_CONTROL_METHOD_CBR, - cqp = AMF_VIDEO_ENCODER_RATE_CONTROL_METHOD_CONSTANT_QP, - vbr_latency = AMF_VIDEO_ENCODER_RATE_CONTROL_METHOD_LATENCY_CONSTRAINED_VBR, - vbr_peak = AMF_VIDEO_ENCODER_RATE_CONTROL_METHOD_PEAK_CONSTRAINED_VBR + cbr = AMF_VIDEO_ENCODER_RATE_CONTROL_METHOD_CBR, ///< CBR + cqp = AMF_VIDEO_ENCODER_RATE_CONTROL_METHOD_CONSTANT_QP, ///< CQP + vbr_latency = AMF_VIDEO_ENCODER_RATE_CONTROL_METHOD_LATENCY_CONSTRAINED_VBR, ///< VBR with latency constraints + vbr_peak = AMF_VIDEO_ENCODER_RATE_CONTROL_METHOD_PEAK_CONSTRAINED_VBR ///< VBR with peak constraints }; enum class usage_av1_e : int { - transcoding = AMF_VIDEO_ENCODER_AV1_USAGE_TRANSCODING, - webcam = AMF_VIDEO_ENCODER_AV1_USAGE_WEBCAM, - lowlatency_high_quality = AMF_VIDEO_ENCODER_AV1_USAGE_LOW_LATENCY_HIGH_QUALITY, - lowlatency = AMF_VIDEO_ENCODER_AV1_USAGE_LOW_LATENCY, - ultralowlatency = AMF_VIDEO_ENCODER_AV1_USAGE_ULTRA_LOW_LATENCY + transcoding = AMF_VIDEO_ENCODER_AV1_USAGE_TRANSCODING, ///< Transcoding preset + webcam = AMF_VIDEO_ENCODER_AV1_USAGE_WEBCAM, ///< Webcam preset + lowlatency_high_quality = AMF_VIDEO_ENCODER_AV1_USAGE_LOW_LATENCY_HIGH_QUALITY, ///< Low latency high quality preset + lowlatency = AMF_VIDEO_ENCODER_AV1_USAGE_LOW_LATENCY, ///< Low latency preset + ultralowlatency = AMF_VIDEO_ENCODER_AV1_USAGE_ULTRA_LOW_LATENCY ///< Ultra low latency preset }; enum class usage_hevc_e : int { - transcoding = AMF_VIDEO_ENCODER_HEVC_USAGE_TRANSCODING, - webcam = AMF_VIDEO_ENCODER_HEVC_USAGE_WEBCAM, - lowlatency_high_quality = AMF_VIDEO_ENCODER_HEVC_USAGE_LOW_LATENCY_HIGH_QUALITY, - lowlatency = AMF_VIDEO_ENCODER_HEVC_USAGE_LOW_LATENCY, - ultralowlatency = AMF_VIDEO_ENCODER_HEVC_USAGE_ULTRA_LOW_LATENCY + transcoding = AMF_VIDEO_ENCODER_HEVC_USAGE_TRANSCODING, ///< Transcoding preset + webcam = AMF_VIDEO_ENCODER_HEVC_USAGE_WEBCAM, ///< Webcam preset + lowlatency_high_quality = AMF_VIDEO_ENCODER_HEVC_USAGE_LOW_LATENCY_HIGH_QUALITY, ///< Low latency high quality preset + lowlatency = AMF_VIDEO_ENCODER_HEVC_USAGE_LOW_LATENCY, ///< Low latency preset + ultralowlatency = AMF_VIDEO_ENCODER_HEVC_USAGE_ULTRA_LOW_LATENCY ///< Ultra low latency preset }; enum class usage_h264_e : int { - transcoding = AMF_VIDEO_ENCODER_USAGE_TRANSCODING, - webcam = AMF_VIDEO_ENCODER_USAGE_WEBCAM, - lowlatency_high_quality = AMF_VIDEO_ENCODER_USAGE_LOW_LATENCY_HIGH_QUALITY, - lowlatency = AMF_VIDEO_ENCODER_USAGE_LOW_LATENCY, - ultralowlatency = AMF_VIDEO_ENCODER_USAGE_ULTRA_LOW_LATENCY + transcoding = AMF_VIDEO_ENCODER_USAGE_TRANSCODING, ///< Transcoding preset + webcam = AMF_VIDEO_ENCODER_USAGE_WEBCAM, ///< Webcam preset + lowlatency_high_quality = AMF_VIDEO_ENCODER_USAGE_LOW_LATENCY_HIGH_QUALITY, ///< Low latency high quality preset + lowlatency = AMF_VIDEO_ENCODER_USAGE_LOW_LATENCY, ///< Low latency preset + ultralowlatency = AMF_VIDEO_ENCODER_USAGE_ULTRA_LOW_LATENCY ///< Ultra low latency preset }; enum coder_e : int { - _auto = AMF_VIDEO_ENCODER_UNDEFINED, - cabac = AMF_VIDEO_ENCODER_CABAC, - cavlc = AMF_VIDEO_ENCODER_CALV + _auto = AMF_VIDEO_ENCODER_UNDEFINED, ///< Auto + cabac = AMF_VIDEO_ENCODER_CABAC, ///< CABAC + cavlc = AMF_VIDEO_ENCODER_CALV ///< CAVLC }; template <class T> @@ -226,19 +226,19 @@ namespace config { namespace qsv { enum preset_e : int { - veryslow = 1, - slower = 2, - slow = 3, - medium = 4, - fast = 5, - faster = 6, - veryfast = 7 + veryslow = 1, ///< veryslow preset + slower = 2, ///< slower preset + slow = 3, ///< slow preset + medium = 4, ///< medium preset + fast = 5, ///< fast preset + faster = 6, ///< faster preset + veryfast = 7 ///< veryfast preset }; enum cavlc_e : int { - _auto = false, - enabled = true, - disabled = false + _auto = false, ///< Auto + enabled = true, ///< Enabled + disabled = false ///< Disabled }; std::optional<int> @@ -269,9 +269,9 @@ namespace config { namespace vt { enum coder_e : int { - _auto = 0, - cabac, - cavlc + _auto = 0, ///< Auto + cabac, ///< CABAC + cavlc ///< CAVLC }; int diff --git a/src/config.h b/src/config.h index 308c774eadb..60f57c35909 100644 --- a/src/config.h +++ b/src/config.h @@ -143,12 +143,12 @@ namespace config { namespace flag { enum flag_e : std::size_t { - PIN_STDIN = 0, // Read PIN from stdin instead of http - FRESH_STATE, // Do not load or save state - FORCE_VIDEO_HEADER_REPLACE, // force replacing headers inside video data - UPNP, // Try Universal Plug 'n Play - CONST_PIN, // Use "universal" pin - FLAG_SIZE + PIN_STDIN = 0, ///< Read PIN from stdin instead of http + FRESH_STATE, ///< Do not load or save state + FORCE_VIDEO_HEADER_REPLACE, ///< force replacing headers inside video data + UPNP, ///< Try Universal Plug 'n Play + CONST_PIN, ///< Use "universal" pin + FLAG_SIZE ///< Number of flags }; } diff --git a/src/confighttp.cpp b/src/confighttp.cpp index 9b2c0d95f49..f43f8962c71 100644 --- a/src/confighttp.cpp +++ b/src/confighttp.cpp @@ -54,8 +54,8 @@ namespace confighttp { using req_https_t = std::shared_ptr<typename SimpleWeb::ServerBase<SimpleWeb::HTTPS>::Request>; enum class op_e { - ADD, - REMOVE + ADD, ///< ADD + REMOVE ///< REMOVE }; void diff --git a/src/entry_handler.cpp b/src/entry_handler.cpp index 8d17b7d270a..ada85265796 100644 --- a/src/entry_handler.cpp +++ b/src/entry_handler.cpp @@ -1,6 +1,6 @@ /** * @file entry_handler.cpp - * @brief Entry point related functions. + * @brief Definitions for entry handling functions. */ // standard includes @@ -27,28 +27,12 @@ extern "C" { using namespace std::literals; -/** - * @brief Launch the Web UI. - * - * EXAMPLES: - * ```cpp - * launch_ui(); - * ``` - */ void launch_ui() { std::string url = "https://localhost:" + std::to_string(net::map_port(confighttp::PORT_HTTPS)); platf::open_url(url); } -/** - * @brief Launch the Web UI at a specific endpoint. - * - * EXAMPLES: - * ```cpp - * launch_ui_with_path("/pin"); - * ``` - */ void launch_ui_with_path(std::string path) { std::string url = "https://localhost:" + std::to_string(net::map_port(confighttp::PORT_HTTPS)) + path; @@ -56,22 +40,10 @@ launch_ui_with_path(std::string path) { } namespace args { - /** - * @brief Reset the user credentials. - * - * @param name The name of the program. - * @param argc The number of arguments. - * @param argv The arguments. - * - * EXAMPLES: - * ```cpp - * creds("sunshine", 2, {"new_username", "new_password"}); - * ``` - */ int creds(const char *name, int argc, char *argv[]) { if (argc < 2 || argv[0] == "help"sv || argv[1] == "help"sv) { - help(name, argc, argv); + help(name); } http::save_user_creds(config::sunshine.credentials_file, argv[0], argv[1]); @@ -79,59 +51,21 @@ namespace args { return 0; } - /** - * @brief Print help to stdout, then exit. - * @param name The name of the program. - * @param argc The number of arguments. (Unused) - * @param argv The arguments. (Unused) - * - * EXAMPLES: - * ```cpp - * help("sunshine", 0, nullptr); - * ``` - */ int - help(const char *name, int argc, char *argv[]) { + help(const char *name) { logging::print_help(name); return 0; } - /** - * @brief Print the version to stdout, then exit. - * @param name The name of the program. (Unused) - * @param argc The number of arguments. (Unused) - * @param argv The arguments. (Unused) - * - * EXAMPLES: - * ```cpp - * version("sunshine", 0, nullptr); - * ``` - */ int - version(const char *name, int argc, char *argv[]) { + version() { // version was already logged at startup return 0; } #ifdef _WIN32 - /** - * @brief Restore global NVIDIA control panel settings. - * - * If Sunshine was improperly terminated, this function restores - * the global NVIDIA control panel settings to the undo file left - * by Sunshine. This function is typically called by the uninstaller. - * - * @param name The name of the program. (Unused) - * @param argc The number of arguments. (Unused) - * @param argv The arguments. (Unused) - * - * EXAMPLES: - * ```cpp - * restore_nvprefs_undo("sunshine", 0, nullptr); - * ``` - */ int - restore_nvprefs_undo(const char *name, int argc, char *argv[]) { + restore_nvprefs_undo() { if (nvprefs_instance.load()) { nvprefs_instance.restore_from_and_delete_undo_file_if_exists(); nvprefs_instance.unload(); @@ -145,11 +79,6 @@ namespace lifetime { char **argv; std::atomic_int desired_exit_code; - /** - * @brief Terminates Sunshine gracefully with the provided exit code. - * @param exit_code The exit code to return from main(). - * @param async Specifies whether our termination will be non-blocking. - */ void exit_sunshine(int exit_code, bool async) { // Store the exit code of the first exit_sunshine() call @@ -166,9 +95,6 @@ namespace lifetime { } } - /** - * @brief Breaks into the debugger or terminates Sunshine if no debugger is attached. - */ void debug_trap() { #ifdef _WIN32 @@ -178,9 +104,6 @@ namespace lifetime { #endif } - /** - * @brief Gets the argv array passed to main(). - */ char ** get_argv() { return argv; @@ -188,10 +111,6 @@ namespace lifetime { } // namespace lifetime #ifdef _WIN32 -/** - * @brief Check if NVIDIA's GameStream software is running. - * @return `true` if GameStream is enabled, `false` otherwise. - */ bool is_gamestream_enabled() { DWORD enabled; @@ -284,14 +203,6 @@ namespace service_ctrl { SC_HANDLE service_handle = NULL; }; - /** - * @brief Check if the service is running. - * - * EXAMPLES: - * ```cpp - * is_service_running(); - * ``` - */ bool is_service_running() { service_controller sc { SERVICE_QUERY_STATUS }; @@ -304,14 +215,6 @@ namespace service_ctrl { return status.dwCurrentState == SERVICE_RUNNING; } - /** - * @brief Start the service and wait for startup to complete. - * - * EXAMPLES: - * ```cpp - * start_service(); - * ``` - */ bool start_service() { service_controller sc { SERVICE_QUERY_STATUS | SERVICE_START }; @@ -338,14 +241,6 @@ namespace service_ctrl { return true; } - /** - * @brief Wait for the UI to be ready after Sunshine startup. - * - * EXAMPLES: - * ```cpp - * wait_for_ui_ready(); - * ``` - */ bool wait_for_ui_ready() { std::cout << "Waiting for Web UI to be ready..."; diff --git a/src/entry_handler.h b/src/entry_handler.h index bdab361cf0c..8a0544da7fb 100644 --- a/src/entry_handler.h +++ b/src/entry_handler.h @@ -1,6 +1,6 @@ /** * @file entry_handler.h - * @brief Header file for entry point functions. + * @brief Declarations for entry handling functions. */ #pragma once @@ -12,50 +12,149 @@ #include "thread_pool.h" #include "thread_safe.h" -// functions +/** + * @brief Launch the Web UI. + * + * @examples + * launch_ui(); + * @examples_end + */ void launch_ui(); + +/** + * @brief Launch the Web UI at a specific endpoint. + * + * @examples + * launch_ui_with_path("/pin"); + * @examples_end + */ void launch_ui_with_path(std::string path); -#ifdef _WIN32 -// windows only functions -bool -is_gamestream_enabled(); -#endif - +/** + * @brief Functions for handling command line arguments. + */ namespace args { + /** + * @brief Reset the user credentials. + * + * @param name The name of the program. + * @param argc The number of arguments. + * @param argv The arguments. + * + * @examples + * creds("sunshine", 2, {"new_username", "new_password"}); + * @examples_end + */ int creds(const char *name, int argc, char *argv[]); + + /** + * @brief Print help to stdout, then exit. + * @param name The name of the program. + * + * @examples + * help("sunshine"); + * @examples_end + */ int - help(const char *name, int argc, char *argv[]); + help(const char *name); + + /** + * @brief Print the version to stdout, then exit. + * + * @examples + * version(); + * @examples_end + */ int - version(const char *name, int argc, char *argv[]); -#ifdef _WIN32 + version(); + +#if defined(_WIN32) || defined(DOXYGEN) + /** + * @brief Restore global NVIDIA control panel settings. + * + * If Sunshine was improperly terminated, this function restores + * the global NVIDIA control panel settings to the undo file left + * by Sunshine. This function is typically called by the uninstaller. + * + * @examples + * restore_nvprefs_undo(); + * @examples_end + */ int - restore_nvprefs_undo(const char *name, int argc, char *argv[]); + restore_nvprefs_undo(); #endif } // namespace args +/** + * @brief Functions for handling the lifetime of Sunshine. + */ namespace lifetime { extern char **argv; extern std::atomic_int desired_exit_code; + + /** + * @brief Terminates Sunshine gracefully with the provided exit code. + * @param exit_code The exit code to return from main(). + * @param async Specifies whether our termination will be non-blocking. + */ void exit_sunshine(int exit_code, bool async); + + /** + * @brief Breaks into the debugger or terminates Sunshine if no debugger is attached. + */ void debug_trap(); + + /** + * @brief Get the argv array passed to main(). + */ char ** get_argv(); } // namespace lifetime -#ifdef _WIN32 +#if defined(_WIN32) || defined(DOXYGEN) +/** + * @brief Check if NVIDIA's GameStream software is running. + * @return `true` if GameStream is enabled, `false` otherwise. + */ +bool +is_gamestream_enabled(); + +/** + * @brief Namespace for controlling the Sunshine service model on Windows. + */ namespace service_ctrl { + /** + * @brief Check if the service is running. + * + * @examples + * is_service_running(); + * @examples_end + */ bool is_service_running(); + /** + * @brief Start the service and wait for startup to complete. + * + * @examples + * start_service(); + * @examples_end + */ bool start_service(); + /** + * @brief Wait for the UI to be ready after Sunshine startup. + * + * @examples + * wait_for_ui_ready(); + * @examples_end + */ bool wait_for_ui_ready(); } // namespace service_ctrl diff --git a/src/file_handler.cpp b/src/file_handler.cpp index 6f11bb709de..b5c9638a1b8 100644 --- a/src/file_handler.cpp +++ b/src/file_handler.cpp @@ -1,6 +1,6 @@ /** * @file file_handler.cpp - * @brief File handling functions. + * @brief Definitions for file handling functions. */ // standard includes @@ -12,11 +12,6 @@ #include "logging.h" namespace file_handler { - /** - * @brief Get the parent directory of a file or directory. - * @param path The path of the file or directory. - * @return `std::string` : The parent directory. - */ std::string get_parent_directory(const std::string &path) { // remove any trailing path separators @@ -29,11 +24,6 @@ namespace file_handler { return p.parent_path().string(); } - /** - * @brief Make a directory. - * @param path The path of the directory. - * @return `bool` : `true` on success, `false` on failure. - */ bool make_directory(const std::string &path) { // first, check if the directory already exists @@ -44,16 +34,6 @@ namespace file_handler { return std::filesystem::create_directories(path); } - /** - * @brief Read a file to string. - * @param path The path of the file. - * @return `std::string` : The contents of the file. - * - * EXAMPLES: - * ```cpp - * std::string contents = read_file("path/to/file"); - * ``` - */ std::string read_file(const char *path) { if (!std::filesystem::exists(path)) { @@ -65,17 +45,6 @@ namespace file_handler { return std::string { (std::istreambuf_iterator<char>(in)), std::istreambuf_iterator<char>() }; } - /** - * @brief Writes a file. - * @param path The path of the file. - * @param contents The contents to write. - * @return `int` : `0` on success, `-1` on failure. - * - * EXAMPLES: - * ```cpp - * int write_status = write_file("path/to/file", "file contents"); - * ``` - */ int write_file(const char *path, const std::string_view &contents) { std::ofstream out(path); diff --git a/src/file_handler.h b/src/file_handler.h index 5ff8015c635..d669f17b8e5 100644 --- a/src/file_handler.h +++ b/src/file_handler.h @@ -1,21 +1,57 @@ /** * @file file_handler.h - * @brief Header file for file handling functions. + * @brief Declarations for file handling functions. */ #pragma once #include <string> +/** + * @brief Responsible for file handling functions. + */ namespace file_handler { + /** + * @brief Get the parent directory of a file or directory. + * @param path The path of the file or directory. + * @return The parent directory. + * @examples + * std::string parent_dir = get_parent_directory("path/to/file"); + * @examples_end + */ std::string get_parent_directory(const std::string &path); + /** + * @brief Make a directory. + * @param path The path of the directory. + * @return `true` on success, `false` on failure. + * @examples + * bool dir_created = make_directory("path/to/directory"); + * @examples_end + */ bool make_directory(const std::string &path); + /** + * @brief Read a file to string. + * @param path The path of the file. + * @return The contents of the file. + * @examples + * std::string contents = read_file("path/to/file"); + * @examples_end + */ std::string read_file(const char *path); + /** + * @brief Writes a file. + * @param path The path of the file. + * @param contents The contents to write. + * @return ``0`` on success, ``-1`` on failure. + * @examples + * int write_status = write_file("path/to/file", "file contents"); + * @examples_end + */ int write_file(const char *path, const std::string_view &contents); } // namespace file_handler diff --git a/src/input.cpp b/src/input.cpp index c9efc343bfa..e3e4f9f76c2 100644 --- a/src/input.cpp +++ b/src/input.cpp @@ -49,9 +49,9 @@ namespace input { constexpr auto VKEY_RMENU = 0xA5; enum class button_state_e { - NONE, - DOWN, - UP + NONE, ///< No button state + DOWN, ///< Button is down + UP ///< Button is up }; template <std::size_t N> @@ -88,9 +88,9 @@ namespace input { } /** - * @brief Converts a little-endian netfloat to a native endianness float. + * @brief Convert a little-endian netfloat to a native endianness float. * @param f Netfloat value. - * @return Float value. + * @return The native endianness float value. */ float from_netfloat(netfloat f) { @@ -98,11 +98,11 @@ namespace input { } /** - * @brief Converts a little-endian netfloat to a native endianness float and clamps it. + * @brief Convert a little-endian netfloat to a native endianness float and clamps it. * @param f Netfloat value. * @param min The minimium value for clamping. * @param max The maximum value for clamping. - * @return Clamped float value. + * @return Clamped native endianess float value. */ float from_clamped_netfloat(netfloat f, float min, float max) { @@ -150,11 +150,10 @@ namespace input { struct input_t { enum shortkey_e { - CTRL = 0x1, - ALT = 0x2, - SHIFT = 0x4, - - SHORTCUT = CTRL | ALT | SHIFT + CTRL = 0x1, ///< Control key + ALT = 0x2, ///< Alt key + SHIFT = 0x4, ///< Shift key + SHORTCUT = CTRL | ALT | SHIFT ///< Shortcut combination }; input_t( @@ -191,11 +190,9 @@ namespace input { }; /** - * Apply shortcut based on VKEY - * On success - * return > 0 - * On nothing - * return 0 + * @brief Apply shortcut based on VKEY + * @param keyCode The VKEY code + * @return 0 if no shortcut applied, > 0 if shortcut applied. */ inline int apply_shortcut(short keyCode) { @@ -499,7 +496,7 @@ namespace input { } /** - * @brief Multiplies a polar coordinate pair by a cartesian scaling factor. + * @brief Multiply a polar coordinate pair by a cartesian scaling factor. * @param r The radial coordinate. * @param angle The angular coordinate (radians). * @param scalar The scalar cartesian coordinate pair. @@ -520,7 +517,7 @@ namespace input { } /** - * @brief Scales the ellipse axes according to the provided size. + * @brief Scale the ellipse axes according to the provided size. * @param val The major and minor axis pair. * @param rotation The rotation value from the touch/pen event. * @param scalar The scalar cartesian coordinate pair. @@ -529,7 +526,7 @@ namespace input { std::pair<float, float> scale_client_contact_area(const std::pair<float, float> &val, uint16_t rotation, const std::pair<float, float> &scalar) { // If the rotation is unknown, we'll just scale both axes equally by using - // a 45 degree angle for our scaling calculations + // a 45-degree angle for our scaling calculations float angle = rotation == LI_ROT_UNKNOWN ? (M_PI / 4) : (rotation * (M_PI / 180)); // If we have a major but not a minor axis, treat the touch as circular @@ -650,7 +647,7 @@ namespace input { } /** - * Update flags for keyboard shortcut combo's + * @brief Update flags for keyboard shortcut combo's */ inline void update_shortcutFlags(int *flags, short keyCode, bool release) { @@ -1242,16 +1239,16 @@ namespace input { } enum class batch_result_e { - batched, // This entry was batched with the source entry - not_batchable, // Not eligible to batch but continue attempts to batch - terminate_batch, // Stop trying to batch with this entry + batched, ///< This entry was batched with the source entry + not_batchable, ///< Not eligible to batch but continue attempts to batch + terminate_batch, ///< Stop trying to batch with this entry }; /** * @brief Batch two relative mouse messages. * @param dest The original packet to batch into. * @param src A later packet to attempt to batch. - * @return `batch_result_e` : The status of the batching operation. + * @return The status of the batching operation. */ batch_result_e batch(PNV_REL_MOUSE_MOVE_PACKET dest, PNV_REL_MOUSE_MOVE_PACKET src) { @@ -1275,7 +1272,7 @@ namespace input { * @brief Batch two absolute mouse messages. * @param dest The original packet to batch into. * @param src A later packet to attempt to batch. - * @return `batch_result_e` : The status of the batching operation. + * @return The status of the batching operation. */ batch_result_e batch(PNV_ABS_MOUSE_MOVE_PACKET dest, PNV_ABS_MOUSE_MOVE_PACKET src) { @@ -1293,7 +1290,7 @@ namespace input { * @brief Batch two vertical scroll messages. * @param dest The original packet to batch into. * @param src A later packet to attempt to batch. - * @return `batch_result_e` : The status of the batching operation. + * @return The status of the batching operation. */ batch_result_e batch(PNV_SCROLL_PACKET dest, PNV_SCROLL_PACKET src) { @@ -1314,7 +1311,7 @@ namespace input { * @brief Batch two horizontal scroll messages. * @param dest The original packet to batch into. * @param src A later packet to attempt to batch. - * @return `batch_result_e` : The status of the batching operation. + * @return The status of the batching operation. */ batch_result_e batch(PSS_HSCROLL_PACKET dest, PSS_HSCROLL_PACKET src) { @@ -1334,7 +1331,7 @@ namespace input { * @brief Batch two controller state messages. * @param dest The original packet to batch into. * @param src A later packet to attempt to batch. - * @return `batch_result_e` : The status of the batching operation. + * @return The status of the batching operation. */ batch_result_e batch(PNV_MULTI_CONTROLLER_PACKET dest, PNV_MULTI_CONTROLLER_PACKET src) { @@ -1363,7 +1360,7 @@ namespace input { * @brief Batch two touch messages. * @param dest The original packet to batch into. * @param src A later packet to attempt to batch. - * @return `batch_result_e` : The status of the batching operation. + * @return The status of the batching operation. */ batch_result_e batch(PSS_TOUCH_PACKET dest, PSS_TOUCH_PACKET src) { @@ -1398,7 +1395,7 @@ namespace input { * @brief Batch two pen messages. * @param dest The original packet to batch into. * @param src A later packet to attempt to batch. - * @return `batch_result_e` : The status of the batching operation. + * @return The status of the batching operation. */ batch_result_e batch(PSS_PEN_PACKET dest, PSS_PEN_PACKET src) { @@ -1432,7 +1429,7 @@ namespace input { * @brief Batch two controller touch messages. * @param dest The original packet to batch into. * @param src A later packet to attempt to batch. - * @return `batch_result_e` : The status of the batching operation. + * @return The status of the batching operation. */ batch_result_e batch(PSS_CONTROLLER_TOUCH_PACKET dest, PSS_CONTROLLER_TOUCH_PACKET src) { @@ -1473,7 +1470,7 @@ namespace input { * @brief Batch two controller motion messages. * @param dest The original packet to batch into. * @param src A later packet to attempt to batch. - * @return `batch_result_e` : The status of the batching operation. + * @return The status of the batching operation. */ batch_result_e batch(PSS_CONTROLLER_MOTION_PACKET dest, PSS_CONTROLLER_MOTION_PACKET src) { @@ -1497,7 +1494,7 @@ namespace input { * @brief Batch two input messages. * @param dest The original packet to batch into. * @param src A later packet to attempt to batch. - * @return `batch_result_e` : The status of the batching operation. + * @return The status of the batching operation. */ batch_result_e batch(PNV_INPUT_HEADER dest, PNV_INPUT_HEADER src) { diff --git a/src/logging.cpp b/src/logging.cpp index e03bcbf5134..321d1f58142 100644 --- a/src/logging.cpp +++ b/src/logging.cpp @@ -48,10 +48,9 @@ namespace logging { /** * @brief Deinitialize the logging system. * - * EXAMPLES: - * ```cpp + * @examples * deinit(); - * ``` + * @examples_end */ void deinit() { @@ -64,12 +63,10 @@ namespace logging { * @brief Initialize the logging system. * @param min_log_level The minimum log level to output. * @param log_file The log file to write to. - * @returns A deinit_t object that will deinitialize the logging system when it goes out of scope. - * - * EXAMPLES: - * ```cpp + * @return An object that will deinitialize the logging system when it goes out of scope. + * @examples * log_init(2, "sunshine.log"); - * ``` + * @examples_end */ [[nodiscard]] std::unique_ptr<deinit_t> init(int min_log_level, const std::string &log_file) { @@ -172,10 +169,9 @@ namespace logging { /** * @brief Flush the log. * - * EXAMPLES: - * ```cpp + * @examples * log_flush(); - * ``` + * @examples_end */ void log_flush() { @@ -188,10 +184,9 @@ namespace logging { * @brief Print help to stdout. * @param name The name of the program. * - * EXAMPLES: - * ```cpp + * @examples * print_help("sunshine"); - * ``` + * @examples_end */ void print_help(const char *name) { diff --git a/src/main.cpp b/src/main.cpp index ec3aa9b56a1..99623057ab0 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -44,11 +44,11 @@ on_signal(int sig, FN &&fn) { } std::map<std::string_view, std::function<int(const char *name, int argc, char **argv)>> cmd_to_func { - { "creds"sv, args::creds }, - { "help"sv, args::help }, - { "version"sv, args::version }, + { "creds"sv, [](const char *name, int argc, char **argv) { return args::creds(name, argc, argv); } }, + { "help"sv, [](const char *name, int argc, char **argv) { return args::help(name); } }, + { "version"sv, [](const char *name, int argc, char **argv) { return args::version(); } }, #ifdef _WIN32 - { "restore-nvprefs-undo"sv, args::restore_nvprefs_undo }, + { "restore-nvprefs-undo"sv, [](const char *name, int argc, char **argv) { return args::restore_nvprefs_undo(); } }, #endif }; @@ -78,11 +78,9 @@ SessionMonitorWindowProc(HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam) { * @brief Main application entry point. * @param argc The number of arguments. * @param argv The arguments. - * - * EXAMPLES: - * ```cpp + * @examples * main(1, const char* args[] = {"sunshine", nullptr}); - * ``` + * @examples_end */ int main(int argc, char *argv[]) { diff --git a/src/network.cpp b/src/network.cpp index 2784afebc39..03fc83b0e34 100644 --- a/src/network.cpp +++ b/src/network.cpp @@ -94,11 +94,6 @@ namespace net { return "wan"sv; } - /** - * @brief Returns the `af_e` enum value for the `address_family` config option value. - * @param view The config option value. - * @return The `af_e` enum value. - */ af_e af_from_enum_string(const std::string_view &view) { if (view == "ipv4") { @@ -112,11 +107,6 @@ namespace net { return BOTH; } - /** - * @brief Returns the wildcard binding address for a given address family. - * @param af Address family. - * @return Normalized address. - */ std::string_view af_to_any_address_string(af_e af) { switch (af) { @@ -130,12 +120,6 @@ namespace net { return "::"sv; } - /** - * @brief Converts an address to a normalized form. - * @details Normalization converts IPv4-mapped IPv6 addresses into IPv4 addresses. - * @param address The address to normalize. - * @return Normalized address. - */ boost::asio::ip::address normalize_address(boost::asio::ip::address address) { // Convert IPv6-mapped IPv4 addresses into regular IPv4 addresses @@ -149,23 +133,11 @@ namespace net { return address; } - /** - * @brief Returns the given address in normalized string form. - * @details Normalization converts IPv4-mapped IPv6 addresses into IPv4 addresses. - * @param address The address to normalize. - * @return Normalized address in string form. - */ std::string addr_to_normalized_string(boost::asio::ip::address address) { return normalize_address(address).to_string(); } - /** - * @brief Returns the given address in a normalized form for in the host portion of a URL. - * @details Normalization converts IPv4-mapped IPv6 addresses into IPv4 addresses. - * @param address The address to normalize and escape. - * @return Normalized address in URL-escaped string. - */ std::string addr_to_url_escaped_string(boost::asio::ip::address address) { address = normalize_address(address); @@ -179,11 +151,6 @@ namespace net { } } - /** - * @brief Returns the encryption mode for the given remote endpoint address. - * @param address The address used to look up the desired encryption mode. - * @return The WAN or LAN encryption mode, based on the provided address. - */ int encryption_mode_for_address(boost::asio::ip::address address) { auto nettype = net::from_address(address.to_string()); @@ -230,12 +197,10 @@ namespace net { /** * @brief Map a specified port based on the base port. * @param port The port to map as a difference from the base port. - * @return `std:uint16_t` : The mapped port number. - * - * EXAMPLES: - * ```cpp + * @return The mapped port number. + * @examples * std::uint16_t mapped_port = net::map_port(1); - * ``` + * @examples_end */ std::uint16_t map_port(int port) { diff --git a/src/network.h b/src/network.h index 5fe842e7c8b..b611f25a89b 100644 --- a/src/network.h +++ b/src/network.h @@ -25,14 +25,14 @@ namespace net { using packet_t = util::safe_ptr<ENetPacket, enet_packet_destroy>; enum net_e : int { - PC, - LAN, - WAN + PC, ///< PC + LAN, ///< LAN + WAN ///< WAN }; enum af_e : int { - IPV4, - BOTH + IPV4, ///< IPv4 only + BOTH ///< IPv4 and IPv6 }; net_e @@ -47,15 +47,15 @@ namespace net { host_create(af_e af, ENetAddress &addr, std::size_t peers, std::uint16_t port); /** - * @brief Returns the `af_e` enum value for the `address_family` config option value. + * @brief Get the address family enum value from a string. * @param view The config option value. - * @return The `af_e` enum value. + * @return The address family enum value. */ af_e af_from_enum_string(const std::string_view &view); /** - * @brief Returns the wildcard binding address for a given address family. + * @brief Get the wildcard binding address for a given address family. * @param af Address family. * @return Normalized address. */ @@ -63,7 +63,7 @@ namespace net { af_to_any_address_string(af_e af); /** - * @brief Converts an address to a normalized form. + * @brief Convert an address to a normalized form. * @details Normalization converts IPv4-mapped IPv6 addresses into IPv4 addresses. * @param address The address to normalize. * @return Normalized address. @@ -72,7 +72,7 @@ namespace net { normalize_address(boost::asio::ip::address address); /** - * @brief Returns the given address in normalized string form. + * @brief Get the given address in normalized string form. * @details Normalization converts IPv4-mapped IPv6 addresses into IPv4 addresses. * @param address The address to normalize. * @return Normalized address in string form. @@ -81,7 +81,7 @@ namespace net { addr_to_normalized_string(boost::asio::ip::address address); /** - * @brief Returns the given address in a normalized form for in the host portion of a URL. + * @brief Get the given address in a normalized form for the host portion of a URL. * @details Normalization converts IPv4-mapped IPv6 addresses into IPv4 addresses. * @param address The address to normalize and escape. * @return Normalized address in URL-escaped string. @@ -90,7 +90,7 @@ namespace net { addr_to_url_escaped_string(boost::asio::ip::address address); /** - * @brief Returns the encryption mode for the given remote endpoint address. + * @brief Get the encryption mode for the given remote endpoint address. * @param address The address used to look up the desired encryption mode. * @return The WAN or LAN encryption mode, based on the provided address. */ diff --git a/src/nvhttp.cpp b/src/nvhttp.cpp index bd8434e5534..90de0bf9972 100644 --- a/src/nvhttp.cpp +++ b/src/nvhttp.cpp @@ -161,8 +161,8 @@ namespace nvhttp { using req_http_t = std::shared_ptr<typename SimpleWeb::ServerBase<SimpleWeb::HTTP>::Request>; enum class op_e { - ADD, - REMOVE + ADD, ///< ADD + REMOVE ///< REMOVE }; std::string @@ -615,11 +615,9 @@ namespace nvhttp { * @param pin The user supplied pin. * @param name The user supplied name. * @return `true` if the pin is correct, `false` otherwise. - * - * EXAMPLES: - * ```cpp + * @examples * bool pin_status = nvhttp::pin("1234", "laptop"); - * ``` + * @examples_end */ bool pin(std::string pin, std::string name) { @@ -1052,11 +1050,9 @@ namespace nvhttp { /** * @brief Start the nvhttp server. - * - * EXAMPLES: - * ```cpp + * @examples * nvhttp::start(); - * ``` + * @examples_end */ void start() { @@ -1190,11 +1186,9 @@ namespace nvhttp { /** * @brief Remove all paired clients. - * - * EXAMPLES: - * ```cpp + * @examples * nvhttp::erase_all_clients(); - * ``` + * @examples_end */ void erase_all_clients() { @@ -1206,11 +1200,9 @@ namespace nvhttp { /** * @brief Remove single client. - * - * EXAMPLES: - * ```cpp + * @examples * nvhttp::unpair_client("4D7BB2DD-5704-A405-B41C-891A022932E1"); - * ``` + * @examples_end */ int unpair_client(std::string uuid) { diff --git a/src/nvhttp.h b/src/nvhttp.h index 6fdf202ac29..16db14f8655 100644 --- a/src/nvhttp.h +++ b/src/nvhttp.h @@ -16,7 +16,7 @@ #include "thread_safe.h" /** - * @brief This namespace contains all the functions and variables related to the nvhttp (GameStream) server. + * @brief Contains all the functions and variables related to the nvhttp (GameStream) server. */ namespace nvhttp { diff --git a/src/platform/common.h b/src/platform/common.h index e7e72334703..00bc33e6787 100644 --- a/src/platform/common.h +++ b/src/platform/common.h @@ -87,10 +87,10 @@ namespace platf { }; enum class gamepad_feedback_e { - rumble, - rumble_triggers, - set_motion_event_state, - set_rgb_led, + rumble, ///< Rumble + rumble_triggers, ///< Rumble triggers + set_motion_event_state, ///< Set motion event state + set_rgb_led, ///< Set RGB LED }; struct gamepad_feedback_msg_t { @@ -158,15 +158,15 @@ namespace platf { namespace speaker { enum speaker_e { - FRONT_LEFT, - FRONT_RIGHT, - FRONT_CENTER, - LOW_FREQUENCY, - BACK_LEFT, - BACK_RIGHT, - SIDE_LEFT, - SIDE_RIGHT, - MAX_SPEAKERS, + FRONT_LEFT, ///< Front left + FRONT_RIGHT, ///< Front right + FRONT_CENTER, ///< Front center + LOW_FREQUENCY, ///< Low frequency + BACK_LEFT, ///< Back left + BACK_RIGHT, ///< Back right + SIDE_LEFT, ///< Side left + SIDE_RIGHT, ///< Side right + MAX_SPEAKERS, ///< Maximum number of speakers }; constexpr std::uint8_t map_stereo[] { @@ -193,20 +193,20 @@ namespace platf { } // namespace speaker enum class mem_type_e { - system, - vaapi, - dxgi, - cuda, - videotoolbox, - unknown + system, ///< System memory + vaapi, ///< VAAPI + dxgi, ///< DXGI + cuda, ///< CUDA + videotoolbox, ///< VideoToolbox + unknown ///< Unknown }; enum class pix_fmt_e { - yuv420p, - yuv420p10, - nv12, - p010, - unknown + yuv420p, ///< YUV 4:2:0 + yuv420p10, ///< YUV 4:2:0 10-bit + nv12, ///< NV12 + p010, ///< P010 + unknown ///< Unknown }; inline std::string_view @@ -413,11 +413,11 @@ namespace platf { }; enum class capture_e : int { - ok, - reinit, - timeout, - interrupted, - error + ok, ///< Success + reinit, ///< Need to reinitialize + timeout, ///< Timeout + interrupted, ///< Capture was interrupted + error ///< Error }; class display_t { @@ -492,10 +492,10 @@ namespace platf { } /** - * @brief Checks that a given codec is supported by the display device. + * @brief Check that a given codec is supported by the display device. * @param name The FFmpeg codec name (or similar for non-FFmpeg codecs). * @param config The codec configuration. - * @return true if supported, false otherwise. + * @return `true` if supported, `false` otherwise. */ virtual bool is_codec_supported(std::string_view name, const ::video::config_t &config) { @@ -570,11 +570,11 @@ namespace platf { /** * @brief Get the display_t instance for the given hwdevice_type. - * @param display_name The name of the monitor that SHOULD be displayed * If display_name is empty, use the first monitor that's compatible you can find * If you require to use this parameter in a separate thread, make a copy of it. + * @param display_name The name of the monitor that SHOULD be displayed * @param config Stream configuration - * @returns display_t based on hwdevice_type + * @return The display_t instance based on hwdevice_type. */ std::shared_ptr<display_t> display(mem_type_e hwdevice_type, const std::string &display_name, const video::config_t &config); @@ -584,7 +584,7 @@ namespace platf { display_names(mem_type_e hwdevice_type); /** - * @brief Returns if GPUs/drivers have changed since the last call to this function. + * @brief Check if GPUs/drivers have changed since the last call to this function. * @return `true` if a change has occurred or if it is unknown whether a change occurred. */ bool @@ -594,10 +594,10 @@ namespace platf { run_command(bool elevated, bool interactive, const std::string &cmd, boost::filesystem::path &working_dir, const boost::process::environment &env, FILE *file, std::error_code &ec, boost::process::group *group); enum class thread_priority_e : int { - low, - normal, - high, - critical + low, ///< Low priority + normal, ///< Normal priority + high, ///< High priority + critical ///< Critical priority }; void adjust_thread_priority(thread_priority_e priority); @@ -637,12 +637,12 @@ namespace platf { send(send_info_t &send_info); enum class qos_data_type_e : int { - audio, - video + audio, ///< Audio + video ///< Video }; /** - * @brief Enables QoS on the given socket for traffic to the specified destination. + * @brief Enable QoS on the given socket for traffic to the specified destination. * @param native_socket The native socket handle. * @param address The destination address for traffic sent on this socket. * @param port The destination port for traffic sent on this socket. @@ -662,15 +662,15 @@ namespace platf { /** * @brief Attempt to gracefully terminate a process group. * @param native_handle The native handle of the process group. - * @return true if termination was successfully requested. + * @return `true` if termination was successfully requested. */ bool request_process_group_exit(std::uintptr_t native_handle); /** - * @brief Checks if a process group still has running children. + * @brief Check if a process group still has running children. * @param native_handle The native handle of the process group. - * @return true if processes are still running. + * @return `true` if processes are still running. */ bool process_group_running(std::uintptr_t native_handle); @@ -678,14 +678,12 @@ namespace platf { input_t input(); /** - * @brief Gets the current mouse position on screen + * @brief Get the current mouse position on screen * @param input The input_t instance to use. - * @return util::point_t (x, y) - * - * EXAMPLES: - * ```cpp + * @return Screen coordinates of the mouse. + * @examples * auto [x, y] = get_mouse_loc(input); - * ``` + * @examples_end */ util::point_t get_mouse_loc(input_t &input); @@ -709,7 +707,7 @@ namespace platf { typedef deinit_t client_input_t; /** - * @brief Allocates a context to store per-client input data. + * @brief Allocate a context to store per-client input data. * @param input The global input context. * @return A unique pointer to a per-client input data context. */ @@ -717,7 +715,7 @@ namespace platf { allocate_client_input_context(input_t &input); /** - * @brief Sends a touch event to the OS. + * @brief Send a touch event to the OS. * @param input The client-specific input context. * @param touch_port The current viewport for translating to screen coordinates. * @param touch The touch event. @@ -726,7 +724,7 @@ namespace platf { touch_update(client_input_t *input, const touch_port_t &touch_port, const touch_input_t &touch); /** - * @brief Sends a pen event to the OS. + * @brief Send a pen event to the OS. * @param input The client-specific input context. * @param touch_port The current viewport for translating to screen coordinates. * @param pen The pen event. @@ -735,7 +733,7 @@ namespace platf { pen_update(client_input_t *input, const touch_port_t &touch_port, const pen_input_t &pen); /** - * @brief Sends a gamepad touch event to the OS. + * @brief Send a gamepad touch event to the OS. * @param input The global input context. * @param touch The touch event. */ @@ -743,7 +741,7 @@ namespace platf { gamepad_touch(input_t &input, const gamepad_touch_t &touch); /** - * @brief Sends a gamepad motion event to the OS. + * @brief Send a gamepad motion event to the OS. * @param input The global input context. * @param motion The motion event. */ @@ -751,7 +749,7 @@ namespace platf { gamepad_motion(input_t &input, const gamepad_motion_t &motion); /** - * @brief Sends a gamepad battery event to the OS. + * @brief Send a gamepad battery event to the OS. * @param input The global input context. * @param battery The battery event. */ @@ -759,7 +757,7 @@ namespace platf { gamepad_battery(input_t &input, const gamepad_battery_t &battery); /** - * @brief Creates a new virtual gamepad. + * @brief Create a new virtual gamepad. * @param input The global input context. * @param id The gamepad ID. * @param metadata Controller metadata from client (empty if none provided). @@ -772,7 +770,7 @@ namespace platf { free_gamepad(input_t &input, int nr); /** - * @brief Returns the supported platform capabilities to advertise to the client. + * @brief Get the supported platform capabilities to advertise to the client. * @return Capability flags. */ platform_caps::caps_t diff --git a/src/platform/linux/graphics.cpp b/src/platform/linux/graphics.cpp index b085ef0664b..c421ee50323 100644 --- a/src/platform/linux/graphics.cpp +++ b/src/platform/linux/graphics.cpp @@ -507,7 +507,7 @@ namespace egl { } /** - * @brief Returns EGL attributes for eglCreateImage() to import the provided surface. + * @brief Get EGL attributes for eglCreateImage() to import the provided surface. * @param surface The surface descriptor. * @return Vector of EGL attributes. */ @@ -576,7 +576,7 @@ namespace egl { } /** - * @brief Creates a black RGB texture of the specified image size. + * @brief Create a black RGB texture of the specified image size. * @param img The image to use for texture sizing. * @return The new RGB texture. */ @@ -655,7 +655,7 @@ namespace egl { } /** - * @brief Creates biplanar YUV textures to render into. + * @brief Create biplanar YUV textures to render into. * @param width Width of the target frame. * @param height Height of the target frame. * @param format Format of the target frame. diff --git a/src/platform/linux/input/legacy_input.cpp b/src/platform/linux/input/legacy_input.cpp index 35534ec445a..84440116dc3 100644 --- a/src/platform/linux/input/legacy_input.cpp +++ b/src/platform/linux/input/legacy_input.cpp @@ -1075,10 +1075,9 @@ namespace platf { * @param x Absolute x position. * @param y Absolute y position. * - * EXAMPLES: - * ```cpp + * @examples * x_abs_mouse(input, 0, 0); - * ``` + * @examples_end */ static void x_abs_mouse(input_t &input, float x, float y) { @@ -1129,10 +1128,9 @@ namespace platf { * @param x Absolute x position. * @param y Absolute y position. * - * EXAMPLES: - * ```cpp + * @examples * abs_mouse(input, touch_port, 0, 0); - * ``` + * @examples_end */ void abs_mouse(input_t &input, const touch_port_t &touch_port, float x, float y) { @@ -1161,10 +1159,9 @@ namespace platf { * @param deltaX Relative x position. * @param deltaY Relative y position. * - * EXAMPLES: - * ```cpp + * @examples * x_move_mouse(input, 10, 10); // Move mouse 10 pixels down and right - * ``` + * @examples_end */ static void x_move_mouse(input_t &input, int deltaX, int deltaY) { @@ -1184,10 +1181,9 @@ namespace platf { * @param deltaX Relative x position. * @param deltaY Relative y position. * - * EXAMPLES: - * ```cpp + * @examples * move_mouse(input, 10, 10); // Move mouse 10 pixels down and right - * ``` + * @examples_end */ void move_mouse(input_t &input, int deltaX, int deltaY) { @@ -1219,10 +1215,9 @@ namespace platf { * @param button Which mouse button to emulate. * @param release Whether the event was a press (false) or a release (true) * - * EXAMPLES: - * ```cpp + * @examples * x_button_mouse(input, 1, false); // Press left mouse button - * ``` + * @examples_end */ static void x_button_mouse(input_t &input, int button, bool release) { @@ -1262,10 +1257,9 @@ namespace platf { * @param button Which mouse button to emulate. * @param release Whether the event was a press (false) or a release (true) * - * EXAMPLES: - * ```cpp + * @examples * button_mouse(input, 1, false); // Press left mouse button - * ``` + * @examples_end */ void button_mouse(input_t &input, int button, bool release) { @@ -1349,10 +1343,9 @@ namespace platf { * @param button_pos Which mouse button to emulate for positive scroll. * @param button_neg Which mouse button to emulate for negative scroll. * - * EXAMPLES: - * ```cpp + * @examples * x_scroll(input, 10, 4, 5); - * ``` + * @examples_end */ static void x_scroll(input_t &input, int distance, int button_pos, int button_neg) { @@ -1376,10 +1369,9 @@ namespace platf { * @param input The input_t instance to use. * @param high_res_distance How far to scroll. * - * EXAMPLES: - * ```cpp + * @examples * scroll(input, 1200); - * ``` + * @examples_end */ void scroll(input_t &input, int high_res_distance) { @@ -1410,10 +1402,9 @@ namespace platf { * @param input The input_t instance to use. * @param high_res_distance How far to scroll. * - * EXAMPLES: - * ```cpp + * @examples * hscroll(input, 1200); - * ``` + * @examples_end */ void hscroll(input_t &input, int high_res_distance) { @@ -1455,10 +1446,9 @@ namespace platf { * @param release Whether the event was a press (false) or a release (true). * @param flags SS_KBE_FLAG_* values. * - * EXAMPLES: - * ```cpp + * @examples * x_keyboard(input, 0x5A, false, 0); // Press Z - * ``` + * @examples_end */ static void x_keyboard(input_t &input, uint16_t modcode, bool release, uint8_t flags) { @@ -1490,10 +1480,9 @@ namespace platf { * @param release Whether the event was a press (false) or a release (true). * @param flags SS_KBE_FLAG_* values. * - * EXAMPLES: - * ```cpp + * @examples * keyboard(input, 0x5A, false, 0); // Press Z - * ``` + * @examples_end */ void keyboard_update(input_t &input, uint16_t modcode, bool release, uint8_t flags) { @@ -2107,10 +2096,9 @@ namespace platf { /** * @brief Initialize a new keyboard and return it. * - * EXAMPLES: - * ```cpp + * @examples * auto my_keyboard = keyboard(); - * ``` + * @examples_end */ evdev_t keyboard() { @@ -2136,10 +2124,9 @@ namespace platf { /** * @brief Initialize a new `uinput` virtual relative mouse and return it. * - * EXAMPLES: - * ```cpp + * @examples * auto my_mouse = mouse_rel(); - * ``` + * @examples_end */ evdev_t mouse_rel() { @@ -2187,10 +2174,9 @@ namespace platf { /** * @brief Initialize a new `uinput` virtual absolute mouse and return it. * - * EXAMPLES: - * ```cpp + * @examples * auto my_mouse = mouse_abs(); - * ``` + * @examples_end */ evdev_t mouse_abs() { @@ -2242,10 +2228,9 @@ namespace platf { /** * @brief Initialize a new `uinput` virtual touchscreen and return it. * - * EXAMPLES: - * ```cpp + * @examples * auto my_touchscreen = touchscreen(); - * ``` + * @examples_end */ evdev_t touchscreen() { @@ -2349,10 +2334,9 @@ namespace platf { /** * @brief Initialize a new `uinput` virtual pen pad and return it. * - * EXAMPLES: - * ```cpp + * @examples * auto my_penpad = penpad(); - * ``` + * @examples_end */ evdev_t penpad() { @@ -2448,10 +2432,9 @@ namespace platf { /** * @brief Initialize a new `uinput` virtual X360 gamepad and return it. * - * EXAMPLES: - * ```cpp + * @examples * auto my_x360 = x360(); - * ``` + * @examples_end */ evdev_t x360() { @@ -2525,10 +2508,9 @@ namespace platf { /** * @brief Initialize the input system and return it. * - * EXAMPLES: - * ```cpp + * @examples * auto my_input = input(); - * ``` + * @examples_end */ input_t input() { diff --git a/src/platform/linux/misc.cpp b/src/platform/linux/misc.cpp index 0e081c9be6d..0cb1f1c2465 100644 --- a/src/platform/linux/misc.cpp +++ b/src/platform/linux/misc.cpp @@ -747,18 +747,18 @@ namespace platf { namespace source { enum source_e : std::size_t { #ifdef SUNSHINE_BUILD_CUDA - NVFBC, + NVFBC, ///< NvFBC #endif #ifdef SUNSHINE_BUILD_WAYLAND - WAYLAND, + WAYLAND, ///< Wayland #endif #ifdef SUNSHINE_BUILD_DRM - KMS, + KMS, ///< KMS #endif #ifdef SUNSHINE_BUILD_X11 - X11, + X11, ///< X11 #endif - MAX_FLAGS + MAX_FLAGS ///< The maximum number of flags }; } // namespace source diff --git a/src/platform/linux/misc.h b/src/platform/linux/misc.h index 8541bf1650e..709f8e46ad0 100644 --- a/src/platform/linux/misc.h +++ b/src/platform/linux/misc.h @@ -16,9 +16,9 @@ KITTY_USING_MOVE_T(file_t, int, -1, { }); enum class window_system_e { - NONE, - X11, - WAYLAND, + NONE, ///< No window system + X11, ///< X11 + WAYLAND, ///< Wayland }; extern window_system_e window_system; diff --git a/src/platform/linux/publish.cpp b/src/platform/linux/publish.cpp index bc876e7728b..ba3efef35aa 100644 --- a/src/platform/linux/publish.cpp +++ b/src/platform/linux/publish.cpp @@ -21,122 +21,118 @@ namespace avahi { * @brief Error codes used by avahi. */ enum err_e { - OK = 0, /**< OK */ - ERR_FAILURE = -1, /**< Generic error code */ - ERR_BAD_STATE = -2, /**< Object was in a bad state */ - ERR_INVALID_HOST_NAME = -3, /**< Invalid host name */ - ERR_INVALID_DOMAIN_NAME = -4, /**< Invalid domain name */ - ERR_NO_NETWORK = -5, /**< No suitable network protocol available */ - ERR_INVALID_TTL = -6, /**< Invalid DNS TTL */ - ERR_IS_PATTERN = -7, /**< RR key is pattern */ - ERR_COLLISION = -8, /**< Name collision */ - ERR_INVALID_RECORD = -9, /**< Invalid RR */ - - ERR_INVALID_SERVICE_NAME = -10, /**< Invalid service name */ - ERR_INVALID_SERVICE_TYPE = -11, /**< Invalid service type */ - ERR_INVALID_PORT = -12, /**< Invalid port number */ - ERR_INVALID_KEY = -13, /**< Invalid key */ - ERR_INVALID_ADDRESS = -14, /**< Invalid address */ - ERR_TIMEOUT = -15, /**< Timeout reached */ - ERR_TOO_MANY_CLIENTS = -16, /**< Too many clients */ - ERR_TOO_MANY_OBJECTS = -17, /**< Too many objects */ - ERR_TOO_MANY_ENTRIES = -18, /**< Too many entries */ - ERR_OS = -19, /**< OS error */ - - ERR_ACCESS_DENIED = -20, /**< Access denied */ - ERR_INVALID_OPERATION = -21, /**< Invalid operation */ - ERR_DBUS_ERROR = -22, /**< An unexpected D-Bus error occurred */ - ERR_DISCONNECTED = -23, /**< Daemon connection failed */ - ERR_NO_MEMORY = -24, /**< Memory exhausted */ - ERR_INVALID_OBJECT = -25, /**< The object passed to this function was invalid */ - ERR_NO_DAEMON = -26, /**< Daemon not running */ - ERR_INVALID_INTERFACE = -27, /**< Invalid interface */ - ERR_INVALID_PROTOCOL = -28, /**< Invalid protocol */ - ERR_INVALID_FLAGS = -29, /**< Invalid flags */ - - ERR_NOT_FOUND = -30, /**< Not found */ - ERR_INVALID_CONFIG = -31, /**< Configuration error */ - ERR_VERSION_MISMATCH = -32, /**< Version mismatch */ - ERR_INVALID_SERVICE_SUBTYPE = -33, /**< Invalid service subtype */ - ERR_INVALID_PACKET = -34, /**< Invalid packet */ - ERR_INVALID_DNS_ERROR = -35, /**< Invalid DNS return code */ - ERR_DNS_FORMERR = -36, /**< DNS Error: Form error */ - ERR_DNS_SERVFAIL = -37, /**< DNS Error: Server Failure */ - ERR_DNS_NXDOMAIN = -38, /**< DNS Error: No such domain */ - ERR_DNS_NOTIMP = -39, /**< DNS Error: Not implemented */ - - ERR_DNS_REFUSED = -40, /**< DNS Error: Operation refused */ - ERR_DNS_YXDOMAIN = -41, - ERR_DNS_YXRRSET = -42, - ERR_DNS_NXRRSET = -43, - ERR_DNS_NOTAUTH = -44, /**< DNS Error: Not authorized */ - ERR_DNS_NOTZONE = -45, - ERR_INVALID_RDATA = -46, /**< Invalid RDATA */ - ERR_INVALID_DNS_CLASS = -47, /**< Invalid DNS class */ - ERR_INVALID_DNS_TYPE = -48, /**< Invalid DNS type */ - ERR_NOT_SUPPORTED = -49, /**< Not supported */ - - ERR_NOT_PERMITTED = -50, /**< Operation not permitted */ - ERR_INVALID_ARGUMENT = -51, /**< Invalid argument */ - ERR_IS_EMPTY = -52, /**< Is empty */ - ERR_NO_CHANGE = -53, /**< The requested operation is invalid because it is redundant */ - - ERR_MAX = -54 + OK = 0, ///< OK + ERR_FAILURE = -1, ///< Generic error code + ERR_BAD_STATE = -2, ///< Object was in a bad state + ERR_INVALID_HOST_NAME = -3, ///< Invalid host name + ERR_INVALID_DOMAIN_NAME = -4, ///< Invalid domain name + ERR_NO_NETWORK = -5, ///< No suitable network protocol available + ERR_INVALID_TTL = -6, ///< Invalid DNS TTL + ERR_IS_PATTERN = -7, ///< RR key is pattern + ERR_COLLISION = -8, ///< Name collision + ERR_INVALID_RECORD = -9, ///< Invalid RR + + ERR_INVALID_SERVICE_NAME = -10, ///< Invalid service name + ERR_INVALID_SERVICE_TYPE = -11, ///< Invalid service type + ERR_INVALID_PORT = -12, ///< Invalid port number + ERR_INVALID_KEY = -13, ///< Invalid key + ERR_INVALID_ADDRESS = -14, ///< Invalid address + ERR_TIMEOUT = -15, ///< Timeout reached + ERR_TOO_MANY_CLIENTS = -16, ///< Too many clients + ERR_TOO_MANY_OBJECTS = -17, ///< Too many objects + ERR_TOO_MANY_ENTRIES = -18, ///< Too many entries + ERR_OS = -19, ///< OS error + + ERR_ACCESS_DENIED = -20, ///< Access denied + ERR_INVALID_OPERATION = -21, ///< Invalid operation + ERR_DBUS_ERROR = -22, ///< An unexpected D-Bus error occurred + ERR_DISCONNECTED = -23, ///< Daemon connection failed + ERR_NO_MEMORY = -24, ///< Memory exhausted + ERR_INVALID_OBJECT = -25, ///< The object passed to this function was invalid + ERR_NO_DAEMON = -26, ///< Daemon not running + ERR_INVALID_INTERFACE = -27, ///< Invalid interface + ERR_INVALID_PROTOCOL = -28, ///< Invalid protocol + ERR_INVALID_FLAGS = -29, ///< Invalid flags + + ERR_NOT_FOUND = -30, ///< Not found + ERR_INVALID_CONFIG = -31, ///< Configuration error + ERR_VERSION_MISMATCH = -32, ///< Version mismatch + ERR_INVALID_SERVICE_SUBTYPE = -33, ///< Invalid service subtype + ERR_INVALID_PACKET = -34, ///< Invalid packet + ERR_INVALID_DNS_ERROR = -35, ///< Invalid DNS return code + ERR_DNS_FORMERR = -36, ///< DNS Error: Form error + ERR_DNS_SERVFAIL = -37, ///< DNS Error: Server Failure + ERR_DNS_NXDOMAIN = -38, ///< DNS Error: No such domain + ERR_DNS_NOTIMP = -39, ///< DNS Error: Not implemented + + ERR_DNS_REFUSED = -40, ///< DNS Error: Operation refused + ERR_DNS_YXDOMAIN = -41, ///< TODO + ERR_DNS_YXRRSET = -42, ///< TODO + ERR_DNS_NXRRSET = -43, ///< TODO + ERR_DNS_NOTAUTH = -44, ///< DNS Error: Not authorized + ERR_DNS_NOTZONE = -45, ///< TODO + ERR_INVALID_RDATA = -46, ///< Invalid RDATA + ERR_INVALID_DNS_CLASS = -47, ///< Invalid DNS class + ERR_INVALID_DNS_TYPE = -48, ///< Invalid DNS type + ERR_NOT_SUPPORTED = -49, ///< Not supported + + ERR_NOT_PERMITTED = -50, ///< Operation not permitted + ERR_INVALID_ARGUMENT = -51, ///< Invalid argument + ERR_IS_EMPTY = -52, ///< Is empty + ERR_NO_CHANGE = -53, ///< The requested operation is invalid because it is redundant + + ERR_MAX = -54 ///< TODO }; constexpr auto IF_UNSPEC = -1; enum proto { - PROTO_INET = 0, /**< IPv4 */ - PROTO_INET6 = 1, /**< IPv6 */ - PROTO_UNSPEC = -1 /**< Unspecified/all protocol(s) */ + PROTO_INET = 0, ///< IPv4 + PROTO_INET6 = 1, ///< IPv6 + PROTO_UNSPEC = -1 ///< Unspecified/all protocol(s) }; enum ServerState { - SERVER_INVALID, /**< Invalid state (initial) */ - SERVER_REGISTERING, /**< Host RRs are being registered */ - SERVER_RUNNING, /**< All host RRs have been established */ - SERVER_COLLISION, /**< There is a collision with a host RR. All host RRs have been withdrawn, the user should set a new host name via avahi_server_set_host_name() */ - SERVER_FAILURE /**< Some fatal failure happened, the server is unable to proceed */ + SERVER_INVALID, ///< Invalid state (initial) + SERVER_REGISTERING, ///< Host RRs are being registered + SERVER_RUNNING, ///< All host RRs have been established + SERVER_COLLISION, ///< There is a collision with a host RR. All host RRs have been withdrawn, the user should set a new host name via avahi_server_set_host_name() + SERVER_FAILURE ///< Some fatal failure happened, the server is unable to proceed }; enum ClientState { - CLIENT_S_REGISTERING = SERVER_REGISTERING, /**< Server state: REGISTERING */ - CLIENT_S_RUNNING = SERVER_RUNNING, /**< Server state: RUNNING */ - CLIENT_S_COLLISION = SERVER_COLLISION, /**< Server state: COLLISION */ - CLIENT_FAILURE = 100, /**< Some kind of error happened on the client side */ - CLIENT_CONNECTING = 101 /**< We're still connecting. This state is only entered when AVAHI_CLIENT_NO_FAIL has been passed to avahi_client_new() and the daemon is not yet available. */ + CLIENT_S_REGISTERING = SERVER_REGISTERING, ///< Server state: REGISTERING + CLIENT_S_RUNNING = SERVER_RUNNING, ///< Server state: RUNNING + CLIENT_S_COLLISION = SERVER_COLLISION, ///< Server state: COLLISION + CLIENT_FAILURE = 100, ///< Some kind of error happened on the client side + CLIENT_CONNECTING = 101 ///< We're still connecting. This state is only entered when AVAHI_CLIENT_NO_FAIL has been passed to avahi_client_new() and the daemon is not yet available. }; enum EntryGroupState { - ENTRY_GROUP_UNCOMMITED, /**< The group has not yet been committed, the user must still call avahi_entry_group_commit() */ - ENTRY_GROUP_REGISTERING, /**< The entries of the group are currently being registered */ - ENTRY_GROUP_ESTABLISHED, /**< The entries have successfully been established */ - ENTRY_GROUP_COLLISION, /**< A name collision for one of the entries in the group has been detected, the entries have been withdrawn */ - ENTRY_GROUP_FAILURE /**< Some kind of failure happened, the entries have been withdrawn */ + ENTRY_GROUP_UNCOMMITED, ///< The group has not yet been committed, the user must still call avahi_entry_group_commit() + ENTRY_GROUP_REGISTERING, ///< The entries of the group are currently being registered + ENTRY_GROUP_ESTABLISHED, ///< The entries have successfully been established + ENTRY_GROUP_COLLISION, ///< A name collision for one of the entries in the group has been detected, the entries have been withdrawn + ENTRY_GROUP_FAILURE ///< Some kind of failure happened, the entries have been withdrawn }; enum ClientFlags { - CLIENT_IGNORE_USER_CONFIG = 1, /**< Don't read user configuration */ - CLIENT_NO_FAIL = 2 /**< Don't fail if the daemon is not available when avahi_client_new() is called, instead enter CLIENT_CONNECTING state and wait for the daemon to appear */ + CLIENT_IGNORE_USER_CONFIG = 1, ///< Don't read user configuration + CLIENT_NO_FAIL = 2 ///< Don't fail if the daemon is not available when avahi_client_new() is called, instead enter CLIENT_CONNECTING state and wait for the daemon to appear }; /** * @brief Flags for publishing functions. */ enum PublishFlags { - PUBLISH_UNIQUE = 1, /**< For raw records: The RRset is intended to be unique */ - PUBLISH_NO_PROBE = 2, /**< For raw records: Though the RRset is intended to be unique no probes shall be sent */ - PUBLISH_NO_ANNOUNCE = 4, /**< For raw records: Do not announce this RR to other hosts */ - PUBLISH_ALLOW_MULTIPLE = 8, /**< For raw records: Allow multiple local records of this type, even if they are intended to be unique */ - /** \cond fulldocs */ - PUBLISH_NO_REVERSE = 16, /**< For address records: don't create a reverse (PTR) entry */ - PUBLISH_NO_COOKIE = 32, /**< For service records: do not implicitly add the local service cookie to TXT data */ - /** \endcond */ - PUBLISH_UPDATE = 64, /**< Update existing records instead of adding new ones */ - /** \cond fulldocs */ - PUBLISH_USE_WIDE_AREA = 128, /**< Register the record using wide area DNS (i.e. unicast DNS update) */ - PUBLISH_USE_MULTICAST = 256 /**< Register the record using multicast DNS */ - /** \endcond */ + PUBLISH_UNIQUE = 1, ///< For raw records: The RRset is intended to be unique + PUBLISH_NO_PROBE = 2, ///< For raw records: Though the RRset is intended to be unique no probes shall be sent + PUBLISH_NO_ANNOUNCE = 4, ///< For raw records: Do not announce this RR to other hosts + PUBLISH_ALLOW_MULTIPLE = 8, ///< For raw records: Allow multiple local records of this type, even if they are intended to be unique + PUBLISH_NO_REVERSE = 16, ///< For address records: don't create a reverse (PTR) entry + PUBLISH_NO_COOKIE = 32, ///< For service records: do not implicitly add the local service cookie to TXT data + PUBLISH_UPDATE = 64, ///< Update existing records instead of adding new ones + PUBLISH_USE_WIDE_AREA = 128, ///< Register the record using wide area DNS (i.e. unicast DNS update) + PUBLISH_USE_MULTICAST = 256 ///< Register the record using multicast DNS }; using IfIndex = int; diff --git a/src/platform/linux/wayland.cpp b/src/platform/linux/wayland.cpp index 8dcd22c3639..0a9e124cf77 100644 --- a/src/platform/linux/wayland.cpp +++ b/src/platform/linux/wayland.cpp @@ -65,7 +65,7 @@ namespace wl { /** * @brief Waits up to the specified timeout to dispatch new events on the wl_display. * @param timeout The timeout in milliseconds. - * @return true if new events were dispatched or false if the timeout expired. + * @return `true` if new events were dispatched or `false` if the timeout expired. */ bool display_t::dispatch(std::chrono::milliseconds timeout) { diff --git a/src/platform/linux/wayland.h b/src/platform/linux/wayland.h index cff16019252..c2d8d242d33 100644 --- a/src/platform/linux/wayland.h +++ b/src/platform/linux/wayland.h @@ -34,9 +34,9 @@ namespace wl { class dmabuf_t { public: enum status_e { - WAITING, - READY, - REINIT, + WAITING, ///< Waiting for a frame + READY, ///< Frame is ready + REINIT, ///< Reinitialize the frame }; dmabuf_t(dmabuf_t &&) = delete; @@ -154,9 +154,9 @@ namespace wl { public: enum interface_e { - XDG_OUTPUT, - WLR_EXPORT_DMABUF, - MAX_INTERFACES, + XDG_OUTPUT, ///< xdg-output + WLR_EXPORT_DMABUF, ///< Export dmabuf + MAX_INTERFACES, ///< Maximum number of interfaces }; interface_t(interface_t &&) = delete; diff --git a/src/platform/macos/publish.cpp b/src/platform/macos/publish.cpp index eb8823e5020..7eddd634fab 100644 --- a/src/platform/macos/publish.cpp +++ b/src/platform/macos/publish.cpp @@ -21,122 +21,118 @@ namespace avahi { * @brief Error codes used by avahi. */ enum err_e { - OK = 0, /**< OK */ - ERR_FAILURE = -1, /**< Generic error code */ - ERR_BAD_STATE = -2, /**< Object was in a bad state */ - ERR_INVALID_HOST_NAME = -3, /**< Invalid host name */ - ERR_INVALID_DOMAIN_NAME = -4, /**< Invalid domain name */ - ERR_NO_NETWORK = -5, /**< No suitable network protocol available */ - ERR_INVALID_TTL = -6, /**< Invalid DNS TTL */ - ERR_IS_PATTERN = -7, /**< RR key is pattern */ - ERR_COLLISION = -8, /**< Name collision */ - ERR_INVALID_RECORD = -9, /**< Invalid RR */ - - ERR_INVALID_SERVICE_NAME = -10, /**< Invalid service name */ - ERR_INVALID_SERVICE_TYPE = -11, /**< Invalid service type */ - ERR_INVALID_PORT = -12, /**< Invalid port number */ - ERR_INVALID_KEY = -13, /**< Invalid key */ - ERR_INVALID_ADDRESS = -14, /**< Invalid address */ - ERR_TIMEOUT = -15, /**< Timeout reached */ - ERR_TOO_MANY_CLIENTS = -16, /**< Too many clients */ - ERR_TOO_MANY_OBJECTS = -17, /**< Too many objects */ - ERR_TOO_MANY_ENTRIES = -18, /**< Too many entries */ - ERR_OS = -19, /**< OS error */ - - ERR_ACCESS_DENIED = -20, /**< Access denied */ - ERR_INVALID_OPERATION = -21, /**< Invalid operation */ - ERR_DBUS_ERROR = -22, /**< An unexpected D-Bus error occurred */ - ERR_DISCONNECTED = -23, /**< Daemon connection failed */ - ERR_NO_MEMORY = -24, /**< Memory exhausted */ - ERR_INVALID_OBJECT = -25, /**< The object passed to this function was invalid */ - ERR_NO_DAEMON = -26, /**< Daemon not running */ - ERR_INVALID_INTERFACE = -27, /**< Invalid interface */ - ERR_INVALID_PROTOCOL = -28, /**< Invalid protocol */ - ERR_INVALID_FLAGS = -29, /**< Invalid flags */ - - ERR_NOT_FOUND = -30, /**< Not found */ - ERR_INVALID_CONFIG = -31, /**< Configuration error */ - ERR_VERSION_MISMATCH = -32, /**< Version mismatch */ - ERR_INVALID_SERVICE_SUBTYPE = -33, /**< Invalid service subtype */ - ERR_INVALID_PACKET = -34, /**< Invalid packet */ - ERR_INVALID_DNS_ERROR = -35, /**< Invalid DNS return code */ - ERR_DNS_FORMERR = -36, /**< DNS Error: Form error */ - ERR_DNS_SERVFAIL = -37, /**< DNS Error: Server Failure */ - ERR_DNS_NXDOMAIN = -38, /**< DNS Error: No such domain */ - ERR_DNS_NOTIMP = -39, /**< DNS Error: Not implemented */ - - ERR_DNS_REFUSED = -40, /**< DNS Error: Operation refused */ - ERR_DNS_YXDOMAIN = -41, - ERR_DNS_YXRRSET = -42, - ERR_DNS_NXRRSET = -43, - ERR_DNS_NOTAUTH = -44, /**< DNS Error: Not authorized */ - ERR_DNS_NOTZONE = -45, - ERR_INVALID_RDATA = -46, /**< Invalid RDATA */ - ERR_INVALID_DNS_CLASS = -47, /**< Invalid DNS class */ - ERR_INVALID_DNS_TYPE = -48, /**< Invalid DNS type */ - ERR_NOT_SUPPORTED = -49, /**< Not supported */ - - ERR_NOT_PERMITTED = -50, /**< Operation not permitted */ - ERR_INVALID_ARGUMENT = -51, /**< Invalid argument */ - ERR_IS_EMPTY = -52, /**< Is empty */ - ERR_NO_CHANGE = -53, /**< The requested operation is invalid because it is redundant */ - - ERR_MAX = -54 + OK = 0, ///< OK + ERR_FAILURE = -1, ///< Generic error code + ERR_BAD_STATE = -2, ///< Object was in a bad state + ERR_INVALID_HOST_NAME = -3, ///< Invalid host name + ERR_INVALID_DOMAIN_NAME = -4, ///< Invalid domain name + ERR_NO_NETWORK = -5, ///< No suitable network protocol available + ERR_INVALID_TTL = -6, ///< Invalid DNS TTL + ERR_IS_PATTERN = -7, ///< RR key is pattern + ERR_COLLISION = -8, ///< Name collision + ERR_INVALID_RECORD = -9, ///< Invalid RR + + ERR_INVALID_SERVICE_NAME = -10, ///< Invalid service name + ERR_INVALID_SERVICE_TYPE = -11, ///< Invalid service type + ERR_INVALID_PORT = -12, ///< Invalid port number + ERR_INVALID_KEY = -13, ///< Invalid key + ERR_INVALID_ADDRESS = -14, ///< Invalid address + ERR_TIMEOUT = -15, ///< Timeout reached + ERR_TOO_MANY_CLIENTS = -16, ///< Too many clients + ERR_TOO_MANY_OBJECTS = -17, ///< Too many objects + ERR_TOO_MANY_ENTRIES = -18, ///< Too many entries + ERR_OS = -19, ///< OS error + + ERR_ACCESS_DENIED = -20, ///< Access denied + ERR_INVALID_OPERATION = -21, ///< Invalid operation + ERR_DBUS_ERROR = -22, ///< An unexpected D-Bus error occurred + ERR_DISCONNECTED = -23, ///< Daemon connection failed + ERR_NO_MEMORY = -24, ///< Memory exhausted + ERR_INVALID_OBJECT = -25, ///< The object passed to this function was invalid + ERR_NO_DAEMON = -26, ///< Daemon not running + ERR_INVALID_INTERFACE = -27, ///< Invalid interface + ERR_INVALID_PROTOCOL = -28, ///< Invalid protocol + ERR_INVALID_FLAGS = -29, ///< Invalid flags + + ERR_NOT_FOUND = -30, ///< Not found + ERR_INVALID_CONFIG = -31, ///< Configuration error + ERR_VERSION_MISMATCH = -32, ///< Version mismatch + ERR_INVALID_SERVICE_SUBTYPE = -33, ///< Invalid service subtype + ERR_INVALID_PACKET = -34, ///< Invalid packet + ERR_INVALID_DNS_ERROR = -35, ///< Invalid DNS return code + ERR_DNS_FORMERR = -36, ///< DNS Error: Form error + ERR_DNS_SERVFAIL = -37, ///< DNS Error: Server Failure + ERR_DNS_NXDOMAIN = -38, ///< DNS Error: No such domain + ERR_DNS_NOTIMP = -39, ///< DNS Error: Not implemented + + ERR_DNS_REFUSED = -40, ///< DNS Error: Operation refused + ERR_DNS_YXDOMAIN = -41, ///< TODO + ERR_DNS_YXRRSET = -42, ///< TODO + ERR_DNS_NXRRSET = -43, ///< TODO + ERR_DNS_NOTAUTH = -44, ///< DNS Error: Not authorized + ERR_DNS_NOTZONE = -45, ///< TODO + ERR_INVALID_RDATA = -46, ///< Invalid RDATA + ERR_INVALID_DNS_CLASS = -47, ///< Invalid DNS class + ERR_INVALID_DNS_TYPE = -48, ///< Invalid DNS type + ERR_NOT_SUPPORTED = -49, ///< Not supported + + ERR_NOT_PERMITTED = -50, ///< Operation not permitted + ERR_INVALID_ARGUMENT = -51, ///< Invalid argument + ERR_IS_EMPTY = -52, ///< Is empty + ERR_NO_CHANGE = -53, ///< The requested operation is invalid because it is redundant + + ERR_MAX = -54 ///< TODO }; constexpr auto IF_UNSPEC = -1; enum proto { - PROTO_INET = 0, /**< IPv4 */ - PROTO_INET6 = 1, /**< IPv6 */ - PROTO_UNSPEC = -1 /**< Unspecified/all protocol(s) */ + PROTO_INET = 0, ///< IPv4 + PROTO_INET6 = 1, ///< IPv6 + PROTO_UNSPEC = -1 ///< Unspecified/all protocol(s) }; enum ServerState { - SERVER_INVALID, /**< Invalid state (initial) */ - SERVER_REGISTERING, /**< Host RRs are being registered */ - SERVER_RUNNING, /**< All host RRs have been established */ - SERVER_COLLISION, /**< There is a collision with a host RR. All host RRs have been withdrawn, the user should set a new host name via avahi_server_set_host_name() */ - SERVER_FAILURE /**< Some fatal failure happened, the server is unable to proceed */ + SERVER_INVALID, ///< Invalid state (initial) + SERVER_REGISTERING, ///< Host RRs are being registered + SERVER_RUNNING, ///< All host RRs have been established + SERVER_COLLISION, ///< There is a collision with a host RR. All host RRs have been withdrawn, the user should set a new host name via avahi_server_set_host_name() + SERVER_FAILURE ///< Some fatal failure happened, the server is unable to proceed }; enum ClientState { - CLIENT_S_REGISTERING = SERVER_REGISTERING, /**< Server state: REGISTERING */ - CLIENT_S_RUNNING = SERVER_RUNNING, /**< Server state: RUNNING */ - CLIENT_S_COLLISION = SERVER_COLLISION, /**< Server state: COLLISION */ - CLIENT_FAILURE = 100, /**< Some kind of error happened on the client side */ - CLIENT_CONNECTING = 101 /**< We're still connecting. This state is only entered when AVAHI_CLIENT_NO_FAIL has been passed to avahi_client_new() and the daemon is not yet available. */ + CLIENT_S_REGISTERING = SERVER_REGISTERING, ///< Server state: REGISTERING + CLIENT_S_RUNNING = SERVER_RUNNING, ///< Server state: RUNNING + CLIENT_S_COLLISION = SERVER_COLLISION, ///< Server state: COLLISION + CLIENT_FAILURE = 100, ///< Some kind of error happened on the client side + CLIENT_CONNECTING = 101 ///< We're still connecting. This state is only entered when AVAHI_CLIENT_NO_FAIL has been passed to avahi_client_new() and the daemon is not yet available. }; enum EntryGroupState { - ENTRY_GROUP_UNCOMMITED, /**< The group has not yet been committed, the user must still call avahi_entry_group_commit() */ - ENTRY_GROUP_REGISTERING, /**< The entries of the group are currently being registered */ - ENTRY_GROUP_ESTABLISHED, /**< The entries have successfully been established */ - ENTRY_GROUP_COLLISION, /**< A name collision for one of the entries in the group has been detected, the entries have been withdrawn */ - ENTRY_GROUP_FAILURE /**< Some kind of failure happened, the entries have been withdrawn */ + ENTRY_GROUP_UNCOMMITED, ///< The group has not yet been committed, the user must still call avahi_entry_group_commit() + ENTRY_GROUP_REGISTERING, ///< The entries of the group are currently being registered + ENTRY_GROUP_ESTABLISHED, ///< The entries have successfully been established + ENTRY_GROUP_COLLISION, ///< A name collision for one of the entries in the group has been detected, the entries have been withdrawn + ENTRY_GROUP_FAILURE ///< Some kind of failure happened, the entries have been withdrawn }; enum ClientFlags { - CLIENT_IGNORE_USER_CONFIG = 1, /**< Don't read user configuration */ - CLIENT_NO_FAIL = 2 /**< Don't fail if the daemon is not available when avahi_client_new() is called, instead enter CLIENT_CONNECTING state and wait for the daemon to appear */ + CLIENT_IGNORE_USER_CONFIG = 1, ///< Don't read user configuration + CLIENT_NO_FAIL = 2 ///< Don't fail if the daemon is not available when avahi_client_new() is called, instead enter CLIENT_CONNECTING state and wait for the daemon to appear }; /** * @brief Flags for publishing functions. */ enum PublishFlags { - PUBLISH_UNIQUE = 1, /**< For raw records: The RRset is intended to be unique */ - PUBLISH_NO_PROBE = 2, /**< For raw records: Though the RRset is intended to be unique no probes shall be sent */ - PUBLISH_NO_ANNOUNCE = 4, /**< For raw records: Do not announce this RR to other hosts */ - PUBLISH_ALLOW_MULTIPLE = 8, /**< For raw records: Allow multiple local records of this type, even if they are intended to be unique */ - /** \cond fulldocs */ - PUBLISH_NO_REVERSE = 16, /**< For address records: don't create a reverse (PTR) entry */ - PUBLISH_NO_COOKIE = 32, /**< For service records: do not implicitly add the local service cookie to TXT data */ - /** \endcond */ - PUBLISH_UPDATE = 64, /**< Update existing records instead of adding new ones */ - /** \cond fulldocs */ - PUBLISH_USE_WIDE_AREA = 128, /**< Register the record using wide area DNS (i.e. unicast DNS update) */ - PUBLISH_USE_MULTICAST = 256 /**< Register the record using multicast DNS */ - /** \endcond */ + PUBLISH_UNIQUE = 1, ///< For raw records: The RRset is intended to be unique + PUBLISH_NO_PROBE = 2, ///< For raw records: Though the RRset is intended to be unique no probes shall be sent + PUBLISH_NO_ANNOUNCE = 4, ///< For raw records: Do not announce this RR to other hosts + PUBLISH_ALLOW_MULTIPLE = 8, ///< For raw records: Allow multiple local records of this type, even if they are intended to be unique + PUBLISH_NO_REVERSE = 16, ///< For address records: don't create a reverse (PTR) entry + PUBLISH_NO_COOKIE = 32, ///< For service records: do not implicitly add the local service cookie to TXT data + PUBLISH_UPDATE = 64, ///< Update existing records instead of adding new ones + PUBLISH_USE_WIDE_AREA = 128, ///< Register the record using wide area DNS (i.e. unicast DNS update) + PUBLISH_USE_MULTICAST = 256 ///< Register the record using multicast DNS }; using IfIndex = int; diff --git a/src/platform/windows/audio.cpp b/src/platform/windows/audio.cpp index 3e9267b32aa..5dafebf4ca0 100644 --- a/src/platform/windows/audio.cpp +++ b/src/platform/windows/audio.cpp @@ -91,10 +91,10 @@ namespace platf::audio { struct format_t { enum type_e : int { - none, - stereo, - surr51, - surr71, + none, ///< No format + stereo, ///< Stereo + surr51, ///< Surround 5.1 + surr71, ///< Surround 7.1 } type; std::string_view name; @@ -327,8 +327,7 @@ namespace platf::audio { /** * @brief Checks if the default rendering device changed and resets the change flag - * - * @return true if the device changed since last call + * @return `true` if the device changed since last call */ bool check_default_render_device_changed() { @@ -689,9 +688,7 @@ namespace platf::audio { /** * @brief Gets information encoded in the raw sink name - * * @param sink The raw sink name - * * @return A pair of type and the real sink name */ std::pair<format_t::type_e, std::string_view> diff --git a/src/platform/windows/display.h b/src/platform/windows/display.h index 1a3e7b5817f..6e18f57dff2 100644 --- a/src/platform/windows/display.h +++ b/src/platform/windows/display.h @@ -187,12 +187,12 @@ namespace platf::dxgi { util::safe_ptr_v2<std::remove_pointer_t<HANDLE>, BOOL, CloseHandle> timer; typedef enum _D3DKMT_SCHEDULINGPRIORITYCLASS { - D3DKMT_SCHEDULINGPRIORITYCLASS_IDLE, - D3DKMT_SCHEDULINGPRIORITYCLASS_BELOW_NORMAL, - D3DKMT_SCHEDULINGPRIORITYCLASS_NORMAL, - D3DKMT_SCHEDULINGPRIORITYCLASS_ABOVE_NORMAL, - D3DKMT_SCHEDULINGPRIORITYCLASS_HIGH, - D3DKMT_SCHEDULINGPRIORITYCLASS_REALTIME + D3DKMT_SCHEDULINGPRIORITYCLASS_IDLE, ///< Idle priority class + D3DKMT_SCHEDULINGPRIORITYCLASS_BELOW_NORMAL, ///< Below normal priority class + D3DKMT_SCHEDULINGPRIORITYCLASS_NORMAL, ///< Normal priority class + D3DKMT_SCHEDULINGPRIORITYCLASS_ABOVE_NORMAL, ///< Above normal priority class + D3DKMT_SCHEDULINGPRIORITYCLASS_HIGH, ///< High priority class + D3DKMT_SCHEDULINGPRIORITYCLASS_REALTIME ///< Realtime priority class } D3DKMT_SCHEDULINGPRIORITYCLASS; typedef UINT D3DKMT_HANDLE; diff --git a/src/platform/windows/display_vram.cpp b/src/platform/windows/display_vram.cpp index be144c9844f..ee17881c688 100644 --- a/src/platform/windows/display_vram.cpp +++ b/src/platform/windows/display_vram.cpp @@ -1617,10 +1617,10 @@ namespace platf::dxgi { } /** - * @brief Checks that a given codec is supported by the display device. + * @brief Check that a given codec is supported by the display device. * @param name The FFmpeg codec name (or similar for non-FFmpeg codecs). * @param config The codec configuration. - * @return true if supported, false otherwise. + * @return `true` if supported, `false` otherwise. */ bool display_vram_t::is_codec_supported(std::string_view name, const ::video::config_t &config) { diff --git a/src/platform/windows/display_wgc.cpp b/src/platform/windows/display_wgc.cpp index b77c600b8f4..a8f5f7db33f 100644 --- a/src/platform/windows/display_wgc.cpp +++ b/src/platform/windows/display_wgc.cpp @@ -66,7 +66,7 @@ namespace platf::dxgi { } /** - * Initialize the Windows.Graphics.Capture backend. + * @brief Initialize the Windows.Graphics.Capture backend. * @return 0 on success */ int diff --git a/src/platform/windows/misc.cpp b/src/platform/windows/misc.cpp index 624186715b4..8e011541254 100644 --- a/src/platform/windows/misc.cpp +++ b/src/platform/windows/misc.cpp @@ -462,7 +462,7 @@ namespace platf { * @brief Impersonate the current user and invoke the callback function. * @param user_token A handle to the user's token that was obtained from the shell. * @param callback A function that will be executed while impersonating the user. - * @return An `std::error_code` object that will store any error that occurred during the impersonation + * @return Object that will store any error that occurred during the impersonation */ std::error_code impersonate_current_user(HANDLE user_token, std::function<void()> callback) { @@ -496,11 +496,11 @@ namespace platf { } /** - * @brief A function to create a `STARTUPINFOEXW` structure for launching a process. + * @brief Create a `STARTUPINFOEXW` structure for launching a process. * @param file A pointer to a `FILE` object that will be used as the standard output and error for the new process, or null if not needed. * @param job A job object handle to insert the new process into. This pointer must remain valid for the life of this startup info! * @param ec A reference to a `std::error_code` object that will store any error that occurred during the creation of the structure. - * @return A `STARTUPINFOEXW` structure that contains information about how to launch the new process. + * @return A structure that contains information about how to launch the new process. */ STARTUPINFOEXW create_startup_info(FILE *file, HANDLE *job, std::error_code &ec) { @@ -615,7 +615,7 @@ namespace platf { } /** - * @brief This function quotes/escapes an argument according to the Windows parsing convention. + * @brief Quote/escape an argument according to the Windows parsing convention. * @param argument The raw argument to process. * @return An argument string suitable for use by CreateProcess(). */ @@ -655,7 +655,7 @@ namespace platf { } /** - * @brief This function escapes an argument according to cmd's parsing convention. + * @brief Escape an argument according to cmd's parsing convention. * @param argument An argument already escaped by `escape_argument()`. * @return An argument string suitable for use by cmd.exe. */ @@ -676,7 +676,7 @@ namespace platf { } /** - * @brief This function resolves the given raw command into a proper command string for CreateProcess(). + * @brief Resolve the given raw command into a proper command string for CreateProcess(). * @details This converts URLs and non-executable file paths into a runnable command like ShellExecute(). * @param raw_cmd The raw command provided by the user. * @param working_dir The working directory for the new process. @@ -1702,7 +1702,7 @@ namespace platf { } /** - * @brief Converts a UTF-8 string into a UTF-16 wide string. + * @brief Convert a UTF-8 string into a UTF-16 wide string. * @param string The UTF-8 string. * @return The converted UTF-16 wide string. */ @@ -1734,7 +1734,7 @@ namespace platf { } /** - * @brief Converts a UTF-16 wide string into a UTF-8 string. + * @brief Convert a UTF-16 wide string into a UTF-8 string. * @param string The UTF-16 wide string. * @return The converted UTF-8 string. */ diff --git a/src/platform/windows/misc.h b/src/platform/windows/misc.h index 5a3e29b0257..e97b3ea8931 100644 --- a/src/platform/windows/misc.h +++ b/src/platform/windows/misc.h @@ -22,7 +22,7 @@ namespace platf { qpc_time_difference(int64_t performance_counter1, int64_t performance_counter2); /** - * @brief Converts a UTF-8 string into a UTF-16 wide string. + * @brief Convert a UTF-8 string into a UTF-16 wide string. * @param string The UTF-8 string. * @return The converted UTF-16 wide string. */ @@ -30,7 +30,7 @@ namespace platf { from_utf8(const std::string &string); /** - * @brief Converts a UTF-16 wide string into a UTF-8 string. + * @brief Convert a UTF-16 wide string into a UTF-8 string. * @param string The UTF-16 wide string. * @return The converted UTF-8 string. */ diff --git a/src/process.cpp b/src/process.cpp index 32af14ebd9d..8ada25932d6 100644 --- a/src/process.cpp +++ b/src/process.cpp @@ -53,7 +53,7 @@ namespace proc { }; /** - * @brief Initializes proc functions + * @brief Initialize proc functions * @return Unique pointer to `deinit_t` to manage cleanup */ std::unique_ptr<platf::deinit_t> diff --git a/src/process.h b/src/process.h index c8754992652..42f91cabc72 100644 --- a/src/process.h +++ b/src/process.h @@ -78,7 +78,7 @@ namespace proc { execute(int app_id, std::shared_ptr<rtsp_stream::launch_session_t> launch_session); /** - * @return _app_id if a process is running, otherwise returns 0 + * @return `_app_id` if a process is running, otherwise returns `0` */ int running(); @@ -116,8 +116,8 @@ namespace proc { }; /** - * Calculate a stable id based on name and image data - * @return tuple of id calculated without index (for use if no collision) and one with + * @brief Calculate a stable id based on name and image data + * @return Tuple of id calculated without index (for use if no collision) and one with. */ std::tuple<std::string, std::string> calculate_app_id(const std::string &app_name, std::string app_image_path, int index); diff --git a/src/rtsp.cpp b/src/rtsp.cpp index 044b8fbbe8c..68ebdfd4c0a 100644 --- a/src/rtsp.cpp +++ b/src/rtsp.cpp @@ -95,7 +95,7 @@ namespace rtsp_stream { handle_data_fn { std::move(handle_data_fn) }, sock { ios } {} /** - * @brief Queues an asynchronous read to begin the next message. + * @brief Queue an asynchronous read to begin the next message. */ void read() { @@ -130,7 +130,7 @@ namespace rtsp_stream { } /** - * @brief Handles the initial read of the header of an encrypted message. + * @brief Handle the initial read of the header of an encrypted message. * @param socket The socket the message was received on. * @param ec The error code of the read operation. * @param bytes The number of bytes read. @@ -185,7 +185,7 @@ namespace rtsp_stream { } /** - * @brief Handles the final read of the content of an encrypted message. + * @brief Handle the final read of the content of an encrypted message. * @param socket The socket the message was received on. * @param ec The error code of the read operation. * @param bytes The number of bytes read. @@ -251,7 +251,7 @@ namespace rtsp_stream { } /** - * @brief Queues an asynchronous read of the payload portion of a plaintext message. + * @brief Queue an asynchronous read of the payload portion of a plaintext message. */ void read_plaintext_payload() { @@ -275,7 +275,7 @@ namespace rtsp_stream { } /** - * @brief Handles the read of the payload portion of a plaintext message. + * @brief Handle the read of the payload portion of a plaintext message. * @param socket The socket the message was received on. * @param ec The error code of the read operation. * @param bytes The number of bytes read. @@ -344,7 +344,7 @@ namespace rtsp_stream { } /** - * @brief Handles the read of the header portion of a plaintext message. + * @brief Handle the read of the header portion of a plaintext message. * @param socket The socket the message was received on. * @param ec The error code of the read operation. * @param bytes The number of bytes read. @@ -562,11 +562,9 @@ namespace rtsp_stream { /** * @brief Clear launch sessions. * @param all If true, clear all sessions. Otherwise, only clear timed out and stopped sessions. - * - * EXAMPLES: - * ```cpp + * @examples * clear(false); - * ``` + * @examples_end */ void clear(bool all = true) { diff --git a/src/stream.cpp b/src/stream.cpp index fe62f03e6ed..ec4fa014402 100644 --- a/src/stream.cpp +++ b/src/stream.cpp @@ -73,8 +73,8 @@ using namespace std::literals; namespace stream { enum class socket_e : int { - video, - audio + video, ///< Video + audio ///< Audio }; #pragma pack(push, 1) @@ -288,7 +288,7 @@ namespace stream { iterate(std::chrono::milliseconds timeout); /** - * @brief Calls the handler for a given control stream message. + * @brief Call the handler for a given control stream message. * @param type The message type. * @param session The session the message was received on. * @param payload The payload of the message. @@ -550,7 +550,7 @@ namespace stream { } /** - * @brief Calls the handler for a given control stream message. + * @brief Call the handler for a given control stream message. * @param type The message type. * @param session The session the message was received on. * @param payload The payload of the message. diff --git a/src/stream.h b/src/stream.h index 565ae4ed56e..23055f239fe 100644 --- a/src/stream.h +++ b/src/stream.h @@ -35,10 +35,10 @@ namespace stream { namespace session { enum class state_e : int { - STOPPED, - STOPPING, - STARTING, - RUNNING, + STOPPED, ///< The session is stopped + STOPPING, ///< The session is stopping + STARTING, ///< The session is starting + RUNNING, ///< The session is running }; std::shared_ptr<session_t> diff --git a/src/system_tray.cpp b/src/system_tray.cpp index 06a147f2b3b..91799b2e59b 100644 --- a/src/system_tray.cpp +++ b/src/system_tray.cpp @@ -251,7 +251,7 @@ namespace system_tray { /** * @brief Run the system tray with platform specific options. - * @note macOS requires that UI elements be created on the main thread, so the system tray is not currently implemented for macOS. + * @todo macOS requires that UI elements be created on the main thread, so the system tray is not currently implemented for macOS. */ void run_tray() { diff --git a/src/task_pool.h b/src/task_pool.h index 8da85ed0ac9..2f679582c50 100644 --- a/src/task_pool.h +++ b/src/task_pool.h @@ -114,7 +114,7 @@ namespace task_pool_util { } /** - * @return an id to potentially delay the task. + * @return An id to potentially delay the task. */ template <class Function, class X, class Y, class... Args> auto diff --git a/src/upnp.cpp b/src/upnp.cpp index 2743ebae649..5286384de0a 100644 --- a/src/upnp.cpp +++ b/src/upnp.cpp @@ -95,7 +95,7 @@ namespace upnp { /** * @brief Opens pinholes for IPv6 traffic if the IGD is capable. * @details Not many IGDs support this feature, so we perform error logging with debug level. - * @return true if the pinholes were opened successfully. + * @return `true` if the pinholes were opened successfully. */ bool create_ipv6_pinholes() { diff --git a/src/utility.h b/src/utility.h index 723986c24d8..e37f850b587 100644 --- a/src/utility.h +++ b/src/utility.h @@ -975,7 +975,7 @@ namespace util { #else #error "Unknown Endianness" #endif - big = !little + big = !little ///< big-endian }; }; diff --git a/src/video.cpp b/src/video.cpp index 95783dc725b..9d44d2f012e 100644 --- a/src/video.cpp +++ b/src/video.cpp @@ -53,30 +53,30 @@ namespace video { namespace nv { enum class profile_h264_e : int { - baseline, - main, - high, - high_444p, + baseline, ///< Baseline profile + main, ///< Main profile + high, ///< High profile + high_444p, ///< High 4:4:4 Predictive profile }; enum class profile_hevc_e : int { - main, - main_10, - rext, + main, ///< Main profile + main_10, ///< Main 10 profile + rext, ///< Rext profile }; } // namespace nv namespace qsv { enum class profile_h264_e : int { - baseline = 66, - main = 77, - high = 100, + baseline = 66, ///< Baseline profile + main = 77, ///< Main profile + high = 100, ///< High profile }; enum class profile_hevc_e : int { - main = 1, - main_10 = 2, + main = 1, ///< Main profile + main_10 = 2, ///< Main 10 profile }; } // namespace qsv @@ -264,16 +264,16 @@ namespace video { }; enum flag_e : uint32_t { - DEFAULT = 0, - PARALLEL_ENCODING = 1 << 1, // Capture and encoding can run concurrently on separate threads - H264_ONLY = 1 << 2, // When HEVC is too heavy - LIMITED_GOP_SIZE = 1 << 3, // Some encoders don't like it when you have an infinite GOP_SIZE. *cough* VAAPI *cough* - SINGLE_SLICE_ONLY = 1 << 4, // Never use multiple slices <-- Older intel iGPU's ruin it for everyone else :P - CBR_WITH_VBR = 1 << 5, // Use a VBR rate control mode to simulate CBR - RELAXED_COMPLIANCE = 1 << 6, // Use FF_COMPLIANCE_UNOFFICIAL compliance mode - NO_RC_BUF_LIMIT = 1 << 7, // Don't set rc_buffer_size - REF_FRAMES_INVALIDATION = 1 << 8, // Support reference frames invalidation - ALWAYS_REPROBE = 1 << 9, // This is an encoder of last resort and we want to aggressively probe for a better one + DEFAULT = 0, ///< Default flags + PARALLEL_ENCODING = 1 << 1, ///< Capture and encoding can run concurrently on separate threads + H264_ONLY = 1 << 2, ///< When HEVC is too heavy + LIMITED_GOP_SIZE = 1 << 3, ///< Some encoders don't like it when you have an infinite GOP_SIZE. e.g. VAAPI + SINGLE_SLICE_ONLY = 1 << 4, ///< Never use multiple slices. Older intel iGPU's ruin it for everyone else + CBR_WITH_VBR = 1 << 5, ///< Use a VBR rate control mode to simulate CBR + RELAXED_COMPLIANCE = 1 << 6, ///< Use FF_COMPLIANCE_UNOFFICIAL compliance mode + NO_RC_BUF_LIMIT = 1 << 7, ///< Don't set rc_buffer_size + REF_FRAMES_INVALIDATION = 1 << 8, ///< Support reference frames invalidation + ALWAYS_REPROBE = 1 << 9, ///< This is an encoder of last resort and we want to aggressively probe for a better one }; class avcodec_encode_session_t: public encode_session_t { @@ -957,7 +957,7 @@ namespace video { } /** - * @brief Updates the list of display names before or during a stream. + * @brief Update the list of display names before or during a stream. * @details This will attempt to keep `current_display_index` pointing at the same display. * @param dev_type The encoder device type used for display lookup. * @param display_names The list of display names to repopulate. @@ -2225,7 +2225,7 @@ namespace video { } enum validate_flag_e { - VUI_PARAMS = 0x01, + VUI_PARAMS = 0x01, ///< VUI parameters }; int diff --git a/src/video.h b/src/video.h index ba80474669f..bdc1c360f35 100644 --- a/src/video.h +++ b/src/video.h @@ -83,12 +83,12 @@ namespace video { struct encoder_t { std::string_view name; enum flag_e { - PASSED, // Is supported - REF_FRAMES_RESTRICT, // Set maximum reference frames - CBR, // Some encoders don't support CBR, if not supported --> attempt constant quantatication parameter instead - DYNAMIC_RANGE, // hdr - VUI_PARAMETERS, // AMD encoder with VAAPI doesn't add VUI parameters to SPS - MAX_FLAGS + PASSED, ///< Indicates the encoder is supported. + REF_FRAMES_RESTRICT, ///< Set maximum reference frames. + CBR, ///< Some encoders don't support CBR, if not supported attempt constant quantization parameter instead. + DYNAMIC_RANGE, ///< HDR support. + VUI_PARAMETERS, ///< AMD encoder with VAAPI doesn't add VUI parameters to SPS. + MAX_FLAGS ///< Maximum number of flags. }; static std::string_view diff --git a/tools/audio.cpp b/tools/audio.cpp index 8189438277b..9ba115aa255 100644 --- a/tools/audio.cpp +++ b/tools/audio.cpp @@ -1,6 +1,6 @@ /** * @file tools/audio.cpp - * @brief todo + * @brief Handles collecting audio device information from Windows. */ #define INITGUID #include <audioclient.h> diff --git a/tools/ddprobe.cpp b/tools/ddprobe.cpp index 68b2da87a87..a30b2f417c9 100644 --- a/tools/ddprobe.cpp +++ b/tools/ddprobe.cpp @@ -1,6 +1,6 @@ /** * @file tools/ddprobe.cpp - * @brief todo + * @brief Handles probing for DXGI duplication support. */ #include <d3d11.h> #include <dxgi1_2.h>