diff --git a/.gitignore b/.gitignore
index 2b489e7e1909e87c3b04db78e5e199be98adece8..14d5bbb5d20522b0a4016efa740a9f5792c3a5ae 100644
--- a/.gitignore
+++ b/.gitignore
@@ -28,7 +28,8 @@
*.app
# Build artifacts
-build*/
+/build*/
+/generated-docs/
# Editor
tags
@@ -40,7 +41,7 @@ compile_commands.json
.vscode
# Synapse data
-data/
+/data/
# Deps
.third-party
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
new file mode 100644
index 0000000000000000000000000000000000000000..d06a826b95f4dd09c71fc17a907a566153d19fd6
--- /dev/null
+++ b/.gitlab-ci.yml
@@ -0,0 +1,31 @@
+test-pages:
+ tags: [docker]
+ image: alpine
+ except:
+ - master
+ before_script:
+ - apk update
+ - apk add doxygen git texlive-full py3-jinja2 py3-pygments
+ - git clone git://github.com/mosra/m.css
+ script:
+ - ./m.css/documentation/doxygen.py Doxyfile-mcss
+ - mv generated-docs/html/ public/
+ artifacts:
+ paths:
+ - public
+
+pages:
+ tags: [docker]
+ image: alpine
+ only:
+ - master
+ before_script:
+ - apk update
+ - apk add doxygen git texlive-full py3-jinja2 py3-pygments
+ - git clone git://github.com/mosra/m.css
+ script:
+ - ./m.css/documentation/doxygen.py Doxyfile-mcss
+ - mv generated-docs/html/ public/
+ artifacts:
+ paths:
+ - public
diff --git a/Doxyfile b/Doxyfile
new file mode 100644
index 0000000000000000000000000000000000000000..cd27491ecde771615d715387482be3dfb4451f85
--- /dev/null
+++ b/Doxyfile
@@ -0,0 +1,2580 @@
+# Doxyfile 1.8.20
+
+# 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 (\" \").
+
+#---------------------------------------------------------------------------
+# 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 = mtxclient
+
+# 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 = "Client API library for Matrix, built on top of Boost.Asio"
+
+# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
+# in the documentation. The maximum height of the logo should not exceed 55
+# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
+# the logo to the output directory.
+
+PROJECT_LOGO =
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
+# into which the generated documentation will be written. If a relative path is
+# entered, it will be relative to the location where doxygen was started. If
+# left blank the current directory will be used.
+
+OUTPUT_DIRECTORY = ./generated-docs
+
+# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
+# directories (in 2 levels) under the output directory of each output format and
+# will distribute the generated files over these directories. Enabling this
+# option can be useful when feeding doxygen a huge amount of source files, where
+# putting all generated files in the same directory would otherwise causes
+# performance problems for the file system.
+# The default value is: NO.
+
+CREATE_SUBDIRS = NO
+
+# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
+# characters to appear in the names of generated files. If set to NO, non-ASCII
+# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
+# U+3044.
+# The default value is: NO.
+
+ALLOW_UNICODE_NAMES = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
+# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
+# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
+# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
+# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
+# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
+# Ukrainian and Vietnamese.
+# The default value is: English.
+
+OUTPUT_LANGUAGE = English
+
+# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all generated output in the proper direction.
+# Possible values are: None, LTR, RTL and Context.
+# The default value is: None.
+
+OUTPUT_TEXT_DIRECTION = None
+
+# 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 = YES
+
+# 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 = YES
+
+# 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:\n"
+# will allow you to put the command \sideeffect (or @sideeffect) in the
+# documentation, which will result in a user-defined paragraph with heading
+# "Side Effects:". You can put \n's in the value part of an alias to insert
+# newlines (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++, 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.
+
+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
+
+# 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 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 efficively 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 = 8
+
+#---------------------------------------------------------------------------
+# 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 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
+# 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
+
+# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
+# names in lower-case letters. If set to YES, upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# (including Cygwin) and Mac users are advised to set this option to NO.
+# The default value is: system dependent.
+
+CASE_SENSE_NAMES = NO
+
+# If the HIDE_SCOPE_NAMES tag is set to NO 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_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.
+#
+# 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 not documenting some parameters
+# in a documented function, or documenting parameters that don't exist or using
+# markup commands wrongly.
+# The default value is: YES.
+
+WARN_IF_DOC_ERROR = YES
+
+# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
+# are documented, but have no documentation for their parameters or return
+# value. If set to NO, doxygen will only warn about wrong or incomplete
+# parameter documentation, but not about the absence of documentation. If
+# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
+# The default value is: NO.
+
+WARN_NO_PARAMDOC = NO
+
+# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
+# a warning is encountered.
+# 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)
+# The default value is: $file:$line: $text.
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning and error
+# messages should be written. If left blank the output is written to standard
+# error (stderr).
+
+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 = ./include/ ./docs/ ./README.md
+
+# 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.
+# The default value is: UTF-8.
+
+INPUT_ENCODING = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard 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.
+#
+# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
+# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
+# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
+# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
+# *.doc (to be provided as doxygen C comment), *.txt (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 \
+ *.cpp \
+ *.c++ \
+ *.java \
+ *.ii \
+ *.ixx \
+ *.ipp \
+ *.i++ \
+ *.inl \
+ *.idl \
+ *.ddl \
+ *.odl \
+ *.h \
+ *.hh \
+ *.hxx \
+ *.hpp \
+ *.h++ \
+ *.cs \
+ *.d \
+ *.php \
+ *.php4 \
+ *.php5 \
+ *.phtml \
+ *.inc \
+ *.m \
+ *.markdown \
+ *.md \
+ *.mm \
+ *.dox \
+ *.doc \
+ *.txt \
+ *.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 = YES
+
+# 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,
+# AClass::ANamespace, ANamespace::*Test
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories use the pattern */test/*
+
+EXCLUDE_SYMBOLS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or directories
+# that contain example code fragments that are included (see the \include
+# command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
+# *.h) to filter out the source-files in the directories. If left blank all
+# files are included.
+
+EXAMPLE_PATTERNS = *
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude commands
+# irrespective of the value of the RECURSIVE tag.
+# 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 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 =
+
+#---------------------------------------------------------------------------
+# 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,
+# classes and enums 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
+
+#---------------------------------------------------------------------------
+# 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 COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
+# which the alphabetical index list will be split.
+# Minimum value: 1, maximum value: 20, default value: 5.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all classes will
+# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
+# can be used to specify a prefix (or a list of prefixes) that should be ignored
+# while generating the index headers.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
+# The default value is: YES.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# 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). For an example see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_STYLESHEET =
+
+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the HTML output directory. Note
+# that these files will be copied to the base HTML output directory. Use the
+# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
+# files will be copied as-is; there are no commands or markers available.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_FILES =
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
+# will adjust the colors in the style sheet and background images according to
+# this color. Hue is specified as an angle on a colorwheel, see
+# 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 grayscales only. A
+# value of 255 will produce the most vivid colors.
+# Minimum value: 0, maximum value: 255, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_SAT = 100
+
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
+# luminance component of the colors in the HTML output. Values below 100
+# gradually make the output lighter, whereas values above 100 make the output
+# darker. The value divided by 100 is the actual gamma applied, so 80 represents
+# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
+# change the gamma.
+# Minimum value: 40, maximum value: 240, default value: 80.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_GAMMA = 80
+
+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
+# page will contain the date and time when the page was generated. Setting this
+# to YES can help to show when doxygen was last run and thus if the
+# documentation is up to date.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_TIMESTAMP = NO
+
+# 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
+
+# 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 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
+# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
+# Windows.
+#
+# The HTML Help Workshop contains a compiler that can convert all HTML output
+# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
+# files are now used as the Windows 98 help format, and will replace the old
+# Windows help format (.hlp) on all Windows platforms in the future. Compressed
+# HTML files also contain an index, a table of contents, and you can search for
+# words in the documentation. The HTML workshop also contains a viewer for
+# compressed HTML files.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_HTMLHELP = NO
+
+# 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
+
+# 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 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. 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 = YES
+
+# 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 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
+
+# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
+# generated for formulas are transparent PNGs. Transparent PNGs are not
+# supported properly for IE 6.0, but are supported on all modern browsers.
+#
+# Note that when changing this option you need to delete any form_*.png files in
+# the HTML output directory before the changes have effect.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FORMULA_TRANSPARENT = YES
+
+# 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
+
+# When MathJax is enabled you can set the default output format to be used for
+# the MathJax output. See the MathJax site (see:
+# http://docs.mathjax.org/en/latest/output.html) for more details.
+# Possible values are: HTML-CSS (which is slower, but has the best
+# compatibility), NativeMML (i.e. MathML) and SVG.
+# The default value is: HTML-CSS.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_FORMAT = HTML-CSS
+
+# When MathJax is enabled you need to specify the location relative to the HTML
+# output directory using the MATHJAX_RELPATH option. The destination directory
+# should contain the MathJax.js script. For instance, if the mathjax directory
+# is located at the same level as the HTML output directory, then
+# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
+# Content Delivery Network so you can quickly see the result without installing
+# MathJax. However, it is strongly recommended to install a local copy of
+# MathJax from https://www.mathjax.org before deployment.
+# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2
+
+# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
+# extension names that should be enabled during MathJax rendering. For example
+# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_EXTENSIONS =
+
+# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
+# of code that will be used on startup of the MathJax code. See the MathJax site
+# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
+# example see the documentation.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_CODEFILE =
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
+# the HTML output. The underlying search engine uses javascript and DHTML and
+# should work on any modern browser. Note that when using HTML help
+# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
+# there is already a search function so this one should typically be disabled.
+# For large projects the javascript based search engine can be slow, then
+# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
+# search using the keyboard; to jump to the search box use <access key> + S
+# (what the <access key> is depends on the OS and browser, but it is typically
+# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
+# key> to jump into the search results window, the results can be navigated
+# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
+# the search. The filter options can be selected when the cursor is inside the
+# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
+# to select a filter and <Enter> or <escape> to activate or cancel the filter
+# option.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+SEARCHENGINE = YES
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a 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 personal LaTeX header for the
+# generated LaTeX document. The header should contain everything until the first
+# chapter. If it is left blank doxygen will generate a standard header. See
+# section "Doxygen usage" for information on how to let doxygen write the
+# default header to a separate file.
+#
+# Note: Only use a user-defined header if you know what you are doing! The
+# following commands have a special meaning inside the header: $title,
+# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
+# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
+# string, for the replacement values of the other commands the user is referred
+# to HTML_HEADER.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HEADER =
+
+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
+# generated LaTeX document. The footer should contain everything after the last
+# chapter. If it is left blank doxygen will generate a standard footer. See
+# LATEX_HEADER for more information on how to generate a default footer and what
+# special commands can be used inside the footer.
+#
+# Note: Only use a user-defined footer if you know what you are doing!
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_FOOTER =
+
+# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# LaTeX style sheets that are included after the standard style sheets created
+# by doxygen. Using this option one can overrule certain style aspects. Doxygen
+# will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list).
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_STYLESHEET =
+
+# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the LATEX_OUTPUT output
+# directory. Note that the files will be copied as-is; there are no commands or
+# markers available.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_FILES =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
+# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
+# contain links (just like the HTML output) instead of page references. This
+# makes the output suitable for online browsing using a PDF viewer.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PDF_HYPERLINKS = YES
+
+# If the USE_PDFLATEX tag is set to YES, 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
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
+# command to the generated LaTeX files. This will instruct LaTeX to keep running
+# if errors occur, instead of asking the user for help. This option is also used
+# when generating formulas in HTML.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BATCHMODE = NO
+
+# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
+# index chapters (such as File Index, Compound Index, etc.) in the output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HIDE_INDICES = NO
+
+# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
+# code with syntax highlighting in the LaTeX output.
+#
+# Note that which sources are shown also depends on other settings such as
+# SOURCE_BROWSER.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_SOURCE_CODE = NO
+
+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
+# bibliography, e.g. plainnat, or ieeetr. 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
+
+# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
+# page will contain the date and time when the page was generated. Setting this
+# to NO can help when comparing the output of multiple runs.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_TIMESTAMP = NO
+
+# 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 =
+
+# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
+# with syntax highlighting in the RTF output.
+#
+# Note that which sources are shown also depends on other settings such as
+# SOURCE_BROWSER.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_SOURCE_CODE = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
+# classes and files.
+# The default value is: NO.
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it. 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 = YES
+
+# 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
+
+# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
+# program listings (including syntax highlighting and cross-referencing
+# information) to the DOCBOOK output. Note that enabling this will significantly
+# increase the size of the DOCBOOK output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_PROGRAMLISTING = NO
+
+#---------------------------------------------------------------------------
+# Configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
+# AutoGen Definitions (see http://autogen.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
+#---------------------------------------------------------------------------
+
+#---------------------------------------------------------------------------
+# 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.
+# 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 class will be listed in
+# the class index. If set to NO, only the inherited external classes will be
+# listed.
+# The default value is: NO.
+
+ALLEXTERNALS = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will be
+# listed.
+# The default value is: YES.
+
+EXTERNAL_GROUPS = YES
+
+# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
+# the related pages index. If set to NO, only the current project's pages will
+# be listed.
+# The default value is: YES.
+
+EXTERNAL_PAGES = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
+# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
+# NO turns the diagrams off. Note that this option also works with HAVE_DOT
+# disabled, but it is recommended to install and use dot, since it yields more
+# powerful graphs.
+# The default value is: YES.
+
+CLASS_DIAGRAMS = YES
+
+# You can include diagrams made with dia in doxygen documentation. Doxygen will
+# then run dia to produce the diagram and insert it in the documentation. The
+# DIA_PATH tag allows you to specify the directory where the dia binary resides.
+# If left empty dia is assumed to be found in the default search path.
+
+DIA_PATH =
+
+# If set to YES the inheritance and collaboration graphs will hide inheritance
+# and usage relations if the target is undocumented or is not a class.
+# The default value is: YES.
+
+HIDE_UNDOC_RELATIONS = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz (see:
+# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
+# Bell Labs. The other options in this section have no effect if this option is
+# set to NO
+# The default value is: NO.
+
+HAVE_DOT = 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
+
+# When you want a differently looking font in the dot files that doxygen
+# generates you can specify the font name using DOT_FONTNAME. You need to make
+# sure dot is able to find the font, which can be done by putting it in a
+# standard location or by setting the DOTFONTPATH environment variable or by
+# setting DOT_FONTPATH to the directory containing the font.
+# The default value is: Helvetica.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTNAME = Helvetica
+
+# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
+# dot graphs.
+# Minimum value: 4, maximum value: 24, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTSIZE = 10
+
+# By default doxygen will tell dot to use the default font as specified with
+# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
+# the path where dot can find it using this tag.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTPATH =
+
+# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
+# each documented class showing the direct and indirect inheritance relations.
+# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CLASS_GRAPH = YES
+
+# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
+# graph for each documented class showing the direct and indirect implementation
+# dependencies (inheritance, containment, and class references variables) of the
+# class with other documented classes.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+COLLABORATION_GRAPH = YES
+
+# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
+# groups, showing the direct groups dependencies.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GROUP_GRAPHS = YES
+
+# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LOOK = NO
+
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
+# class node. If there are many fields or methods and many nodes the graph may
+# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
+# number of items for each type to make the size more manageable. Set this to 0
+# for no limit. Note that the threshold may be exceeded by 50% before the limit
+# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
+# but if the number exceeds 15, the total amount of fields shown is limited to
+# 10.
+# Minimum value: 0, maximum value: 100, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LIMIT_NUM_FIELDS = 10
+
+# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
+# collaboration graphs will show the relations between templates and their
+# instances.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+TEMPLATE_RELATIONS = NO
+
+# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
+# YES then doxygen will generate a graph for each documented file showing the
+# direct and indirect include dependencies of the file with other documented
+# files.
+# 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.
+# 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.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DIRECTORY_GRAPH = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. For an explanation of the image formats see the section
+# output formats in the documentation of the dot tool (Graphviz (see:
+# http://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 =
+
+# The MSCFILE_DIRS tag can be used to specify one or more directories that
+# contain msc files that are included in the documentation (see the \mscfile
+# command).
+
+MSCFILE_DIRS =
+
+# The DIAFILE_DIRS tag can be used to specify one or more directories that
+# contain dia files that are included in the documentation (see the \diafile
+# command).
+
+DIAFILE_DIRS =
+
+# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
+# path where java can find the plantuml.jar file. If left blank, it is assumed
+# PlantUML is not used or called during a preprocessing step. Doxygen will
+# generate a warning when it encounters a \startuml command in this case and
+# will not generate output for the diagram.
+
+PLANTUML_JAR_PATH =
+
+# When using plantuml, the 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_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, because dot on Windows does not seem
+# to support this out of the box.
+#
+# Warning: Depending on the platform used, enabling this option may lead to
+# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
+# read).
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_TRANSPARENT = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES 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.
+# 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 dot
+# files that are used to generate the various graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_CLEANUP = YES
diff --git a/Doxyfile-mcss b/Doxyfile-mcss
new file mode 100644
index 0000000000000000000000000000000000000000..b360ed3378f076cfe3d073e04e97c13df004997b
--- /dev/null
+++ b/Doxyfile-mcss
@@ -0,0 +1,4 @@
+@INCLUDE = Doxyfile
+GENERATE_HTML = NO
+GENERATE_XML = YES
+XML_PROGRAMLISTING = NO
diff --git a/docs/dirs.dox b/docs/dirs.dox
new file mode 100644
index 0000000000000000000000000000000000000000..6aac0a8b764d70b2f51c7ac2e0280020e4d4812e
--- /dev/null
+++ b/docs/dirs.dox
@@ -0,0 +1,29 @@
+/// @dir include
+/// @brief Include directory. Add this to your include path.
+
+/// @dir include/mtxclient
+/// @brief The root directory for all the client callbacks.
+
+/// @dir include/mtxclient/http
+/// @brief Functions to invoke the API over HTTP.
+
+/// @dir include/mtxclient/crypto
+/// @brief Wrappers around the olm library as well as other encryption specific
+/// functionality.
+
+/// @dir include/mtx
+/// @brief The root directory for all the type definitions listed in the
+/// specifications.
+
+/// @dir include/mtx/events
+/// @brief The different event types in the Matrix API.
+
+/// @dir include/mtx/events/messages
+/// @brief The different types, that can be sent as a message event.
+
+/// @dir include/mtx/events/nheko_extensions
+/// @brief Nheko specific event types not part of the official specification.
+
+/// @dir include/mtx/responses
+/// @brief The reponses returned from each request.
+
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000000000000000000000000000000000000..0440fb521a6fcaa305cc89cc8eed805a0b1dfbdf
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,21 @@
+mtxclient {#mainpage}
+=====================
+
+mtxclient is a library for the [Matrix protocol](https://matrix.org/) used
+primarily in the [Nheko client](https://nheko.im/nheko-reborn/nheko). This
+library is not a full SDK. Rather it is a thin wrapper providing functions and
+data structures to access the [Client-Server
+API](https://matrix.org/docs/spec/client_server/latest). Most of the semantics
+are described there and this library provides similarly named types and function
+to invoke those endpoints.
+
+mtxclient is built on top of
+[Boost.Asio](https://www.boost.org/doc/libs/1_75_0/doc/html/boost_asio.html) and
+[nlohmann/json](https://github.com/nlohmann/json). Many of the data structures
+in this library can be serialized to and deserialized from JSON. Most endpoints
+use a callback to inform the caller, if the request completed and what the
+response was.
+
+## Building
+
+For build instructions please refer to the [README](README.md).
diff --git a/include/mtx.hpp b/include/mtx.hpp
index 4a79c9714b50adefb745529eb585f16a0112a647..4eb600baa0c2d57f98c69857ec9424ed25d440e8 100644
--- a/include/mtx.hpp
+++ b/include/mtx.hpp
@@ -1,5 +1,9 @@
#pragma once
+/// @file
+/// @brief A header including pretty much all the headers of the library.
+/// Including this will have a significant compile time cost.
+
#include "mtx/identifiers.hpp"
#include "mtx/events.hpp"
diff --git a/include/mtx/common.hpp b/include/mtx/common.hpp
index 31ca50934fa0a32fb39250cfec3dab6794537e0f..70629c427fcb80a5e731cf36a9fe5ad13edba584 100644
--- a/include/mtx/common.hpp
+++ b/include/mtx/common.hpp
@@ -10,7 +10,8 @@
#include <string>
#include <vector>
-//! Common types used by the crypto related endpoints.
+/// @file
+/// @brief Common types used by the crypto related endpoints.
namespace mtx {
namespace crypto {
diff --git a/include/mtx/errors.hpp b/include/mtx/errors.hpp
index 1dd8127f2e022031dc095dd23aa82a01c5fb7258..06e44be7931acd06324e4079cbdfabb7ae5cab7c 100644
--- a/include/mtx/errors.hpp
+++ b/include/mtx/errors.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief The error struct returned by the Matrix API.
+
#include "lightweight_error.hpp"
#include "user_interactive.hpp"
diff --git a/include/mtx/events.hpp b/include/mtx/events.hpp
index 36bb8384ed9c5053f9e4c179cb54df3f84bc5b83..b45b8a758b94737f62c97fca207bdbe3dbe04d8e 100644
--- a/include/mtx/events.hpp
+++ b/include/mtx/events.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Basetypes for events. Content is defined elsewhere.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
diff --git a/include/mtx/events/aliases.hpp b/include/mtx/events/aliases.hpp
index 64a68c4c302d908b29cba2bf005f28cc51364acb..cf07d17921acade9f9a675316c6643b368d7a3a9 100644
--- a/include/mtx/events/aliases.hpp
+++ b/include/mtx/events/aliases.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Alias events.
+
#include <string>
#include <vector>
diff --git a/include/mtx/events/avatar.hpp b/include/mtx/events/avatar.hpp
index 1a7c7e1a6b7547c5487b468453e705f11812813f..1c7fcdcc3409bb91c7110f9447f0cd64b375faa6 100644
--- a/include/mtx/events/avatar.hpp
+++ b/include/mtx/events/avatar.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Room avatar events.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
diff --git a/include/mtx/events/canonical_alias.hpp b/include/mtx/events/canonical_alias.hpp
index ed19abd558bd64753b8ff2d86395f59f986929a8..9005811895f6f825c650e42f231a9f41e3d61934 100644
--- a/include/mtx/events/canonical_alias.hpp
+++ b/include/mtx/events/canonical_alias.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Change the canonical or listed avatars of a room.
+
#include <string>
#if __has_include(<nlohmann/json_fwd.hpp>)
diff --git a/include/mtx/events/collections.hpp b/include/mtx/events/collections.hpp
index 5378f1af3b362372545bc48e416c1a047a520043..dcd0bc730880e1fb836ad57af8f9045aca0728d6 100644
--- a/include/mtx/events/collections.hpp
+++ b/include/mtx/events/collections.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Collections to store multiple events of different types
+
#include <variant>
#include "mtx/events.hpp"
@@ -141,6 +144,7 @@ using TimelineEvents = std::variant<events::StateEvent<states::Aliases>,
events::RoomEvent<msgs::CallAnswer>,
events::RoomEvent<msgs::CallHangUp>>;
+//! A wapper around TimelineEvent, that produces less noisy compiler errors.
struct TimelineEvent
{
TimelineEvents data;
@@ -151,6 +155,7 @@ from_json(const json &obj, TimelineEvent &e);
} // namespace collections
+//! Get the right event type for some type of message content.
template<typename Content>
constexpr inline EventType message_content_to_type = EventType::Unsupported;
@@ -195,6 +200,7 @@ template<>
constexpr inline EventType message_content_to_type<mtx::events::msg::CallHangUp> =
EventType::CallHangUp;
+//! Get the right event type for some type of state event content.
template<typename Content>
constexpr inline EventType state_content_to_type = EventType::Unsupported;
@@ -239,6 +245,7 @@ constexpr inline EventType state_content_to_type<mtx::events::state::Tombstone>
template<>
constexpr inline EventType state_content_to_type<mtx::events::state::Topic> = EventType::RoomTopic;
+//! Get the right event type for some type of device message content.
template<typename Content>
constexpr inline EventType to_device_content_to_type = EventType::Unsupported;
diff --git a/include/mtx/events/common.hpp b/include/mtx/events/common.hpp
index ea6cd4afa212f83f17f0059f488bb3d3ff6d8198..9da0c615acef8653f0781a25fdc49c3f5b6a8244 100644
--- a/include/mtx/events/common.hpp
+++ b/include/mtx/events/common.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Structs used in multiple different event types.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
diff --git a/include/mtx/events/create.hpp b/include/mtx/events/create.hpp
index 69cf3831fae7729439e5e5183c3eb7d4276de577..ff0422bfc425be9a96ae591d00eabc43bd3574b6 100644
--- a/include/mtx/events/create.hpp
+++ b/include/mtx/events/create.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief The first event in a room.
+
#include <optional>
#if __has_include(<nlohmann/json_fwd.hpp>)
@@ -11,7 +14,7 @@
namespace mtx {
namespace events {
namespace state {
-
+//! The predecessor of this room.
struct PreviousRoom
{
//! Required. The ID of the old room.
diff --git a/include/mtx/events/encrypted.hpp b/include/mtx/events/encrypted.hpp
index 7c2babe980ad4a4e7d251a6aeceb9fc0c248dc39..246416908ef78ac23490248ddb31c69d03eda0e8 100644
--- a/include/mtx/events/encrypted.hpp
+++ b/include/mtx/events/encrypted.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Various event types used in E2EE.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -14,10 +17,11 @@ namespace mtx {
namespace events {
namespace msg {
+//! Display methods for Short Authentication Strings
enum class SASMethods
{
- Decimal,
- Emoji,
+ Decimal, //!< Display 3 times 4 digits
+ Emoji, //! Display 7 emoji
Unsupported
};
@@ -27,12 +31,11 @@ from_json(const nlohmann::json &obj, SASMethods &method);
void
to_json(nlohmann::json &obj, const SASMethods &method);
-//! TODO: Implement more if the verification methods ever change in KeyVerificationAccept
-//! or otherwise
+//! The different verification methods
enum class VerificationMethods
{
- SASv1,
- Unsupported
+ SASv1, //!< Short Authentication Strings
+ Unsupported //!< Unsupported method
};
void
@@ -41,9 +44,15 @@ from_json(const nlohmann::json &obj, VerificationMethods &method);
void
to_json(nlohmann::json &obj, const VerificationMethods &method);
+//! Content of an individual message encrypted for a certain key.
struct OlmCipherContent
{
+ //! Ciphertext of the message.
std::string body;
+ /// @brief Olm message type.
+ ///
+ /// `0` for initial pre-key messages.
+ /// `1` for normal messages after the initial exchange.
uint8_t type;
};
@@ -56,10 +65,13 @@ to_json(nlohmann::json &obj, const OlmCipherContent &event);
//! Content of the `m.room.encrypted` Olm event.
struct OlmEncrypted
{
+ //! Algorithm used for encrypting this event.
std::string algorithm;
+ //! curve25519 key of the sender.
std::string sender_key;
using RecipientKey = std::string;
+ //! Map of recipient curve25519 key to the encrypted message.
std::map<RecipientKey, OlmCipherContent> ciphertext;
};
@@ -98,10 +110,13 @@ to_json(nlohmann::json &obj, const Encrypted &event);
//! Content of the `m.room_key` event.
struct RoomKey
{
+ /// @brief *Required.* The encryption algorithm the key in this event is to be used with.
+ ///
+ /// Must be 'm.megolm.v1.aes-sha2'.
std::string algorithm;
- std::string room_id;
- std::string session_id;
- std::string session_key;
+ std::string room_id; //!< *Required.* The room where the key is used.
+ std::string session_id; //!< *Required.* The ID of the session that the key is for.
+ std::string session_key; //!< *Required.* The key to be exchanged.
};
void
@@ -113,12 +128,26 @@ to_json(nlohmann::json &obj, const RoomKey &event);
//! Content of the `m.forwarded_room_key` event.
struct ForwardedRoomKey
{
+ /// @brief *Required.* The encryption algorithm the key in this event is to be used with.
std::string algorithm;
- std::string room_id;
- std::string session_id;
- std::string session_key;
+ std::string room_id; //!< *Required.* The room where the key is used.
+ std::string session_id; //!< *Required.* The ID of the session that the key is for.
+ std::string session_key; //!< *Required.* The key to be exchanged.
+
+ //! *Required.* The Curve25519 key of the device which initiated the session originally.
std::string sender_key;
+ /// @brief *Required.* The Ed25519 key of the device which initiated the session originally.
+ ///
+ /// It is 'claimed' because the receiving device has no way to tell that the original
+ /// room_key actually came from a device which owns the private part of this key unless they
+ /// have done device verification.
std::string sender_claimed_ed25519_key;
+ /// @brief *Required.* Chain of Curve25519 keys.
+ ///
+ /// It starts out empty, but each time the key is forwarded to another device, the previous
+ /// sender in the chain is added to the end of the list. For example, if the key is
+ /// forwarded from A to B to C, this field is empty between A and B, and contains A's
+ /// Curve25519 key between B and C.
std::vector<std::string> forwarding_curve25519_key_chain;
};
@@ -128,14 +157,12 @@ from_json(const nlohmann::json &obj, ForwardedRoomKey &event);
void
to_json(nlohmann::json &obj, const ForwardedRoomKey &event);
+//! The type of key request.
enum class RequestAction
{
- // request
- Request,
- // request_cancellation
- Cancellation,
- // not handled
- Unknown,
+ Request, //!< request
+ Cancellation, //!< request_cancellation
+ Unknown, //!< Unknown request action
};
void
@@ -144,13 +171,15 @@ from_json(const nlohmann::json &obj, RequestAction &action);
void
to_json(nlohmann::json &obj, const RequestAction &action);
+//! A request to share a session key.
struct KeyRequest
{
//! The type of request.
RequestAction action;
- //! The encryption algorithm of the session we want keys for.
- //! Always m.megolm.v1.aes-sha2.
+ /// @brief The encryption algorithm of the session we want keys for.
+ ///
+ /// Always m.megolm.v1.aes-sha2.
std::string algorithm;
//! The room in which the session was created.
std::string room_id;
@@ -204,31 +233,44 @@ struct KeyVerificationStart
{
//! The device ID which is initiating the process.
std::string from_device;
- //! An opaque identifier for the verification process. Must be unique with respect to the
- //! devices involved. Must be the same as the transaction_id given in the
- //! m.key.verification.request if this process is originating from a request.
+ /// @brief An opaque identifier for the verification process.
+ ///
+ /// Must be unique with respect to the devices involved. Must be the same as the
+ /// transaction_id given in the `m.key.verification.request` if this process is originating
+ /// from a request.
+ /// @note Used in verification via to_device messaging
std::optional<std::string> transaction_id;
//! The verification method to use. Must be 'm.sas.v1'
VerificationMethods method = VerificationMethods::SASv1;
- //! Optional method to use to verify the other user's key with. Applicable when the method
- //! chosen only verifies one user's key. This field will never be present if the method
- //! verifies keys both ways.
- //! NOTE: This appears to be unused in SAS verification
+ /// @brief Optional method to use to verify the other user's key with.
+ //
+ // Applicable when the method chosen only verifies one user's key. This field will never be
+ // present if the method verifies keys both ways.
+ /// @note This appears to be unused in SAS verification
std::optional<std::string> next_method;
- //! The key agreement protocols the sending device understands.
- //! Must include at least curve25519.
+ /// @brief The key agreement protocols the sending device understands.
+ ///
+ /// Must include at least curve25519.
std::vector<std::string> key_agreement_protocols;
//! The hash methods the sending device understands. Must include at least sha256.
std::vector<std::string> hashes;
- //! The message authentication codes that the sending device understands.
- //! Must include at least hkdf-hmac-sha256.
+ /// @brief The message authentication codes that the sending device understands.
+ ///
+ /// Must include at least hkdf-hmac-sha256.
std::vector<std::string> message_authentication_codes;
- //! The SAS methods the sending device (and the sending device's user) understands.
- //! Must include at least decimal. Optionally can include emoji.
- //! One of: ["decimal", "emoji"]
+ /// @brief The SAS methods the sending device (and the sending device's user) understands.
+ ///
+ /// Must include at least decimal. Optionally can include emoji.
+ ///
+ /// One of:
+ /// - `decimal`
+ /// - `emoji`
std::vector<SASMethods> short_authentication_string;
- //! this is used for relating this message with previously sent key.verification.request
- //! will be used only for room-verification msgs where this is used in place of txnid
+ /// @brief This is used for relating this message with previously sent
+ /// `key.verification.request`
+ ///
+ /// @note Will be used only for room-verification msgs where this is used in place of
+ /// transaction_id.
std::optional<mtx::common::RelatesTo> relates_to;
};
@@ -247,8 +289,9 @@ struct KeyVerificationReady
std::optional<std::string> transaction_id;
//! Sends the user the supported methods
std::vector<VerificationMethods> methods;
- //! this is used for relating this message with previously sent key.verification.request
- //! will be used only for room-verification msgs where this is used in place of txnid
+ //! this is used for relating this message with previously sent
+ //! key.verification.request will be used only for room-verification msgs where this
+ //! is used in place of txnid
std::optional<mtx::common::RelatesTo> relates_to;
};
diff --git a/include/mtx/events/encryption.hpp b/include/mtx/events/encryption.hpp
index 42d0c8f1368a8266b61cc8f0b96f41ed8590b6b0..fbf8b0ee0bd88149f582be822bbf6658253dc047 100644
--- a/include/mtx/events/encryption.hpp
+++ b/include/mtx/events/encryption.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief The event enabling encryption in a room.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
diff --git a/include/mtx/events/event_type.hpp b/include/mtx/events/event_type.hpp
index 2a8fd4559cb2336e7a2728ec14346f051f0cda03..72945258359c5702c8c3df1730dcbc16ca0b01ff 100644
--- a/include/mtx/events/event_type.hpp
+++ b/include/mtx/events/event_type.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Enumeration of all event types
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -10,6 +13,7 @@
namespace mtx {
namespace events {
+//! The type of an event.
enum class EventType
{
/// m.key.verification.cancel
@@ -100,12 +104,15 @@ enum class EventType
Unsupported,
};
+//! Turn an event into a string
std::string
to_string(EventType type);
+//! Parse a string into an event type.
EventType
getEventType(const std::string &type);
+//! Get the event type of an event.
EventType
getEventType(const nlohmann::json &obj);
}
diff --git a/include/mtx/events/guest_access.hpp b/include/mtx/events/guest_access.hpp
index 2718f82431683c75d7bb4552fb1d79f4de464dbc..0effd617b4e24f33c968524ca795108397ab4df3 100644
--- a/include/mtx/events/guest_access.hpp
+++ b/include/mtx/events/guest_access.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief An event describing, if guest accounts can join a room.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -12,10 +15,11 @@ namespace mtx {
namespace events {
namespace state {
+//! The different access states for a room.
enum class AccessState
{
- CanJoin,
- Forbidden,
+ CanJoin, //! Joining is allowd (for guests)
+ Forbidden, //! Guests can't join.
};
//! Converts @p AccessState to @p std::string for serialization.
diff --git a/include/mtx/events/history_visibility.hpp b/include/mtx/events/history_visibility.hpp
index ddc8cc4a5838c42685bbf6d0801f6d4762f655df..897df3f4c774a429ff8d4a0255b751bb6224d7ff 100644
--- a/include/mtx/events/history_visibility.hpp
+++ b/include/mtx/events/history_visibility.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief State event describing the visibility of the history.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -11,7 +14,7 @@
namespace mtx {
namespace events {
namespace state {
-
+//! The different visibilities.
enum class Visibility
{
//! All events while this is the `m.room.history_visibility`
diff --git a/include/mtx/events/join_rules.hpp b/include/mtx/events/join_rules.hpp
index 63473fd28197c1e95e7257cf8ce4465a429153af..989b1c038a6b83459f7b0ab0f502a1340d1e3bfa 100644
--- a/include/mtx/events/join_rules.hpp
+++ b/include/mtx/events/join_rules.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Manage the permission of how people can join a room.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -11,7 +14,7 @@
namespace mtx {
namespace events {
namespace state {
-
+//! The different JoinRules
enum class JoinRule
{
//! Anyone can join the room without any prior action.
diff --git a/include/mtx/events/member.hpp b/include/mtx/events/member.hpp
index 25fb66a9bf5423477f629ca59212294c9194aba2..d5e49950e1f4715e80602729b389fc7ac81d7c78 100644
--- a/include/mtx/events/member.hpp
+++ b/include/mtx/events/member.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief The state event describing the membership status of a specific member.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -11,7 +14,7 @@
namespace mtx {
namespace events {
namespace state {
-
+//! The different Membership states.
enum class Membership
{
//! The user has joined.
diff --git a/include/mtx/events/messages/audio.hpp b/include/mtx/events/messages/audio.hpp
index 501ff94e0b789d2250266b4a6b447eaaff5a1913..0c7207cfbf424f89f879e6e68df28e2f39b740f1 100644
--- a/include/mtx/events/messages/audio.hpp
+++ b/include/mtx/events/messages/audio.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Audio messages.
+
#include <optional>
#include <string>
@@ -16,18 +19,19 @@ namespace mtx {
namespace events {
namespace msg {
+//! Content of `m.room.message` with msgtype `m.audio`.
struct Audio
{
- // A description of the audio or some kind of content description
- // for accessibility.
+ /// @brief A description of the audio or some kind of content description
+ /// for accessibility.
std::string body;
- // Must be 'm.audio'.
+ //! Must be 'm.audio'.
std::string msgtype;
- // The matrix URL of the audio clip.
+ //! The matrix URL of the audio clip.
std::string url;
- // Metadata for the audio clip referred to in url.
+ //! Metadata for the audio clip referred to in url.
mtx::common::AudioInfo info;
- // Encryption members. If present, they replace url.
+ //! Encryption members. If present, they replace url.
std::optional<crypto::EncryptedFile> file;
//! Relates to for rich replies
mtx::common::ReplyRelatesTo relates_to;
diff --git a/include/mtx/events/messages/emote.hpp b/include/mtx/events/messages/emote.hpp
index 6061c7cbf7231a826d161b962e9e4aadb03091b6..5ab5d2a5b527b2774ddafe9ff26348fa08778911 100644
--- a/include/mtx/events/messages/emote.hpp
+++ b/include/mtx/events/messages/emote.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Events describing an emotion or action.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -14,6 +17,7 @@ namespace mtx {
namespace events {
namespace msg {
+//! Content of `m.room.message` with msgtype `m.emote`.
struct Emote
{
// The emote action to perform.
diff --git a/include/mtx/events/messages/file.hpp b/include/mtx/events/messages/file.hpp
index c029e9cd8eded757033ef00672bda8e8ac79a911..baa794fccd05ddcd9f2c983995c46603160ad541 100644
--- a/include/mtx/events/messages/file.hpp
+++ b/include/mtx/events/messages/file.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief A file sent in a room.
+
#include <optional>
#include <string>
@@ -16,21 +19,24 @@ namespace mtx {
namespace events {
namespace msg {
+//! Content of `m.room.message` with msgtype `m.file`.
struct File
{
- // A human-readable description of the file. This is recommended to
- // be the filename of the original upload.
+ /// @brief A human-readable description of the file.
+ ///
+ /// This is recommended to be the filename of the original upload.
std::string body;
- // The original filename of the uploaded file.
- // SPEC_BUG: The filename is not really required.
+ /// @brief The original filename of the uploaded file.
+ ///
+ /// SPEC_BUG: The filename is not really required.
std::string filename;
- // Must be 'm.file'.
+ //! Must be 'm.file'.
std::string msgtype;
- // The matrix URL of the file.
+ //! The matrix URL of the file.
std::string url;
- // Information about the file referred to in the url.
+ //! Information about the file referred to in the url.
mtx::common::FileInfo info;
- // Encryption members. If present, they replace url.
+ //! Encryption members. If present, they replace url.
std::optional<crypto::EncryptedFile> file;
//! Relates to for rich replies
mtx::common::ReplyRelatesTo relates_to;
diff --git a/include/mtx/events/messages/image.hpp b/include/mtx/events/messages/image.hpp
index 00619d953583103451b9e40912cb7f6a8221be41..8307da28d87cdd41c02c1f0909393da1e1ffe8b3 100644
--- a/include/mtx/events/messages/image.hpp
+++ b/include/mtx/events/messages/image.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Images sent in a room.
+
#include <optional>
#include <string>
@@ -16,6 +19,7 @@ namespace mtx {
namespace events {
namespace msg {
+//! Content of `m.room.message` with msgtype `m.image`.
struct Image
{
// A textual representation of the image. This could be
@@ -34,6 +38,7 @@ struct Image
mtx::common::ReplyRelatesTo relates_to;
};
+//! Content of `m.sticker`.
struct StickerImage
{
// A textual representation of the image. This could be
diff --git a/include/mtx/events/messages/notice.hpp b/include/mtx/events/messages/notice.hpp
index 7e89ee3caee39523e2820ea83f15b8048fd12f24..b222f85e20ce444e0080af36fcdf52b635a3dead 100644
--- a/include/mtx/events/messages/notice.hpp
+++ b/include/mtx/events/messages/notice.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief A bot generated message and other notices.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -14,17 +17,18 @@ namespace mtx {
namespace events {
namespace msg {
+//! Content of `m.room.message` with msgtype `m.notice`.
struct Notice
{
- // The notice text to send.
+ //! The notice text to send.
std::string body;
- // Must be 'm.notice'.
+ //! Must be 'm.notice'.
std::string msgtype;
//! We only handle org.matrix.custom.html.
std::string format;
//! HTML formatted message.
std::string formatted_body;
- // Relates to for rich replies
+ //! Relates to for rich replies
mtx::common::ReplyRelatesTo relates_to;
};
diff --git a/include/mtx/events/messages/text.hpp b/include/mtx/events/messages/text.hpp
index 1a929f3535c3ec540a77bc6b4b7630606285da47..a64a749775710cb730718f2a8b67af3786a4152f 100644
--- a/include/mtx/events/messages/text.hpp
+++ b/include/mtx/events/messages/text.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief A text message.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -12,8 +15,10 @@
namespace mtx {
namespace events {
+//! Non-state events sent in the timeline like messages.
namespace msg {
+//! Content of `m.room.message` with msgtype `m.text`.
struct Text
{
//! The body of the message.
diff --git a/include/mtx/events/messages/video.hpp b/include/mtx/events/messages/video.hpp
index 2af4b1eb8f666876eaff29c08ebea38c0ad87c0b..1b33bb8d36363ba46ca8c868645eedbffcee9a87 100644
--- a/include/mtx/events/messages/video.hpp
+++ b/include/mtx/events/messages/video.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief A video sent in a room.
+
#include <optional>
#include <string>
@@ -16,18 +19,19 @@ namespace mtx {
namespace events {
namespace msg {
+//! Content of `m.room.message` with msgtype `m.video`.
struct Video
{
- // A description of the video or some kind of content description
- // for accessibility.
+ /// @brief A description of the video or some kind of content description
+ /// for accessibility.
std::string body;
- // Must be 'm.video'.
+ //! Must be 'm.video'.
std::string msgtype;
- // The matrix URL of the video clip.
+ //! The matrix URL of the video clip.
std::string url;
- // Metadata for the video clip referred to in url.
+ //! Metadata for the video clip referred to in url.
mtx::common::VideoInfo info;
- // Encryption members. If present, they replace url.
+ //! Encryption members. If present, they replace url.
std::optional<crypto::EncryptedFile> file;
//! Relates to for rich replies
mtx::common::ReplyRelatesTo relates_to;
diff --git a/include/mtx/events/name.hpp b/include/mtx/events/name.hpp
index 67fdbadec5252e6d767924814b466e3553fe6c91..15c5ba80c98c5659d11661b1c19c4b1c575a4838 100644
--- a/include/mtx/events/name.hpp
+++ b/include/mtx/events/name.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief The room name state event.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -9,11 +12,15 @@
#include <string>
namespace mtx {
+//! Namespace for all events.
namespace events {
+//! Events, that can be used as a state event.
namespace state {
+//! Content of the `m.room.name` event.
struct Name
{
+ //! The name of the room.
std::string name;
};
diff --git a/include/mtx/events/nheko_extensions/hidden_events.hpp b/include/mtx/events/nheko_extensions/hidden_events.hpp
index 7eb92578a505e03a821f218179ea24bd3ea8b92d..ba64d70e1778de4f095518efdead337d0a4b2843 100644
--- a/include/mtx/events/nheko_extensions/hidden_events.hpp
+++ b/include/mtx/events/nheko_extensions/hidden_events.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief A nheko specific event in account data used to hide events across different clients.
+
#include <vector>
#if __has_include(<nlohmann/json_fwd.hpp>)
@@ -13,6 +16,7 @@
namespace mtx {
namespace events {
namespace account_data {
+//! Custom nheko specific event types
namespace nheko_extensions {
//! Custom event to hide certain event types in nheko
struct HiddenEvents
diff --git a/include/mtx/events/pinned_events.hpp b/include/mtx/events/pinned_events.hpp
index c5e64606a08eb401d1eb3e4914d032e887e598bc..c404a1cbf24605ac4e0a404a7d014e3510039a29 100644
--- a/include/mtx/events/pinned_events.hpp
+++ b/include/mtx/events/pinned_events.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Events pinned in a room.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -12,8 +15,10 @@ namespace mtx {
namespace events {
namespace state {
+//! `m.room.pinned_events` state event.
struct PinnedEvents
{
+ //! The ids of the pinned events.
std::vector<std::string> pinned;
};
diff --git a/include/mtx/events/power_levels.hpp b/include/mtx/events/power_levels.hpp
index 375e67032304bd362208db3dc23eb79904d532ba..e4d0ed599fc53102f33100d3fe4b66226aecca4a 100644
--- a/include/mtx/events/power_levels.hpp
+++ b/include/mtx/events/power_levels.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief The state event governing the different permissions in a room.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -11,21 +14,28 @@
namespace mtx {
namespace events {
namespace state {
+//! The type representing a power level.
using power_level_t = int64_t;
+//! The default level required for events
constexpr power_level_t EventsDefault = 0;
+//! The default level for users.
constexpr power_level_t UsersDefault = 0;
+//! The default level required for state events.
constexpr power_level_t StatesDefault = 50;
+//! The power level usually associated with normal users.
constexpr power_level_t User = 0;
+//! The power level usually associated with moderators.
constexpr power_level_t Moderator = 50;
+//! The power level usually associated with admins.
constexpr power_level_t Admin = 100;
-//! Content for the `m.room.power_levels` state event.
-//
-//! This event specifies the minimum level a user must have in
-//! order to perform a certain action. It also specifies the
-//! levels of each user in the room.
+/// @brief Content for the `m.room.power_levels` state event.
+///
+/// This event specifies the minimum level a user must have in
+/// order to perform a certain action. It also specifies the
+/// levels of each user in the room.
struct PowerLevels
{
//! Returns the power_level for a given event type.
diff --git a/include/mtx/events/presence.hpp b/include/mtx/events/presence.hpp
index 34fbc191d365cbff3c90eea7f1bcf58d69266a79..17674a16fa842aea802fa773d538e28258631668 100644
--- a/include/mtx/events/presence.hpp
+++ b/include/mtx/events/presence.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief An ephemeral event describing the presence of a user.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -11,12 +14,14 @@
#include <string_view>
namespace mtx {
+//! Presence specific types.
namespace presence {
+//! The current presence state.
enum PresenceState
{
- online,
- offline,
- unavailable,
+ online, //!< The user is online.
+ offline, //!< The user is offline.
+ unavailable, //!< The user is online, but currently not available.
};
std::string
@@ -27,6 +32,7 @@ from_string(std::string_view str);
namespace events {
namespace presence {
+//! The `m.presence` ephemeral event.
struct Presence
{
std::string avatar_url; //! The current avatar URL for this user, if any.
diff --git a/include/mtx/events/reaction.hpp b/include/mtx/events/reaction.hpp
index 1ba22a1fc59ce598e59447808c8c32fb54031c3d..e8f8106f885f49a42e16586bffcdcc6533c3de4d 100644
--- a/include/mtx/events/reaction.hpp
+++ b/include/mtx/events/reaction.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief A reaction event used to attach small annotations to events.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
diff --git a/include/mtx/events/redaction.hpp b/include/mtx/events/redaction.hpp
index c7bd339b69d4c6f8d192cf5c05363be5a096352f..6cda35c3b1846dd73138e1360ab077a283dd422f 100644
--- a/include/mtx/events/redaction.hpp
+++ b/include/mtx/events/redaction.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Events describing redactions and redacted content.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -25,7 +28,7 @@ from_json(const nlohmann::json &obj, Redaction &event);
void
to_json(nlohmann::json &obj, const Redaction &event);
-//! Stripped out contente for redacted events.
+//! Stripped out content for redacted events.
struct Redacted
{};
diff --git a/include/mtx/events/tag.hpp b/include/mtx/events/tag.hpp
index 1eb78a02fde44ff8dfa06a4b68b7e21934e8b7ca..64f5c444ee3cc2f468e094b29fe9aa13f12dcd5d 100644
--- a/include/mtx/events/tag.hpp
+++ b/include/mtx/events/tag.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Events describing room tags.
+
#include <optional>
#include <string>
@@ -11,7 +14,9 @@
namespace mtx {
namespace events {
+//! Namespace for events in account_data
namespace account_data {
+//! The content of a tag.
struct Tag
{
//! A number in a range [0,1] describing a relative position of the room under
diff --git a/include/mtx/events/tombstone.hpp b/include/mtx/events/tombstone.hpp
index f5d3de25bdc74a0efe05b7bd96fe3b4705759801..84e3185b1371e9996258929c150f6759e30d3ceb 100644
--- a/include/mtx/events/tombstone.hpp
+++ b/include/mtx/events/tombstone.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief An event describing a room upgrade or shutdown.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
diff --git a/include/mtx/events/topic.hpp b/include/mtx/events/topic.hpp
index 5a1f2f04ce50277dd3012babe2d1b492a0875db2..befa8d7f97479d45e9a9c5b237953ea2643b2184 100644
--- a/include/mtx/events/topic.hpp
+++ b/include/mtx/events/topic.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief The state event describing the topic in a room.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -12,8 +15,9 @@ namespace mtx {
namespace events {
namespace state {
-//! Content for the `m.room.topic` state event.
-//! A topic is a short message detailing what is currently being discussed in the room.
+/// @brief Content for the `m.room.topic` state event.
+//
+/// A topic is a short message detailing what is currently being discussed in the room.
struct Topic
{
//! The topic text.
diff --git a/include/mtx/events/voip.hpp b/include/mtx/events/voip.hpp
index 7ed17936602a4ce4213a489ad560a2cb2ef76689..ee9dbe1453025e39a41ddd187016bd4a5559f7f1 100644
--- a/include/mtx/events/voip.hpp
+++ b/include/mtx/events/voip.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Call related events.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
diff --git a/include/mtx/identifiers.hpp b/include/mtx/identifiers.hpp
index b6ef59e576dd2d56055b2f4db7b0c666095708be..cf3c2d7c42d3cb8096a26a44707b68400bc7d08c 100644
--- a/include/mtx/identifiers.hpp
+++ b/include/mtx/identifiers.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Identifiers used in the Matrix API.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -33,6 +36,7 @@ protected:
std::string id_;
};
+//! An event id.
class Event : public ID
{
public:
@@ -44,6 +48,7 @@ private:
std::string sigil = "$";
};
+//! A room id.
class Room : public ID
{
public:
@@ -54,6 +59,7 @@ private:
std::string sigil = "!";
};
+//! A user id.
class User : public ID
{
public:
@@ -110,9 +116,7 @@ void
to_json(nlohmann::json &obj, const User &user);
void
-from_json(const nlohmann::json &obj, Room &room)
-
- ;
+from_json(const nlohmann::json &obj, Room &room);
void
to_json(nlohmann::json &obj, const Room &room);
diff --git a/include/mtx/lightweight_error.hpp b/include/mtx/lightweight_error.hpp
index dc207521ad3a5993098e32ccbf2aed39e3c5d072..01da796b1164a002dc6c21dd8d4ecbb0f46026b8 100644
--- a/include/mtx/lightweight_error.hpp
+++ b/include/mtx/lightweight_error.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Error codes returned by the Matrix API.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -8,8 +11,10 @@
#include <string>
namespace mtx {
+//! Namespace for Matrix errors.
namespace errors {
+//! A Matrix error code.
enum class ErrorCode
{
M_UNRECOGNIZED,
@@ -53,9 +58,11 @@ enum class ErrorCode
M_INVALID_SIGNATURE,
};
+//! Convert an error code into a string.
std::string
to_string(ErrorCode code);
+//! Parse an error code from a string.
ErrorCode
from_string(const std::string &code);
diff --git a/include/mtx/pushrules.hpp b/include/mtx/pushrules.hpp
index f4301d96be4dfbe84574ccb0a1c3a0dda33ad4d9..7b1ddfbd544c350b6bc2e0e1f6ff0f5dc8d6a260 100644
--- a/include/mtx/pushrules.hpp
+++ b/include/mtx/pushrules.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Pushrules and notification settings.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -11,7 +14,9 @@
#include <vector>
namespace mtx {
+//! Namespace for the pushrules specific endpoints.
namespace pushrules {
+//! A condition to match pushrules on.
struct PushCondition
{
//! Required. The kind of condition to apply. See conditions for more information on the
@@ -40,21 +45,34 @@ to_json(nlohmann::json &obj, const PushCondition &condition);
void
from_json(const nlohmann::json &obj, PushCondition &condition);
+//! Namespace for the different push actions.
namespace actions {
+//! Notify the user.
struct notify
{};
+//! Don't notify the user.
struct dont_notify
{};
+/// @brief This enables notifications for matching events but activates homeserver specific
+/// behaviour to intelligently coalesce multiple events into a single notification.
+///
+/// Not all homeservers may support this. Those that do not support it should treat it as the notify
+/// action.
struct coalesce
{};
+//! Play a sound.
struct set_tweak_sound
{
+ //! The sound to play.
std::string value = "default";
};
+//! Highlight the message.
struct set_tweak_highlight
{
bool value = true;
};
+
+//! A collection for the different actions.
using Action = std::variant<actions::notify,
actions::dont_notify,
actions::coalesce,
@@ -67,6 +85,7 @@ to_json(nlohmann::json &obj, const Action &action);
void
from_json(const nlohmann::json &obj, Action &action);
+//! A list of actions.
struct Actions
{
std::vector<Action> actions;
@@ -78,6 +97,7 @@ void
from_json(const nlohmann::json &obj, Actions &action);
}
+//! A pushrule defining the notification behaviour for a message.
struct PushRule
{
//! Required. Whether this is a default rule, or has been set explicitly.
@@ -102,6 +122,7 @@ to_json(nlohmann::json &obj, const PushRule &condition);
void
from_json(const nlohmann::json &obj, PushRule &condition);
+//! All the pushrules to evaluate for events.
struct Ruleset
{
//! see https://matrix.org/docs/spec/client_server/latest#push-rules
@@ -126,8 +147,10 @@ to_json(nlohmann::json &obj, const Ruleset &condition);
void
from_json(const nlohmann::json &obj, Ruleset &condition);
+//! The global ruleset applied to all events.
struct GlobalRuleset
{
+ //! The actual ruleset.
Ruleset global;
};
@@ -137,6 +160,7 @@ to_json(nlohmann::json &obj, const GlobalRuleset &set);
void
from_json(const nlohmann::json &obj, GlobalRuleset &set);
+//! The response for queries, if a specific ruleset is enabled.
struct Enabled
{
bool enabled = true;
diff --git a/include/mtx/requests.hpp b/include/mtx/requests.hpp
index e73586b7c136624bb29a0b1901db9c7acbd4e3e9..320e9aac4e72d070f092d578c8d2cf570a8bf755 100644
--- a/include/mtx/requests.hpp
+++ b/include/mtx/requests.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Structs for for requests to the Matrix API.
+
#include <string>
#include <variant>
@@ -14,6 +17,7 @@
using json = nlohmann::json;
namespace mtx {
+//! Namespace for request structs
namespace requests {
//! Whether or not the room will be visible by non members.
@@ -163,7 +167,7 @@ struct UploadKeys
//! May be absent if no new identity keys are required.
mtx::crypto::DeviceKeys device_keys;
//! One-time public keys for "pre-key" messages.
- //! The names of the properties should be in the format <algorithm>:<key_id>.
+ //! The names of the properties should be in the format `<algorithm>:<key_id>`.
//! The format of the key is determined by the key algorithm.
std::map<std::string, std::variant<std::string, SignedOneTimeKey>> one_time_keys;
};
diff --git a/include/mtx/responses.hpp b/include/mtx/responses.hpp
index 6f7d5578415ec82445eb282341efbb9436420c28..ebe6d00f375082210e7f67af34c060b13cf268ef 100644
--- a/include/mtx/responses.hpp
+++ b/include/mtx/responses.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Collection header for all the different response structs.
+
#include "responses/common.hpp"
#include "responses/create_room.hpp"
diff --git a/include/mtx/responses/common.hpp b/include/mtx/responses/common.hpp
index 574679157b94b11559cf4f7a73abad0507db7e7d..9458b3c1d7d4cea2435694c611bc273a3668f3de 100644
--- a/include/mtx/responses/common.hpp
+++ b/include/mtx/responses/common.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Responses used by multiple endpoints.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -12,46 +15,59 @@
#include "mtx/events/collections.hpp"
namespace mtx {
+//! Namespace for the different types of responses.
namespace responses {
-
+//! An event id returned by the API.
struct EventId
{
+ //! The event id.
mtx::identifiers::Event event_id;
};
void
from_json(const nlohmann::json &obj, EventId &response);
+//! A group id returned by the API.
struct GroupId
{
+ //! The group id.
std::string group_id;
};
void
from_json(const nlohmann::json &obj, GroupId &response);
+//! A room id returned by the API.
struct RoomId
{
+ //! The room id.
std::string room_id;
};
void
from_json(const nlohmann::json &obj, RoomId &response);
+//! A filter id returned by the API.
struct FilterId
{
+ //! The filter id.
std::string filter_id;
};
void
from_json(const nlohmann::json &obj, FilterId &response);
+//! Different helper for parsing responses.
namespace utils {
-
+//! Multiple account_data events.
using RoomAccountDataEvents = std::vector<mtx::events::collections::RoomAccountDataEvents>;
+//! Multiple TimelineEvents.
using TimelineEvents = std::vector<mtx::events::collections::TimelineEvents>;
+//! Multiple StateEvents.
using StateEvents = std::vector<mtx::events::collections::StateEvents>;
+//! Multiple StrippedEvents.
using StrippedEvents = std::vector<mtx::events::collections::StrippedEvents>;
+//! Multiple DeviceEvents.
using DeviceEvents = std::vector<mtx::events::collections::DeviceEvents>;
namespace states = mtx::events::state;
@@ -63,21 +79,26 @@ log_error(std::exception &err, const nlohmann::json &event);
void
log_error(std::string err, const nlohmann::json &event);
+//! Parse multiple account_data events.
void
parse_room_account_data_events(const nlohmann::json &events, RoomAccountDataEvents &container);
void
compose_timeline_events(nlohmann::json &events, const TimelineEvents &container);
+//! Parse multiple timeline events.
void
parse_timeline_events(const nlohmann::json &events, TimelineEvents &container);
+//! Parse multiple state events.
void
parse_state_events(const nlohmann::json &events, StateEvents &container);
+//! Parse multiple stripped events.
void
parse_stripped_events(const nlohmann::json &events, StrippedEvents &container);
+//! Parse multiple device events.
void
parse_device_events(const nlohmann::json &events, DeviceEvents &container);
}
diff --git a/include/mtx/responses/create_room.hpp b/include/mtx/responses/create_room.hpp
index e1fe6e10d364103f23d0944188880c21a680264b..91ee521b131e15e9c0aa81383c1ed332132ee830 100644
--- a/include/mtx/responses/create_room.hpp
+++ b/include/mtx/responses/create_room.hpp
@@ -1,11 +1,16 @@
#pragma once
+/// @file
+/// @brief Response from creating a room.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
#include <nlohmann/json.hpp>
#endif
+#include <mtx/identifiers.hpp>
+
namespace mtx {
namespace responses {
//! Response from the `POST /_matrix/client/r0/createRoom` endpoint.
diff --git a/include/mtx/responses/crypto.hpp b/include/mtx/responses/crypto.hpp
index 358886bc64db82bf9ac6968ca01d8f617415f62c..1cf6ce46900917bad488a7cbae13846f1f5811f3 100644
--- a/include/mtx/responses/crypto.hpp
+++ b/include/mtx/responses/crypto.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief E2EE related endpoints.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -53,8 +56,10 @@ to_json(nlohmann::json &obj, const QueryKeys &response);
void
from_json(const nlohmann::json &obj, QueryKeys &response);
+//! Request for `POST /_matrix/client/r0/keys/upload`.
struct KeySignaturesUpload
{
+ //! Errors returned during upload.
std::map<std::string, std::map<std::string, mtx::errors::LightweightError>> errors;
};
@@ -89,6 +94,7 @@ struct KeyChanges
void
from_json(const nlohmann::json &obj, KeyChanges &response);
+//! KeysBackup related responses.
namespace backup {
//! Encrypted session data using the m.megolm_backup.v1.curve25519-aes-sha2 algorithm
struct EncryptedSessionData
@@ -177,6 +183,7 @@ from_json(const nlohmann::json &obj, BackupVersion &response);
void
to_json(nlohmann::json &obj, const BackupVersion &response);
+//! The SessionData stored in the KeysBackup.
struct SessionData
{
//! Required. The end-to-end message encryption algorithm that the key is
diff --git a/include/mtx/responses/empty.hpp b/include/mtx/responses/empty.hpp
index cf742761afa8f9143c67355e23963e366ee4f3c9..dc4ab9e4cc11dd9634cd5ea82b111bd1cf3fb0c6 100644
--- a/include/mtx/responses/empty.hpp
+++ b/include/mtx/responses/empty.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Empty responses returned by different endpoints.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
diff --git a/include/mtx/responses/groups.hpp b/include/mtx/responses/groups.hpp
index b7012ac0cb4c1ed6cd456f8eb39ab0502f77df61..dcd20ebcdf89b4d193a37949647b72065b3e5a9e 100644
--- a/include/mtx/responses/groups.hpp
+++ b/include/mtx/responses/groups.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Groups related endpoints.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -8,18 +11,22 @@
namespace mtx {
namespace responses {
-
+//! The list of joined groups.
struct JoinedGroups
{
+ //! joined group ids.
std::vector<std::string> groups;
};
void
from_json(const nlohmann::json &obj, JoinedGroups &res);
+//! The profile of a group.
struct GroupProfile
{
+ //! The group name.
std::string name;
+ //! The group avatar.
std::string avatar_url;
};
diff --git a/include/mtx/responses/login.hpp b/include/mtx/responses/login.hpp
index e38f30e9e81761724ee18633816ed159f5570dad..ee243eabfa5f2768f41f12cacadb6edef4aca846 100644
--- a/include/mtx/responses/login.hpp
+++ b/include/mtx/responses/login.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Login related responses.
+
#include <optional>
#include <string>
@@ -37,8 +40,10 @@ struct Login
void
from_json(const nlohmann::json &obj, Login &response);
+//! One supported login flow.
struct LoginFlow
{
+ //! The authentication used for this flow.
mtx::user_interactive::AuthType type;
};
void
@@ -47,6 +52,7 @@ from_json(const nlohmann::json &obj, LoginFlow &response);
//! Response from the `GET /_matrix/client/r0/login` endpoint.
struct LoginFlows
{
+ //! The list of supported flows.
std::vector<LoginFlow> flows;
};
diff --git a/include/mtx/responses/media.hpp b/include/mtx/responses/media.hpp
index c40e7d0f889497ccbde31454e3543340fdd33f21..acc44695d65269943768d7046bd294a5ee32469e 100644
--- a/include/mtx/responses/media.hpp
+++ b/include/mtx/responses/media.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Responses returned by the media repo.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
diff --git a/include/mtx/responses/messages.hpp b/include/mtx/responses/messages.hpp
index 1bf7da48ebe0a9269324304228323fae0435fae1..e5de898fe4824111aaa9b1e1f661f49f3838979e 100644
--- a/include/mtx/responses/messages.hpp
+++ b/include/mtx/responses/messages.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Reponses from the message pagination API.
+
#include <string>
#if __has_include(<nlohmann/json_fwd.hpp>)
diff --git a/include/mtx/responses/notifications.hpp b/include/mtx/responses/notifications.hpp
index afefcab7cca2222c45291a0f2625062cfd3fb737..1f0974b9b1ef64e35f64455575e1b9ddacaab2b3 100644
--- a/include/mtx/responses/notifications.hpp
+++ b/include/mtx/responses/notifications.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Notification related endpoints.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -12,6 +15,7 @@
namespace mtx {
namespace responses {
+//! Description for a notification.
struct Notification
{
//! The action to perform when the conditions for this rule are met.
diff --git a/include/mtx/responses/profile.hpp b/include/mtx/responses/profile.hpp
index d1a046b610576bd7aa7584ed9bf3bdc87363631a..a7781f689599a3b595c0baf4dbf518a8040ea7c4 100644
--- a/include/mtx/responses/profile.hpp
+++ b/include/mtx/responses/profile.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Responses from the profile API.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
diff --git a/include/mtx/responses/register.hpp b/include/mtx/responses/register.hpp
index 4a1c1654674643ed311cc4f02bf28b526bf5f4ea..3ae65b70305a253fbd43097d5e54c812e04d12f9 100644
--- a/include/mtx/responses/register.hpp
+++ b/include/mtx/responses/register.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Responses from the registration API.
+
#include <string>
#if __has_include(<nlohmann/json_fwd.hpp>)
diff --git a/include/mtx/responses/sync.hpp b/include/mtx/responses/sync.hpp
index 0c1f5fd3671dc48fc2c801cbed8f1c8af30dd4e7..f145913894945dbfa79e6037366198baa5d957c2 100644
--- a/include/mtx/responses/sync.hpp
+++ b/include/mtx/responses/sync.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Response from the /sync API.
+
#include <map>
#include <string>
#include <vector>
diff --git a/include/mtx/responses/turn_server.hpp b/include/mtx/responses/turn_server.hpp
index c8fe103794fc76997ffac7cc9bc2c950bf7e5c44..5c4fa3d5e37b0782a9611f9a2234346823867f6b 100644
--- a/include/mtx/responses/turn_server.hpp
+++ b/include/mtx/responses/turn_server.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Responses for the turn server used for calls.
+
#include <string>
#include <vector>
diff --git a/include/mtx/responses/version.hpp b/include/mtx/responses/version.hpp
index 28b44f11bffd3b4676a1ead603ec9788bca5ab8a..23a2cb09f9aa1a3d7d9e089be38acf47034f75f1 100644
--- a/include/mtx/responses/version.hpp
+++ b/include/mtx/responses/version.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Return value of the server and API version query.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
diff --git a/include/mtx/responses/well-known.hpp b/include/mtx/responses/well-known.hpp
index 98c246aa6f412275ddcbd59f5f20615d02d19277..9e5a64aad2d71de92fcb0807c8013ac34506836e 100644
--- a/include/mtx/responses/well-known.hpp
+++ b/include/mtx/responses/well-known.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Response for .well-known lookup.
+
#include <optional>
#if __has_include(<nlohmann/json_fwd.hpp>)
@@ -10,6 +13,7 @@
namespace mtx {
namespace responses {
+//! The info about this server.
struct ServerInformation
{
//! Required. The base URL for client-server connections.
diff --git a/include/mtx/secret_storage.hpp b/include/mtx/secret_storage.hpp
index 05d0d462e9be450972313229205a52930419dd64..15c0af0336a6a37c52d16b7b81307443f71dc041 100644
--- a/include/mtx/secret_storage.hpp
+++ b/include/mtx/secret_storage.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Header with SSSS related types.
+
#include <cstdint>
#include <map>
#include <optional>
@@ -12,19 +15,26 @@
#endif
namespace mtx {
+//! SSSS related types to store encrypted data on the server.
namespace secret_storage {
+//! Names of secrets used in the spec.
namespace secrets {
+//! Decryption key for online key backup.
constexpr const char megolm_backup_v1[] = "m.megolm_backup.v1";
+//! Key to sign own devices
constexpr const char cross_signing_self_signing[] = "m.cross_signing.self_signing";
+//! Key to sign other users
constexpr const char cross_signing_user_signing[] = "m.cross_signing.user_signing";
+//! Key to sign your own keys like user and self signing keys.
constexpr const char cross_signing_master[] = "m.cross_signing.master";
}
+//! A aes-hmac-sha2 encrypted secret.
struct AesHmacSha2EncryptedData
{
- std::string iv; //! Required. The 16-byte initialization vector, encoded as base64.
- std::string ciphertext; //! Required. The AES-CTR-encrypted data, encoded as base64.
- std::string mac; //! Required. The MAC, encoded as base64.
+ std::string iv; //!< Required. The 16-byte initialization vector, encoded as base64.
+ std::string ciphertext; //!< Required. The AES-CTR-encrypted data, encoded as base64.
+ std::string mac; //!< Required. The MAC, encoded as base64.
};
void
@@ -33,11 +43,13 @@ to_json(nlohmann::json &obj, const AesHmacSha2EncryptedData &data);
void
from_json(const nlohmann::json &obj, AesHmacSha2EncryptedData &data);
+//! A secret, encrypted with one or more algorithms.
struct Secret
{
- //! Required. Map from key ID the encrypted data. The exact format for the encrypted data is
- //! dependent on the key algorithm. See the definition of AesHmacSha2EncryptedData in the
- //! m.secret_storage.v1.aes-hmac-sha2 section.
+ /// @brief Required. Map from key ID the encrypted data.
+ ///
+ /// The exact format for the encrypted data is dependent on the key algorithm. See the
+ /// definition of AesHmacSha2EncryptedData in the m.secret_storage.v1.aes-hmac-sha2 section.
std::map<std::string, AesHmacSha2EncryptedData> encrypted;
};
@@ -47,6 +59,7 @@ to_json(nlohmann::json &obj, const Secret &secret);
void
from_json(const nlohmann::json &obj, Secret &secret);
+//! Information about the key derivation from a passphrase.
struct PBKDF2
{
//! Required. Must be m.pbkdf2
@@ -65,17 +78,19 @@ to_json(nlohmann::json &obj, const PBKDF2 &desc);
void
from_json(const nlohmann::json &obj, PBKDF2 &desc);
+//! Description of the key for a secret.
struct AesHmacSha2KeyDescription
{
- std::string name; //! Required. The name of the key.
- std::string algorithm; //! Required. The encryption algorithm to be used for this key.
- //! Currently, only m.secret_storage.v1.aes-hmac-sha2 is supported.
- std::optional<PBKDF2> passphrase; //! See deriving keys from passphrases section for a
- //! description of this property.
- std::string iv; //! The 16-byte initialization vector, encoded as base64.
- std::string mac; //! The MAC of the result of encrypting 32 bytes of 0, encoded as base64.
-
- // userid -> key -> key (undocumented)
+ std::string name; //!< Required. The name of the key.
+ /// @brief Required. The encryption algorithm to be used for this key.
+ /// Currently, only m.secret_storage.v1.aes-hmac-sha2 is supported.
+ std::string algorithm;
+ //! See deriving keys from passphrases section for a description of this property.
+ std::optional<PBKDF2> passphrase;
+ std::string iv; //!< The 16-byte initialization vector, encoded as base64.
+ std::string mac; //!< The MAC of the result of encrypting 32 bytes of 0, encoded as base64.
+
+ //! userid -> key -> key (undocumented)
std::map<std::string, std::map<std::string, std::string>> signatures;
};
diff --git a/include/mtx/user_interactive.hpp b/include/mtx/user_interactive.hpp
index 90c36cc6b5b8061999a33be7f175a86b1f0f9177..90825c4bb269ac5a4ea8914b7864bce6716c9370 100644
--- a/include/mtx/user_interactive.hpp
+++ b/include/mtx/user_interactive.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Header with types for user interactive authentication
+
#include <string>
#include <string_view>
#include <unordered_map>
@@ -13,61 +16,86 @@
#endif
namespace mtx {
+//! Types and definitions for user interactive authentication.
namespace user_interactive {
+//! The type of the different auth types.
using AuthType = std::string;
+//! The different auth types.
namespace auth_types {
+//! Password based authentication.
constexpr std::string_view password = "m.login.password";
+//! Authentication using a ReCaptcha.
constexpr std::string_view recaptcha = "m.login.recaptcha";
+//! Authentication using oauth2.
constexpr std::string_view oauth2 = "m.login.oauth2";
+//! Authentication via email.
constexpr std::string_view email_identity = "m.login.email.identity";
+//! Authentication using SMS?
constexpr std::string_view msisdn = "m.login.msisdn";
+//! Token based auth.
constexpr std::string_view token = "m.login.token";
+//! Single Sign On.
constexpr std::string_view sso = "m.login.sso"; // needed for /login at least
+//! Placeholder used in alternative auth flows.
constexpr std::string_view dummy = "m.login.dummy";
+//! Authentication by accepting a set of terms like a privacy policy.
constexpr std::string_view terms = "m.login.terms"; // see MSC1692
}
+//! A list of auth types
using Stages = std::vector<AuthType>;
+//! A flow composed of a list of stages
struct Flow
{
+ //! The stages to complete.
Stages stages;
};
void
from_json(const nlohmann::json &obj, Flow &flow);
+
+//! Parameters for oauth2.
struct OAuth2Params
{
+ //! The oauth uri
std::string uri;
};
void
from_json(const nlohmann::json &obj, OAuth2Params ¶ms);
+//! The desciption of one policy in the terms and conditions.
struct PolicyDescription
{
- std::string name; // language specific name
- std::string url; // language specific link
+ std::string name; //!< language specific name
+ std::string url; //!< language specific link
};
void
from_json(const nlohmann::json &obj, PolicyDescription &desc);
+//! A policy in the terms and conditions.
struct Policy
{
+ //! Version of this policy
std::string version;
- // 2 letter language code to policy name and link, fallback to "en"
- // recommended, when language not available.
+ /// @brief 2 letter language code to policy name and link, fallback to "en"
+ /// recommended, when language not available.
std::unordered_map<std::string, PolicyDescription> langToPolicy;
};
void
from_json(const nlohmann::json &obj, Policy &policy);
+//! Parameters for the auth stage requiring you to accept terms and conditions.
struct TermsParams
{
+ //! The different policies by name.
std::unordered_map<std::string, Policy> policies;
};
void
from_json(const nlohmann::json &obj, TermsParams ¶ms);
+//! All the different parameters.
using Params = std::variant<OAuth2Params, TermsParams, std::string>;
+//! The struct returned on requests failing with 401.
struct Unauthorized
{
// completed stages
@@ -85,16 +113,21 @@ struct Unauthorized
void
from_json(const nlohmann::json &obj, Unauthorized &unauthorized);
+//! namespace for the request types in the different auth stages.
namespace auth {
+//! Password stage
struct Password
{
+ //! The password set by the user.
std::string password;
+ //! Types of identifiers.
enum IdType
{
- UserId,
- ThirdPartyId
+ UserId, //!< Use the identifier_user
+ ThirdPartyId //!< use identifier_medium and identifier_address
};
+ //! If a user or third party identifier is used.
IdType identifier_type;
//! for user
@@ -105,12 +138,14 @@ struct Password
std::string identifier_address;
};
+//! ReCaptcha stage.
struct ReCaptcha
{
//! The recaptcha response
std::string response;
};
+//! Token stage.
struct Token
{
//! the obtained token
@@ -119,6 +154,7 @@ struct Token
std::string txn_id;
};
+//! Third party identifier for Email or MSISDN stages
struct ThreePIDCred
{
//! identity server session id
@@ -130,11 +166,15 @@ struct ThreePIDCred
//! access token previously registered with the identity server
std::string id_access_token;
};
+
+//! Email authentication stage.
struct EmailIdentity
{
// The 3rd party ids
std::vector<ThreePIDCred> threepidCreds;
};
+
+//! SMS authentication stage.
struct MSISDN
{
// The 3rd party ids
@@ -144,15 +184,21 @@ struct MSISDN
//! OAuth2, client retries with the session only, so I'm guessing this is empty?
struct OAuth2
{};
+//! Empty struct, when parameters are accepted.
struct Terms
{};
+//! Empty struct to complete SSO.
struct SSO
{};
+//! Empty struct to complete dummy auth.
struct Dummy
{};
+//! Fallback auth.
struct Fallback
{};
}
+
+//! The auth request to complete a stage.
struct Auth
{
//! the session id
diff --git a/include/mtxclient/crypto/client.hpp b/include/mtxclient/crypto/client.hpp
index 06bfcdb0bd38c25565a4a9efff0286cdc0eda606..bd60ee7d8da934b01863fe2f3563b61c2f3eb89f 100644
--- a/include/mtxclient/crypto/client.hpp
+++ b/include/mtxclient/crypto/client.hpp
@@ -1,5 +1,9 @@
#pragma once
+/// @file
+/// @brief Holds most of the crypto functions and errors as well as a Client, which does the Olm
+/// account bookkeeping for you.
+
#include <exception>
#include <memory>
#include <new>
@@ -21,11 +25,13 @@
#include "mtxclient/crypto/utils.hpp"
namespace mtx {
+//! Cryptography related types
namespace crypto {
//! Data representation used to interact with libolm.
using BinaryBuf = std::vector<uint8_t>;
+//! Errors returned by the olm library
class olm_exception : public std::exception
{
public:
@@ -65,12 +71,14 @@ public:
: msg_(msg)
{}
- virtual const char *what() const throw() { return msg_.c_str(); }
+ //! Returns a description of the olm error.
+ const char *what() const noexcept override { return msg_.c_str(); }
private:
std::string msg_;
};
+//! Serialize olm objects into strings encrypted using key to persist them on non volatile storage.
template<class T>
std::string
pickle(typename T::olm_type *object, const std::string &key)
@@ -84,6 +92,8 @@ pickle(typename T::olm_type *object, const std::string &key)
return std::string((char *)tmp.data(), tmp.size());
}
+//! Deserialize olm objects from strings encrypted using key previously persisted on non volatile
+//! storage.
template<class T>
std::unique_ptr<typename T::olm_type, OlmDeleter>
unpickle(const std::string &pickled, const std::string &key)
@@ -99,25 +109,43 @@ unpickle(const std::string &pickled, const std::string &key)
return object;
}
+//! Return value from decrypting a group message.
struct GroupPlaintext
{
+ //! The plain text, which was decrypted.
BinaryBuf data;
+ //! The message index used for this message.
uint32_t message_index;
};
+//! Helper to generate Short Authentication Strings (SAS)
struct SAS
{
+ //! Create a new SAS object.
SAS();
+ //! Query the public key generated for this object.
std::string public_key();
+ //! Set the key of the other party being verified.
void set_their_key(std::string their_public_key);
+ /// @brief Returns 3 integers ranging from 1000 to 9191, to be used only after
+ /// using `set_their_key`
+ ///
+ /// These are meant to be compared by the users verifying each other.
std::vector<int> generate_bytes_decimal(std::string info);
+ /// @brief Returns 7 integers in the range from 0 to 63, to be used only after using
+ /// `set_their_key`
+ ///
+ /// Map these numpers to one of the 64 emoji from the specification and let the user compare
+ /// them.
std::vector<int> generate_bytes_emoji(std::string info);
+ //! Calculate MACs after verification to verify keys.
std::string calculate_mac(std::string input_data, std::string info);
private:
SASPtr sas;
};
+//! Helper to sign arbitrary messages using an ed25519 key
struct PkSigning
{
//! Construct from base64 key
@@ -133,19 +161,26 @@ private:
std::string public_key_;
};
+//! Client for all the cryptography related functionality like olm accounts, session keys
+//! encryption, signing and a few more things.
class OlmClient : public std::enable_shared_from_this<OlmClient>
{
public:
OlmClient() = default;
+ //! Initialize a crypto client for the specified device of the specified user.
OlmClient(std::string user_id, std::string device_id)
: user_id_(std::move(user_id))
, device_id_(std::move(device_id))
{}
+ //! Base64 encoded string
using Base64String = std::string;
+ //! A signed set of one time keys indexed by `<algorithm>:<key_id>`.
using SignedOneTimeKeys = std::map<std::string, requests::SignedOneTimeKey>;
+ //! Set the id of this device.
void set_device_id(std::string device_id) { device_id_ = std::move(device_id); }
+ //! Set the id of this user.
void set_user_id(std::string user_id) { user_id_ = std::move(user_id); }
//! Sign the given message.
@@ -153,8 +188,11 @@ public:
//! Create a new olm Account. Must be called before any other operation.
void create_new_account();
+ //! Create a new olm utility object.
void create_new_utility() { utility_ = create_olm_object<UtilityObject>(); }
+ /// @brief Restore the olm account from a pickled string encrypted by `key`
+ /// @see load
void restore_account(const std::string &saved_data, const std::string &key);
//! Retrieve the json representation of the identity keys for the given account.
@@ -180,6 +218,7 @@ public:
//! Prepare request for the /keys/upload endpoint by signing identity & one time keys.
mtx::requests::UploadKeys create_upload_keys_request(const OneTimeKeys &keys);
+ //! Prepare an empty /keys/upload request.
mtx::requests::UploadKeys create_upload_keys_request();
//! Decrypt a message using megolm.
@@ -196,17 +235,40 @@ public:
std::size_t msg_type,
const std::string &msg);
- //! Create an outbount megolm session.
+ /// @brief Create an outbound megolm session.
+ /// @sa init_inbound_group_session(const std::string&), import_inbound_group_session()
OutboundGroupSessionPtr init_outbound_group_session();
+ /// @brief Initialize an inbound group session from a shared session key (an m.room_key
+ /// event).
+ /// @sa init_inbound_group_session(), import_inbound_group_session()
InboundGroupSessionPtr init_inbound_group_session(const std::string &session_key);
+ /// @brief Initialize an inbound group session from a forwarded session key (an
+ /// m.forwarded_room_key event).
+ /// @sa init_inbound_group_session(const std::string&), init_inbound_group_session()
InboundGroupSessionPtr import_inbound_group_session(const std::string &session_key);
+
+ /// @brief create an outbound session to encrypt to device messages.
+ /// @param identity_key The curve25519 key of the other party.
+ /// @param one_time_key The claimed one time key of the other party.
OlmSessionPtr create_outbound_session(const std::string &identity_key,
const std::string &one_time_key);
+ /// @brief Creates an inbound session from an inbound message. DON'T USE THIS, use
+ /// create_inbound_session_from() instead.
+ /// @sa create_inbound_session_from()
OlmSessionPtr create_inbound_session(const BinaryBuf &one_time_key_message);
+ /// @brief Creates an inbound session from an inbound message. DON'T USE THIS, use
+ /// create_inbound_session_from() instead.
+ /// @sa create_inbound_session_from()
OlmSessionPtr create_inbound_session(const std::string &one_time_key_message);
+ /// @brief Create an inbound olm session from the other users message and identity key
+ /// @sa create_inbound_session_from(const std::string&, const std::string&),
+ /// create_outbound_session(), create_inbound_session()
OlmSessionPtr create_inbound_session_from(const std::string &their_curve25519,
const BinaryBuf &one_time_key_message);
+ /// @brief Create an inbound olm session from the other users message and identity key
+ /// @sa create_inbound_session_from(const std::string&, const BinaryBuf&),
+ /// create_outbound_session(), create_inbound_session()
OlmSessionPtr create_inbound_session_from(const std::string &their_curve25519,
const std::string &one_time_key_message);
@@ -218,13 +280,18 @@ public:
const std::string &recipient_ed25519_key,
const std::string &recipient_curve25519_key);
+ //! store the account in a pickled string encrypted by `key`
std::string save(const std::string &key);
+ /// @brief Restore the account from a pickled string encrypted by `key`
+ /// @see restore_account
void load(const std::string &data, const std::string &key)
{
account_ = unpickle<AccountObject>(data, key);
}
+ //! Access the olm account directly.
OlmAccount *account() { return account_.get(); }
+ //! Access the olm utility object directly.
OlmUtility *utility() { return utility_.get(); }
//! SAS related stuff
@@ -259,17 +326,23 @@ export_session(OlmInboundGroupSession *s);
InboundGroupSessionPtr
import_session(const std::string &session_key);
+/// Checks if an inbound session matches a pre key message.
+///
+/// Use matches_inbound_session_from() instead.
bool
matches_inbound_session(OlmSession *session, const std::string &one_time_key_message);
+//! Checks if an inbound session matches a pre key message
bool
matches_inbound_session_from(OlmSession *session,
const std::string &id_key,
const std::string &one_time_key_message);
+//! Encrypt the exported sessions according to the export format from the spec.
std::string
encrypt_exported_sessions(const mtx::crypto::ExportedSessionKeys &keys, std::string pass);
+//! Decrypt the exported sessions according to the export format from the spec.
mtx::crypto::ExportedSessionKeys
decrypt_exported_sessions(const std::string &data, std::string pass);
@@ -278,7 +351,7 @@ bool
verify_identity_signature(const DeviceKeys &device_keys,
const DeviceId &device_id,
const UserId &user_id);
-//! this function is for verifying the signatures
+//! Verify an ed25519 signature.
bool
ed25519_verify_signature(std::string signing_key, nlohmann::json obj, std::string signature);
diff --git a/include/mtxclient/crypto/objects.hpp b/include/mtxclient/crypto/objects.hpp
index 9303940dfc333ef626242bf122b9e0d6ce4bd4f9..faf1a22cdb3deda772829098e680f7c1b778a581 100644
--- a/include/mtxclient/crypto/objects.hpp
+++ b/include/mtxclient/crypto/objects.hpp
@@ -1,5 +1,10 @@
#pragma once
+/// @file
+/// @brief Wrappers around the various Olm types.
+///
+/// The wrappers implement RAII semantics, so you don't need to free stuff manually.
+
#include <memory>
#include <olm/olm.h>
#include <olm/pk.h>
@@ -8,6 +13,19 @@
namespace mtx {
namespace crypto {
+/// @brief Deleter type to pass as a template argument to most smart pointers.
+///
+/// Can be used like so:
+///
+/// ```{.cpp}
+/// std::unique_ptr<OlmAccount, OlmDeleter> olmAccount = new uint8_t[olm_account_size()];
+/// ```
+///
+/// In general the coresponding *Object type should be preffered as a wapper, for example:
+///
+/// ```{.cpp}
+/// SASPtr sas = create_olm_object<SASObject>();
+/// ```
struct OlmDeleter
{
void operator()(OlmAccount *ptr) { delete[](reinterpret_cast<uint8_t *>(ptr)); }
@@ -25,6 +43,7 @@ struct OlmDeleter
void operator()(OlmSAS *ptr) { delete[](reinterpret_cast<uint8_t *>(ptr)); }
};
+//! Olm type for Short Authentication Strings.
struct SASObject
{
using olm_type = OlmSAS;
@@ -32,6 +51,7 @@ struct SASObject
static olm_type *allocate() { return olm_sas(new uint8_t[olm_sas_size()]); }
};
+//! Wrapper for the Olm utility object.
struct UtilityObject
{
using olm_type = OlmUtility;
@@ -39,6 +59,7 @@ struct UtilityObject
static olm_type *allocate() { return olm_utility(new uint8_t[olm_utility_size()]); }
};
+//! Wrapper for the olm object to do Private Key Decryption.
struct PkDecryptionObject
{
using olm_type = OlmPkDecryption;
@@ -49,6 +70,7 @@ struct PkDecryptionObject
}
};
+//! Wrapper for the olm object to do Private Key Signing.
struct PkSigningObject
{
using olm_type = OlmPkSigning;
@@ -56,6 +78,7 @@ struct PkSigningObject
static olm_type *allocate() { return olm_pk_signing(new uint8_t[olm_pk_signing_size()]); }
};
+//! Wrapper for the olm account object.
struct AccountObject
{
using olm_type = OlmAccount;
@@ -86,6 +109,7 @@ struct AccountObject
}
};
+//! Wrapper around olm sessions used for to device encryption.
struct SessionObject
{
using olm_type = OlmSession;
@@ -116,6 +140,8 @@ struct SessionObject
}
};
+//! Wrapper around the olm object for inbound group sessions used to decrypt messages in matrix
+//! rooms.
struct InboundSessionObject
{
using olm_type = OlmInboundGroupSession;
@@ -151,6 +177,8 @@ struct InboundSessionObject
}
};
+//! Wrapper around the outbound olm session object used to encrypt outbound group messages in matrix
+//! rooms.
struct OutboundSessionObject
{
using olm_type = OlmOutboundGroupSession;
@@ -186,6 +214,7 @@ struct OutboundSessionObject
}
};
+//! Allocates an olm object using the mtxclient wrapper type.
template<class T>
std::unique_ptr<typename T::olm_type, OlmDeleter>
create_olm_object()
diff --git a/include/mtxclient/crypto/types.hpp b/include/mtxclient/crypto/types.hpp
index 455b98dfb4be8db3e375d085808557a6692a47cd..b4cdc3cff6bc7e8bc787488d3205f204d4b13a40 100644
--- a/include/mtxclient/crypto/types.hpp
+++ b/include/mtxclient/crypto/types.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Various type definitions for the crypto API.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -8,40 +11,61 @@
namespace mtx {
namespace crypto {
-
+//! Constant for ed25519 keys
constexpr auto ED25519 = "ed25519";
+//! Constant for curve25519 keys
constexpr auto CURVE25519 = "curve25519";
+//! Constant for signed curve25519 keys
constexpr auto SIGNED_CURVE25519 = "signed_curve25519";
+//! The algorithm used for group messages.
constexpr auto MEGOLM_ALGO = "m.megolm.v1.aes-sha2";
+//! An exported megolm group session
struct ExportedSession
{
- std::map<std::string, std::string> sender_claimed_keys; // currently unused.
+ //! Required. The Ed25519 key of the device which initiated the session originally.
+ std::map<std::string, std::string> sender_claimed_keys; // currently unused.
+ //! Required. Chain of Curve25519 keys through which this session was forwarded, via
+ //! m.forwarded_room_key events.
std::vector<std::string> forwarding_curve25519_key_chain; // currently unused.
+ //! Required. The encryption algorithm that the session uses. Must be m.megolm.v1.aes-sha2.
std::string algorithm = MEGOLM_ALGO;
+ //! Required. The room where the session is used.
std::string room_id;
+ //! Required. The Curve25519 key of the device which initiated the session originally.
std::string sender_key;
+ //! Required. The ID of the session.
std::string session_id;
+ //! Required. The key for the session.
std::string session_key;
};
+//! A list of exported sessions.
struct ExportedSessionKeys
{
+ //! The actual sessions.
std::vector<ExportedSession> sessions;
};
+//! A pair of keys connected to an olm account.
struct IdentityKeys
{
+ //! The identity key.
std::string curve25519;
+ //! The signing key.
std::string ed25519;
};
+//! A list of one time keys.
struct OneTimeKeys
{
+ //! The key id type.
using KeyId = std::string;
+ //! The type for the keys.
using EncodedKey = std::string;
+ //! The one time keys by key id.
std::map<KeyId, EncodedKey> curve25519;
};
diff --git a/include/mtxclient/crypto/utils.hpp b/include/mtxclient/crypto/utils.hpp
index f25eadf2282f164089553dec8ea2ee490ba2b9a4..ffb4c490ed48669308904e81d83d97cbd78b0f00 100644
--- a/include/mtxclient/crypto/utils.hpp
+++ b/include/mtxclient/crypto/utils.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Various crypto functions.
+
#include <string>
#include <vector>
@@ -9,20 +12,23 @@
namespace mtx {
namespace crypto {
-class sodium_exception : public std::exception
+//! Exception thrown for various encryption related errors (not reported by olm), that generally
+//! should not be ignored.
+class crypto_exception : public std::exception
{
public:
- sodium_exception(std::string func, const char *msg)
+ crypto_exception(std::string func, const char *msg)
: msg_(func + ": " + std::string(msg))
{}
- virtual const char *what() const throw() { return msg_.c_str(); }
+ //! Describes the error
+ const char *what() const noexcept override { return msg_.c_str(); }
private:
std::string msg_;
};
-//! Data representation used to interact with libolm.
+//! Data representation used to interact with libolm. It's a contiguous buffer of bytes.
using BinaryBuf = std::vector<uint8_t>;
const std::string HEADER_LINE("-----BEGIN MEGOLM SESSION DATA-----");
@@ -32,6 +38,7 @@ const std::string TRAILER_LINE("-----END MEGOLM SESSION DATA-----");
BinaryBuf
create_buffer(std::size_t nbytes);
+//! Convert a string to a binary buffer.
inline BinaryBuf
to_binary_buf(const std::string &str)
{
@@ -39,6 +46,7 @@ to_binary_buf(const std::string &str)
reinterpret_cast<const uint8_t *>(str.data()) + str.size());
}
+//! Convert a binary buffer to a string.
inline std::string
to_string(const BinaryBuf &buf)
{
@@ -52,14 +60,18 @@ PBKDF2_HMAC_SHA_512(const std::string pass,
uint32_t iterations,
uint32_t keylen = 64);
+//! Derive the SSSS decryption key from a passphrase using the parameters stored in account_data.
std::optional<BinaryBuf>
key_from_passphrase(const std::string &password,
const mtx::secret_storage::AesHmacSha2KeyDescription ¶meters);
+//! Derive the SSSS decryption key from a base58 encoded recoverykey using the parameters stored in
+//! account_data.
std::optional<BinaryBuf>
key_from_recoverykey(const std::string &recoverkey,
const mtx::secret_storage::AesHmacSha2KeyDescription ¶meters);
+//! Decrypt a secret from SSSS
std::string
decrypt(const mtx::secret_storage::AesHmacSha2EncryptedData &data,
BinaryBuf decryptionKey,
@@ -86,6 +98,7 @@ CURVE25519_AES_SHA2_Decrypt(std::string base64_ciphertext,
const std::string &ephemeral,
const std::string &mac);
+//! Decrypt a session retrieved from online key backup.
mtx::responses::backup::SessionData
decrypt_session(const mtx::responses::backup::EncryptedSessionData &data,
const BinaryBuf &privateKey);
@@ -93,6 +106,7 @@ decrypt_session(const mtx::responses::backup::EncryptedSessionData &data,
BinaryBuf
HMAC_SHA256(const BinaryBuf hmacKey, const BinaryBuf data);
+//! Sha256 a string.
std::string
sha256(const std::string &data);
@@ -123,27 +137,35 @@ uint32_to_uint8(uint8_t b[4], uint32_t u32);
void
print_binary_buf(const BinaryBuf buf);
+//! Convert base64 to binary
std::string
base642bin(const std::string &b64);
+//! Encode a binary string in base64.
std::string
bin2base64(const std::string &bin);
+//! Decode unpadded base64 to binary.
std::string
base642bin_unpadded(const std::string &b64);
+//! Encode binary in unpadded base64.
std::string
bin2base64_unpadded(const std::string &bin);
+//! Decode urlsafe, unpadded base64 to binary.
std::string
base642bin_urlsafe_unpadded(const std::string &b64);
+//! Encode binary in urlsafe, unpadded base64.
std::string
bin2base64_urlsafe_unpadded(const std::string &bin);
+//! Encode binary in base58.
std::string
bin2base58(const std::string &bin);
+//! Decode base58 to binary.
std::string
base582bin(const std::string &bin);
} // namespace crypto
diff --git a/include/mtxclient/http/client.hpp b/include/mtxclient/http/client.hpp
index b82e7c0df74dd30f419e96998683f617389083f7..381facfd80cff4a44a5bfa728b2bba7a5299eb6d 100644
--- a/include/mtxclient/http/client.hpp
+++ b/include/mtxclient/http/client.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Primary header to access the http API.
+
#if __has_include(<nlohmann/json_fwd.hpp>)
#include <nlohmann/json_fwd.hpp>
#else
@@ -79,6 +82,7 @@ struct BackupVersion;
}
namespace mtx {
+//! Types related to invoking the actual HTTP requests
namespace http {
enum class PaginationDirection
@@ -480,13 +484,14 @@ public:
void query_keys(const mtx::requests::QueryKeys &req,
Callback<mtx::responses::QueryKeys> cb);
- //! Claims one-time keys for use in pre-key messages. Pass in a map from userid to
- //! device_keys
+ /// @brief Claims one-time keys for use in pre-key messages.
+ ///
+ /// Pass in a map from userid to device_keys
void claim_keys(const mtx::requests::ClaimKeys &req,
Callback<mtx::responses::ClaimKeys> cb);
- //! Gets a list of users who have updated their device identity keys
- //! since a previous sync token.
+ /// @brief Gets a list of users who have updated their device identity keys since a previous
+ /// sync token.
void key_changes(const std::string &from,
const std::string &to,
Callback<mtx::responses::KeyChanges> cb);
diff --git a/include/mtxclient/http/client_impl.hpp b/include/mtxclient/http/client_impl.hpp
index 4051880a4360c4d0284a10d0e88ed6e32ae552d5..eb2156fcaca08411fa107c59fc61d3077e822723 100644
--- a/include/mtxclient/http/client_impl.hpp
+++ b/include/mtxclient/http/client_impl.hpp
@@ -1,13 +1,24 @@
#pragma once
+/// @file
+/// @brief All the template stuff needed for the http client.
+///
+/// If you implement custom event types, this can be useful, but in general including this header
+/// just adds compile time without any benefits.
+
#include "client.hpp"
#include "mtxclient/utils.hpp" // for random_token, url_encode, des...
#include <nlohmann/json.hpp>
namespace mtx {
+//! A few helpers for the http client.
namespace client {
namespace utils {
+
+/// @brief deserialize a type or string from json.
+///
+/// Used internally to deserialize the response types for the various http methods.
template<class T>
inline T
deserialize(const std::string &data)
@@ -22,6 +33,9 @@ deserialize<std::string>(const std::string &data)
return data;
}
+/// @brief serialize a type or string to json.
+///
+/// Used internally to serialize the request types for the various http methods.
template<class T>
inline std::string
serialize(const T &obj)
diff --git a/include/mtxclient/http/errors.hpp b/include/mtxclient/http/errors.hpp
index aeb9ed2bf80210b2de2af18092dbd5cc307b56c8..853de39f98a4f610604d3bc4041ec58f351f217d 100644
--- a/include/mtxclient/http/errors.hpp
+++ b/include/mtxclient/http/errors.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Error codes returned by the client-server API
+
#include "mtx/errors.hpp"
#include <boost/beast/http/status.hpp>
#include <boost/system/error_code.hpp>
diff --git a/include/mtxclient/http/session.hpp b/include/mtxclient/http/session.hpp
index 928de06b97d34ee646e9cbe59d8fb842f29470ab..0d90362fffebf5513bfafaaf13625102f04280d0 100644
--- a/include/mtxclient/http/session.hpp
+++ b/include/mtxclient/http/session.hpp
@@ -1,5 +1,10 @@
#pragma once
+/// @file
+/// @brief A single http session, which is the context for a single http request.
+///
+/// You usually don't need to include this as session handling is handled by the library for you.
+
#include <boost/asio.hpp>
#include <boost/asio/ssl.hpp>
#include <boost/beast.hpp>
diff --git a/include/mtxclient/utils.hpp b/include/mtxclient/utils.hpp
index ee98310b11f29f8574e1ca70a259d22000e0dc05..00ddf99bf3d6cf3a5e8c15c3d860a7ae0a72681c 100644
--- a/include/mtxclient/utils.hpp
+++ b/include/mtxclient/utils.hpp
@@ -1,5 +1,8 @@
#pragma once
+/// @file
+/// @brief Various utility functions for http requests.
+
#include <boost/iostreams/device/array.hpp>
#include <iosfwd>
#include <map>
@@ -7,6 +10,7 @@
namespace mtx {
namespace client {
+//! Utility namespace.
namespace utils {
//! Representation of Matrix Content (MXC) URIs.
diff --git a/lib/crypto/client.cpp b/lib/crypto/client.cpp
index 0602f914dea13132a4bdf5eabd9babf77fc4f6be..b64e7517d5c3d9bad70fcc6bda5b69bd0bc3332e 100644
--- a/lib/crypto/client.cpp
+++ b/lib/crypto/client.cpp
@@ -419,7 +419,6 @@ SAS::SAS()
throw olm_exception("create_sas_instance", this->sas.get());
}
-//! returns the public key of the key-pair created
std::string
SAS::public_key()
{
@@ -434,7 +433,6 @@ SAS::public_key()
return to_string(pub_key_buffer);
}
-//! this is for setting the public key of the other user
void
SAS::set_their_key(std::string their_public_key)
{
@@ -447,8 +445,6 @@ SAS::set_their_key(std::string their_public_key)
throw olm_exception("get_public_key", this->sas.get());
}
-//! generates and returns a vector of numbers(int) ranging from 0 to 8191, to be used only after
-//! using `set_their_key`
std::vector<int>
SAS::generate_bytes_decimal(std::string info)
{
@@ -836,7 +832,7 @@ mtx::crypto::decrypt_exported_sessions(const std::string &data, std::string pass
auto hmacSha256 = mtx::crypto::HMAC_SHA256(hmac256, BinaryBuf(binary_start, json_end));
if (hmacSha256 != hmac) {
- throw sodium_exception{"decrypt_exported_sessions", "HMAC doesn't match"};
+ throw crypto_exception{"decrypt_exported_sessions", "HMAC doesn't match"};
}
const std::string ciphertext(json.begin(), json.end());