diff --git a/.gitignore b/.gitignore
index 8c9b4dd..554afe6 100644
--- a/.gitignore
+++ b/.gitignore
@@ -73,3 +73,4 @@ Thumbs.db
 build/
 bin/akashi
 bin/config/
+doxygen/html
diff --git a/Doxyfile b/Doxyfile
new file mode 100644
index 0000000..c68365e
--- /dev/null
+++ b/Doxyfile
@@ -0,0 +1,2581 @@
+# Doxyfile 1.8.17
+
+# 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           = "Akashi"
+
+# 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         = "0.0.1"
+
+# 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          = "A C++ server for Attorney Online 2"
+
+# 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           = ./resource/icon/32.png
+
+# 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       = doxygen/
+
+# 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    = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+# The default value is: NO.
+
+INLINE_INHERITED_MEMB  = NO
+
+# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
+# before files name in the file list and in the header files. If set to NO the
+# shortest path that makes the file name unique will be used
+# The default value is: YES.
+
+FULL_PATH_NAMES        = YES
+
+# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
+# Stripping is only done if one of the specified strings matches the left-hand
+# part of the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the path to
+# strip.
+#
+# Note that you can specify absolute paths here, but also relative paths, which
+# will be relative from the directory where doxygen is started.
+# This tag requires that the tag FULL_PATH_NAMES is set to YES.
+
+STRIP_FROM_PATH        =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
+# path mentioned in the documentation of a class, which tells the reader which
+# header file to include in order to use a class. If left blank only the name of
+# the header file containing the class definition is used. Otherwise one should
+# specify the list of include paths that are normally passed to the compiler
+# using the -I flag.
+
+STRIP_FROM_INC_PATH    =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
+# less readable) file names. This can be useful is your file systems doesn't
+# support long names like on DOS, Mac, or CD-ROM.
+# The default value is: NO.
+
+SHORT_NAMES            = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
+# first line (until the first dot) of a Javadoc-style comment as the brief
+# description. If set to NO, the Javadoc-style will behave just like regular Qt-
+# style comments (thus requiring an explicit @brief command for a brief
+# description.)
+# The default value is: NO.
+
+JAVADOC_AUTOBRIEF      = NO
+
+# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
+# such as
+# /***************
+# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
+# Javadoc-style will behave just like regular comments and it will not be
+# interpreted by doxygen.
+# The default value is: NO.
+
+JAVADOC_BANNER         = NO
+
+# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
+# line (until the first dot) of a Qt-style comment as the brief description. If
+# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
+# requiring an explicit \brief command for a brief description.)
+# The default value is: NO.
+
+QT_AUTOBRIEF           = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
+# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
+# a brief description. This used to be the default behavior. The new default is
+# to treat a multi-line C++ comment block as a detailed description. Set this
+# tag to YES if you prefer the old behavior instead.
+#
+# Note that setting this tag to YES also means that rational rose comments are
+# not recognized any more.
+# The default value is: NO.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# 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                = "iscommand=@param argc The amount of arguments arriving to the function through a command call, equivalent to `argv.size()`.^^See @ref commandArgc \"CommandInfo's `action`'s first parameter\".^^@param argv The list of arguments passed to the function through a command call.^^See @ref commandArgv \"CommandInfo's `action`'s second parameter\""
+
+# This tag can be used to specify a number of word-keyword mappings (TCL only).
+# A mapping has the form "name=value". For example adding "class=itcl::class"
+# will allow you to use the command class in the itcl::class meaning.
+
+TCL_SUBST              =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
+# only. Doxygen will then generate output that is more tailored for C. For
+# instance, some of the names that are used will be different. The list of all
+# members will be omitted, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_FOR_C  = NO
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 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,
+# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
+# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
+# tries to guess whether the code is fixed or free formatted code, this is the
+# default for Fortran type files), VHDL, tcl. 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
+
+#---------------------------------------------------------------------------
+# 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        = YES
+
+# 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         = YES
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
+# locally in source files will be included in the documentation. If set to NO,
+# only classes defined in header files are included. 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) ands Mac users are advised to set this option to NO.
+# The default value is: system dependent.
+
+CASE_SENSE_NAMES       = YES
+
+# 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                  = src/ \
+                         include/ \
+                         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, *.f, *.for, *.tcl, *.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 \
+                         *.f \
+                         *.for \
+                         *.tcl \
+                         *.vhd \
+                         *.vhdl \
+                         *.ucf \
+                         *.qsf \
+                         *.ice
+
+# The RECURSIVE tag can be used to specify whether or not subdirectories should
+# be searched for input files as well.
+# The default value is: NO.
+
+RECURSIVE              = NO
+
+# The EXCLUDE tag can be used to specify files and/or directories that should be
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+#
+# Note that relative paths are relative to the directory from which doxygen is
+# run.
+
+EXCLUDE                = 
+
+# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
+# directories that are symbolic links (a Unix file system feature) are excluded
+# from the input.
+# The default value is: NO.
+
+EXCLUDE_SYMLINKS       = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories.
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories for example use the pattern */test/*
+
+EXCLUDE_PATTERNS       = 
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# 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 = README.md
+
+#---------------------------------------------------------------------------
+# 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
+
+# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
+# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
+# cost of reduced performance. This can be particularly helpful with template
+# rich C++ code for which doxygen's built-in parser lacks the necessary type
+# information.
+# Note: The availability of this option depends on whether or not doxygen was
+# generated with the -Duse_libclang=ON option for CMake.
+# The default value is: NO.
+
+CLANG_ASSISTED_PARSING = NO
+
+# If clang assisted parsing is enabled you can provide the compiler with command
+# line options that you would normally use when invoking the compiler. Note that
+# the include paths will already be set by doxygen for the files and directories
+# specified with INPUT and INCLUDE_PATH.
+# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
+
+CLANG_OPTIONS          =
+
+# If clang assisted parsing is enabled you can provide the clang parser with the
+# path to the compilation database (see:
+# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files
+# were built. This is equivalent to specifying the "-p" option to a clang tool,
+# such as clang-check. These options will then be passed to the parser.
+# Note: The availability of this option depends on whether or not doxygen was
+# generated with the -Duse_libclang=ON option for CMake.
+
+CLANG_DATABASE_PATH    =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
+# compounds will be generated. Enable this if the project contains a lot of
+# classes, structs, unions or interfaces.
+# The default value is: YES.
+
+ALPHABETICAL_INDEX     = YES
+
+# The 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    = 346
+
+# 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    = 83
+
+# 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 master .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           = YES
+
+# 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               = ../akashi.qch
+
+# 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          = Akashi
+
+# 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           = qhelpgenerator
+
+# 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      = NO
+
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
+# doxygen will group on one line in the generated HTML documentation.
+#
+# Note that a value of 0 will completely suppress the enum values from appearing
+# in the overview section.
+# Minimum value: 0, maximum value: 20, default value: 4.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+ENUM_VALUES_PER_LINE   = 4
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
+# to set the initial width (in pixels) of the frame in which the tree is shown.
+# Minimum value: 0, maximum value: 1500, default value: 250.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+TREEVIEW_WIDTH         = 250
+
+# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
+# external symbols imported via tag files in a separate window.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+EXT_LINKS_IN_WINDOW    = NO
+
+# 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://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_RELPATH        = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/
+
+# 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         = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# 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 pdflatex to generate
+# the PDF file directly from the LaTeX files. Set this option to YES, to get a
+# higher quality PDF documentation.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+USE_PDFLATEX           = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
+# command to the generated LaTeX files. This will instruct LaTeX to keep running
+# if errors occur, instead of asking the user for help. This option is also used
+# when generating formulas in HTML.
+# 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           = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: xml.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_OUTPUT             = xml
+
+# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
+# listings (including syntax highlighting and cross-referencing information) to
+# the XML output. Note that enabling this will significantly increase the size
+# of the XML output.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_PROGRAMLISTING     = YES
+
+# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
+# namespace members in file scope as well, matching the HTML output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_NS_MEMB_FILE_SCOPE = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the DOCBOOK output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
+# that can be used to generate PDF.
+# The default value is: NO.
+
+GENERATE_DOCBOOK       = NO
+
+# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
+# front of it.
+# The default directory is: docbook.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_OUTPUT         = docbook
+
+# 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 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: YES.
+
+HAVE_DOT               = YES
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
+# to run in parallel. When set to 0 doxygen will base this on the number of
+# processors available in the system. You can set it explicitly to a value
+# larger than 0 to get control over the balance between CPU load and processing
+# speed.
+# Minimum value: 0, maximum value: 32, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_NUM_THREADS        = 0
+
+# When you want a differently looking font in the dot files that doxygen
+# generates you can specify the font name using DOT_FONTNAME. You need to make
+# sure dot is able to find the font, which can be done by putting it in a
+# standard location or by setting the DOTFONTPATH environment variable or by
+# setting DOT_FONTPATH to the directory containing the font.
+# The default value is: Helvetica.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTNAME           = Helvetica
+
+# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
+# dot graphs.
+# Minimum value: 4, maximum value: 24, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTSIZE           = 10
+
+# By default doxygen will tell dot to use the default font as specified with
+# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
+# the path where dot can find it using this tag.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTPATH           =
+
+# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
+# each documented class showing the direct and indirect inheritance relations.
+# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CLASS_GRAPH            = YES
+
+# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
+# graph for each documented class showing the direct and indirect implementation
+# dependencies (inheritance, containment, and class references variables) of the
+# class with other documented classes.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+COLLABORATION_GRAPH    = YES
+
+# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
+# groups, showing the direct groups dependencies.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GROUP_GRAPHS           = YES
+
+# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LOOK               = NO
+
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
+# class node. If there are many fields or methods and many nodes the graph may
+# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
+# number of items for each type to make the size more manageable. Set this to 0
+# for no limit. Note that the threshold may be exceeded by 50% before the limit
+# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
+# but if the number exceeds 15, the total amount of fields shown is limited to
+# 10.
+# Minimum value: 0, maximum value: 100, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LIMIT_NUM_FIELDS   = 10
+
+# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
+# collaboration graphs will show the relations between templates and their
+# instances.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+TEMPLATE_RELATIONS     = NO
+
+# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
+# YES then doxygen will generate a graph for each documented file showing the
+# direct and indirect include dependencies of the file with other documented
+# files.
+# 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, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
+# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
+# gif:cairo:gd, gif:gd, gif:gd:gd, 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/doxygen/akashi.qch b/doxygen/akashi.qch
new file mode 100644
index 0000000..4582a17
Binary files /dev/null and b/doxygen/akashi.qch differ
diff --git a/include/advertiser.h b/include/advertiser.h
index 6c09caa..bdd834c 100644
--- a/include/advertiser.h
+++ b/include/advertiser.h
@@ -25,31 +25,106 @@
 #include <QString>
 #include <QTcpSocket>
 
+/**
+ * @brief A communicator class to update the master server on the server's status.
+ *
+ * @see https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md#master-server-protocol
+ * for more explanation about how to communicate with the master server.
+ */
 class Advertiser : public QObject {
     Q_OBJECT
 
   public:
-    Advertiser(QString p_ip, int p_port, int p_ws_port, int p_local_port,
-               QString p_name, QString p_description,
-               QObject* parent = nullptr);
+    /**
+     * @brief Constructor for the Advertiser class.
+     *
+     * @param p_ip The IP of the master server.
+     * @param p_port The port on which the connection to the master server should be established.
+     * @param p_ws_port The port on which the server will accept connections from clients through WebSocket.
+     * @param p_local_port The port on which the server will accept connections from clients through TCP.
+     * @param p_name The name of the server, as reported in the client's server browser.
+     * @param p_description The description of the server, as reported in the client's server browser.
+     * @param p_parent Qt-based parent, passed along to inherited constructor from QObject.
+     */
+    Advertiser(const QString p_ip, const int p_port, const int p_ws_port, const int p_local_port,
+               const QString p_name, const QString p_description, QObject* p_parent = nullptr) :
+        QObject(p_parent),
+        ip(p_ip),
+        port(p_port),
+        ws_port(p_ws_port),
+        local_port(p_local_port),
+        name(p_name),
+        description(p_description)
+    {};
+
+    /**
+     * @brief Destructor for the Advertiser class.
+     *
+     * @details Marks the socket used to establish connection to the master server to be deleted later.
+     */
     ~Advertiser();
+
+    /**
+     * @brief Sets up the socket used for master server connection, establishes connection to the master server.
+     */
     void contactMasterServer();
 
-signals:
-
   public slots:
+    /**
+     * @brief Handles data that was read from the master server's socket.
+     *
+     * @note Currently does nothing.
+     */
     void readData();
+
+    /**
+     * @brief Announces the server's presence to the master server.
+     */
     void socketConnected();
+
+    /**
+     * @brief Handles disconnection from the master server through the socket.
+     *
+     * @note Currently does nothing but outputs a line about the disconnection in the debug output.
+     */
     void socketDisconnected();
 
   private:
+    /**
+     * @copydoc ConfigManager::server_settings::ms_ip
+     */
     QString ip;
+
+    /**
+     * @copydoc ConfigManager::server_settings::ms_port
+     */
     int port;
+
+    /**
+     * @copydoc ConfigManager::server_settings::ws_port
+     */
     int ws_port;
+
+    /**
+     * @copydoc ConfigManager::server_settings::port
+     *
+     * @bug See #port.
+     */
     int local_port;
+
+    /**
+     * @copydoc ConfigManager::server_settings::name
+     */
     QString name;
+
+    /**
+     * @copydoc ConfigManager::server_settings::description
+     */
     QString description;
 
+    /**
+     * @brief The socket used to establish connection to the master server.
+     */
     QTcpSocket* socket;
 };
 
diff --git a/include/aoclient.h b/include/aoclient.h
index 690adbb..effbfcf 100644
--- a/include/aoclient.h
+++ b/include/aoclient.h
@@ -36,308 +36,1439 @@
 
 class Server;
 
+/**
+ * @brief Represents a client connected to the server running Attorney Online 2 or one of its derivatives.
+ */
 class AOClient : public QObject {
     Q_OBJECT
   public:
-    AOClient(Server* p_server, QTcpSocket* p_socket, QObject* parent = nullptr, int user_id = 0);
+    /**
+     * @brief Creates an instance of the AOClient class.
+     *
+     * @param p_server A pointer to the Server instance where the client is joining to.
+     * @param p_socket The socket associated with the AOClient.
+     * @param user_id The user ID of the client.
+     * @param parent Qt-based parent, passed along to inherited constructor from QObject.
+     */
+    AOClient(Server* p_server, QTcpSocket* p_socket, QObject* parent = nullptr, int user_id = 0)
+        : QObject(parent), id(user_id), remote_ip(p_socket->peerAddress()), password(""),
+          joined(false), current_area(0), current_char(""), socket(p_socket), server(p_server),
+          is_partial(false), last_wtce_time(0), last_message("") {};
+
+    /**
+      * @brief Destructor for the AOClient instance.
+      *
+      * @details Sets the socket to delete later.
+      */
     ~AOClient();
 
-    Server* getServer();
+    /**
+     * @brief Getter for the client's IPID.
+     *
+     * @return The IPID.
+     *
+     * @see #ipid
+     */
     QString getIpid();
+
+    /**
+     * @brief Calculates the client's IPID based on a hashed version of its IP.
+     */
     void calculateIpid();
 
+    /**
+     * @brief Getter for the pointer to the server.
+     *
+     * @return See brief description.
+     *
+     * @note Unused. There isn't really a point to this existing, either.
+     *
+     * @see #server
+     */
+    Server* getServer();
+
+    /**
+     * @brief The user ID of the client.
+     */
     int id;
 
+    /**
+     * @brief The IP address of the client.
+     */
     QHostAddress remote_ip;
+
+    /**
+     * @brief The stored character password for the client, used to be able to select passworded characters.
+     */
     QString password;
+
+    /**
+     * @brief True if the client is actually in the server.
+     *
+     * @details To explain: In AO, clients immediately establish connection to the server when the user clicks on the server's name in the server
+     * browser. Thus, as the user browses servers, they constantly connect and disconnect to and from servers.
+     *
+     * The purpose of this variable is to determine if the user isn't just doing that, but has actually double-clicked the server, and
+     * its client has sent the standard handshake packets, which does signify that the client intended to 'join' this server.
+     */
     bool joined;
+
+    /**
+     * @brief The ID of the area the client is currently in.
+     */
     int current_area;
+
+    /**
+     * @brief The internal name of the character the client is currently using.
+     */
     QString current_char;
+
+    /**
+     * @brief If true, the client is a logged-in moderator.
+     */
     bool authenticated = false;
+
+    /**
+     * @brief If using advanced authentication, this is the moderator name that the client has logged in with.
+     */
     QString moderator_name = "";
+
+    /**
+     * @brief The out-of-character name of the client, generally the nickname of the user themself.
+     */
     QString ooc_name = "";
+
+    /**
+     * @brief The custom showname of the client, used when "renaming" already existing characters in-character.
+     */
     QString showname = "";
+
+    /**
+     * @brief If true, the client is willing to receive global messages.
+     *
+     * @see AOClient::cmdG and AOClient::cmdToggleGlobal
+     */
     bool global_enabled = true;
+
+    /**
+     * @brief If true, the client may not use in-character chat.
+     */
     bool is_muted = false;
+    
+    /**
+     * @brief Represents the client's client software, and its version.
+     *
+     * @note Though the version number and naming scheme looks vaguely semver-like,
+     * do not be misled into thinking it is that.
+     */
     struct ClientVersion {
-      QString string;
-      int release = -1;
-      int major = -1;
-      int minor = -1;
+      QString string; //!< The name of the client software, for example, `AO2`.
+      int release = -1; //!< The 'release' part of the version number. In Attorney Online's case, this is fixed at `2`.
+      int major = -1; //!< The 'major' part of the version number. In Attorney Online's case, this increases when a new feature is introduced (generally).
+      int minor = -1; //!< The 'minor' part of the version number. In Attorney Online's case, this increases for bugfix releases (generally).
     };
+
+    /**
+     * @brief The software and version of the client.
+     *
+     * @see The struct itself for more details.
+     */
     ClientVersion version;
 
+    /**
+      * @brief The authorisation bitflag, representing what permissions a client can have.
+      *
+      * @showinitializer
+      */
     QMap<QString, unsigned long long> ACLFlags {
-        {"NONE", 0ULL},
-        {"KICK", 1ULL << 0},
-        {"BAN", 1ULL << 1},
-        {"BGLOCK", 1ULL << 2},
-        {"MODIFY_USERS", 1ULL << 3},
-        {"CM", 1ULL << 4},
-        {"GLOBAL_TIMER", 1ULL << 5},
-        {"EVI_MOD", 1ULL << 6},
-        {"MOTD", 1ULL << 7},
-        {"ANNOUNCE", 1ULL << 8},
-        {"MODCHAT", 1ULL << 9},
-        {"MUTE", 1ULL << 10},
-        {"SUPER", ~0ULL}
+        {"NONE",            0ULL      },
+        {"KICK",            1ULL << 0 },
+        {"BAN",             1ULL << 1 },
+        {"BGLOCK",          1ULL << 2 },
+        {"MODIFY_USERS",    1ULL << 3 },
+        {"CM",              1ULL << 4 },
+        {"GLOBAL_TIMER",    1ULL << 5 },
+        {"EVI_MOD",         1ULL << 6 },
+        {"MOTD",            1ULL << 7 },
+        {"ANNOUNCE",        1ULL << 8 },
+        {"MODCHAT",         1ULL << 9 },
+        {"MUTE",            1ULL << 10},
+        {"SUPER",          ~0ULL      },
     };
 
+    /**
+     * @brief If true, the client's in-character messages will have their word order randomised.
+     */
     bool is_shaken;
+
+    /**
+     * @brief If true, the client's in-character messages will have their vowels (English alphabet only) removed.
+     */
     bool is_disemvoweled;
+
+    /**
+     * @brief If true, the client's in-character messages will be overwritten by a randomly picked predetermined message.
+     */
     bool is_gimped;
 
   public slots:
+    /**
+     * @brief A slot for when the client disconnects from the server.
+     */
     void clientDisconnected();
+
+    /**
+     * @brief A slot for when the client sends data to the server.
+     */
     void clientData();
+
+    /**
+     * @brief A slot for sending a packet to the client.
+     *
+     * @param packet The packet to send.
+     */
     void sendPacket(AOPacket packet);
+
+    /**
+     * @overload
+     */
     void sendPacket(QString header, QStringList contents);
+
+    /**
+     * @overload
+     */
     void sendPacket(QString header);
 
   private:
+    /**
+     * @brief The TCP socket used to communicate with the client.
+     */
     QTcpSocket* socket;
+
+    /**
+     * @brief A pointer to the Server, used for updating server variables that depend on the client (e.g. amount of players in an area).
+     */
     Server* server;
 
+    /**
+     * @brief The type of area update, used for area update (ARUP) packets.
+     */
     enum ARUPType {
-        PLAYER_COUNT,
-        STATUS,
-        CM,
-        LOCKED
+        PLAYER_COUNT, //!< The packet contains player count updates.
+        STATUS, //!< The packet contains area status updates.
+        CM, //!< The packet contains updates about who's the CM of what area.
+        LOCKED //!< The packet contains updates about what areas are locked.
     };
 
+    /**
+     * @brief Used for the common parts of the dice rolling commands, to determine where the function should go after the common functionality.
+     *
+     * @see AOClient::diceThrower
+     */
     enum RollType {
-        ROLL,
-        ROLLP,
-        ROLLA
+        ROLL, //!< The roll is a simple numerical roll, should be announced in the area.
+        ROLLP, //!< The roll is a numerical roll, but private, the result should only be told to the caller.
+        ROLLA //!< The roll is an ability roll, the values must be read out of the ability die configs.
     };
 
+    /**
+     * @brief Handles an incoming packet, checking for authorisation and minimum argument count.
+     *
+     * @param packet The incoming packet.
+     */
     void handlePacket(AOPacket packet);
+
+    /**
+     * @brief Handles an incoming command, checking for authorisation and minimum argument count.
+     *
+     * @param command The incoming command.
+     * @param argc The amount of arguments the command was called with. Equivalent to `argv.size()`.
+     * @param argv The arguments the command was called with.
+     */
     void handleCommand(QString command, int argc, QStringList argv);
+
+    /**
+     * @brief Changes the area the client is in.
+     *
+     * @param new_area The ID of the new area.
+     */
     void changeArea(int new_area);
+
+    /**
+     * @brief Changes the client's character.
+     *
+     * @param char_id The character ID of the client's new character.
+     */
     void changeCharacter(int char_id);
+
+    /**
+     * @brief Changes the client's in-character position.
+     *
+     * @param new_pos The new position of the client.
+     */
     void changePosition(QString new_pos);
+
+    /**
+     * @brief Sends or announces an ARUP update.
+     *
+     * @param type The type of ARUP to send.
+     * @param broadcast If true, the update is sent out to all clients on the server. If false, it is only sent to this client.
+     *
+     * @see AOClient::ARUPType
+     */
     void arup(ARUPType type, bool broadcast);
+
+    /**
+     * @brief Sends all four types of ARUP to the client.
+     */
     void fullArup();
+
+    /**
+     * @brief Sends an out-of-character message originating from the server to the client.
+     *
+     * @param message The text of the message to send.
+     */
     void sendServerMessage(QString message);
+
+    /**
+     * @brief Like with AOClient::sendServerMessage(), but to every client in the client's area.
+     *
+     * @param message The text of the message to send.
+     */
     void sendServerMessageArea(QString message);
+
+    /**
+     * @brief Like with AOClient::sendServerMessage(), but to every client in the server.
+     *
+     * @param message The text of the message to send.
+     */
     void sendServerBroadcast(QString message);
+
+    /**
+     * @brief Checks if the client would be authorised to something based on its necessary permissions.
+     *
+     * @param acl_mask The permissions bitflag that the client's own permissions should be checked against.
+     *
+     * @return True if the client's permissions are high enough for `acl_mask`, or higher than it.
+     * False if the client is missing some permissions.
+     */
     bool checkAuth(unsigned long long acl_mask);
 
-    // Packet headers
+    /**
+      * @name Packet headers
+      *
+      * @details These functions implement the AO2-style packet handling.
+      * As these should generally be the same across server software, I see no reason to document them specifically.
+      *
+      * You can check out the AO2 network protocol for explanations.
+      *
+      * All packet handling functions share the same parameters:
+      *
+      * @param area The area the client is in. Some packets make use of the client's current area.
+      * @param argc The amount of arguments in the packet, not counting the header. Same as `argv.size()`.
+      * @param argv The arguments in the packet, once again, not counting the header.
+      * @param packet The... arguments in the packet. Yes, exactly the same as `argv`, just packed into an AOPacket.
+      *
+      * @see https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md for the AO2 network protocol.
+      */
+    ///@{
+
+    /// A "default" packet handler, to be used for error checking and copying other packet handlers.
     void pktDefault(AreaData* area, int argc, QStringList argv, AOPacket packet);
+
+    /// Implements [hardware ID](https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md#hard-drive-id).
     void pktHardwareId(AreaData* area, int argc, QStringList argv, AOPacket packet);
+
+    /**
+     * @brief Implements [feature list](https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md#feature-list) and
+     * [player count](https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md#player-count).
+     */
     void pktSoftwareId(AreaData* area, int argc, QStringList argv, AOPacket packet);
+
+    /// Implements [resource counts](https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md#resource-counts).
     void pktBeginLoad(AreaData* area, int argc, QStringList argv, AOPacket packet);
+
+    /// Implements [character list](https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md#character-list).
     void pktRequestChars(AreaData* area, int argc, QStringList argv, AOPacket packet);
+
+    /// Implements [music list](https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md#music-list).
     void pktRequestMusic(AreaData* area, int argc, QStringList argv, AOPacket packet);
+
+    /// Implements [the final loading confirmation](https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md#final-confirmation).
     void pktLoadingDone(AreaData* area, int argc, QStringList argv, AOPacket packet);
+
+    /**
+      * @brief Implements character passwording. This is not on the netcode documentation as of writing.
+      *
+      * @todo Link packet details when it gets into the netcode documentation.
+      */
     void pktCharPassword(AreaData* area, int argc, QStringList argv, AOPacket packet);
+
+    /// Implements [character selection](https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md#choose-character).
     void pktSelectChar(AreaData* area, int argc, QStringList argv, AOPacket packet);
+
+    /// Implements [the in-character messaging hell](https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md#in-character-message).
     void pktIcChat(AreaData* area, int argc, QStringList argv, AOPacket packet);
+
+    /// Implements [out-of-character messages](https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md#out-of-character-message).
     void pktOocChat(AreaData* area, int argc, QStringList argv, AOPacket packet);
+
+    /// Implements [the keepalive packet](https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md#keep-alive).
     void pktPing(AreaData* area, int argc, QStringList argv, AOPacket packet);
+
+    /**
+      * @brief Implements [music](https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md#music) and
+      * [area changing](https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md#switch-area).
+      */
     void pktChangeMusic(AreaData* area, int argc, QStringList argv, AOPacket packet);
+
+
+    /**
+      * @brief Implements [the witness testimony / cross examination / judge decision popups]
+      * (https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md#witness-testimonycross-examination-wtce).
+      */
     void pktWtCe(AreaData* area, int argc, QStringList argv, AOPacket packet);
+
+    /// Implements [penalty bars](https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md#penalty-health-bars).
     void pktHpBar(AreaData* area, int argc, QStringList argv, AOPacket packet);
+
+    /**
+      * @brief Implements WebSocket IP handling. This is not on the netcode documentation as of writing.
+      *
+      * @todo Link packet details when it gets into the netcode documentation.
+      */
     void pktWebSocketIp(AreaData* area, int argc, QStringList argv, AOPacket packet);
+
+    /// Implements [moderator calling](https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md#call-mod).
     void pktModCall(AreaData* area, int argc, QStringList argv, AOPacket packet);
+
+    /// Implements [adding evidence](https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md#add).
     void pktAddEvidence(AreaData* area, int argc, QStringList argv, AOPacket packet);
+
+    /// Implements [removing evidence](https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md#remove).
     void pktRemoveEvidence(AreaData* area, int argc, QStringList argv, AOPacket packet);
+
+    /// Implements [editing evidence](https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md#edit).
     void pktEditEvidence(AreaData* area, int argc, QStringList argv, AOPacket packet);
 
-    // Packet helper functions
+    ///@}
+
+    /**
+      * @name Packet helper functions
+      */
+    ///@{
+
+    /**
+     * @brief Calls AOClient::updateEvidenceList() for every client in the current client's area.
+     *
+     * @param area The current client's area.
+     */
     void sendEvidenceList(AreaData* area);
+
+    /**
+     * @brief Updates the evidence list in the area for the client.
+     *
+     * @param area The client's area.
+     */
     void updateEvidenceList(AreaData* area);
+
+    /**
+     * @brief Attempts to validate that hellish abomination that Attorney Online 2 calls an in-character packet.
+     *
+     * @param packet The packet to validate.
+     *
+     * @return A validated version of the input packet if it is correct, or an `"INVALID"` packet if it is not.
+     */
     AOPacket validateIcPacket(AOPacket packet);
+
+    /**
+     * @brief Removes excessive combining characters from a text.
+     *
+     * @param p_text The text to clear of its excessive combining characters.
+     *
+     * @return See brief description.
+     *
+     * @see https://en.wikipedia.org/wiki/Zalgo_text
+     */
     QString dezalgo(QString p_text);
+
+    /**
+     * @brief Checks if the client can modify the evidence in the area.
+     *
+     * @param area The client's area.
+     *
+     * @return True if the client can modify the evidence, false if not.
+     */
     bool checkEvidenceAccess(AreaData* area);
 
-    // Packet helper global variables
+    ///@}
+
+    /**
+      * @name Packet helper global variables
+      */
+    ///@{
+
+    /**
+     * @brief The client's character ID.
+     *
+     * @details A character ID is just the character's index in the server's character list.
+     *
+     * In general, the client assumes that this is a continuous block starting from 0.
+     */
     int char_id = -1;
+
+    /**
+     * @brief The character ID of the other character that the client wants to pair up with.
+     *
+     * @details Though this uses character ID, a client with *that* character ID must exist in the area for the pairing to work.
+     * Furthermore, the owner of that character ID must also do the reverse to this client, making their `pairing_with` equal
+     * to this client's character ID.
+     */
     int pairing_with = -1;
+
+    /**
+     * @brief The name of the emote last used by the client. No extension.
+     *
+     * @details This is used for pairing mainly, for the server to be able to craft a smooth-looking transition from one
+     * paired-up client talking to the next.
+     */
     QString emote = "";
+
+    /**
+     * @brief The amount the client was last offset by.
+     *
+     * @details This used to be just a plain number ranging from -100 to 100, but then Crystal mangled it by building some extra data into it.
+     * Cheers, love.
+     */
     QString offset = "";
+
+    /**
+     * @brief The last flipped state of the client.
+     */
     QString flipping = "";
+
+    /**
+     * @brief The last reported position of the client.
+     */
     QString pos = "";
 
+    ///@}
+
+    /// Describes a packet's interpretation details.
     struct PacketInfo {
-        unsigned long long acl_mask;
-        int minArgs;
+        unsigned long long acl_mask; //!< The permissions necessary for the packet.
+        int minArgs; //!< The minimum arguments needed for the packet to be interpreted correctly / make sense.
         void (AOClient::*action)(AreaData*, int, QStringList, AOPacket);
     };
 
+    /**
+      * @property PacketInfo::action
+      *
+      * @brief A function reference that contains what the packet actually does.
+      *
+      * @param AreaData This is always just a reference to the data of the area the sender client is in. Used by some packets.
+      * @param int When called, this parameter will be filled with the argument count.
+      * @param QStringList When called, this parameter will be filled the list of arguments.
+      * @param AOPacket This is a duplicated version of the QStringList above, containing the same data.
+      */
+
+    /**
+      * @brief The list of packets that the server can interpret.
+      *
+      * @showinitializer
+      *
+      * @tparam QString The header of the packet that uniquely identifies it.
+      * @tparam PacketInfo The details of the packet.
+      * See @ref PacketInfo "the type's documentation" for more details.
+      */
     const QMap<QString, PacketInfo> packets {
-        {"HI", {ACLFlags.value("NONE"), 1, &AOClient::pktHardwareId}},
-        {"ID", {ACLFlags.value("NONE"), 2, &AOClient::pktSoftwareId}},
-        {"askchaa", {ACLFlags.value("NONE"), 0, &AOClient::pktBeginLoad}},
-        {"RC", {ACLFlags.value("NONE"), 0, &AOClient::pktRequestChars}},
-        {"RM", {ACLFlags.value("NONE"), 0, &AOClient::pktRequestMusic}},
-        {"RD", {ACLFlags.value("NONE"), 0, &AOClient::pktLoadingDone}},
-        {"PW", {ACLFlags.value("NONE"), 1, &AOClient::pktCharPassword}},
-        {"CC", {ACLFlags.value("NONE"), 3, &AOClient::pktSelectChar}},
-        {"MS", {ACLFlags.value("NONE"), 15, &AOClient::pktIcChat}},
-        {"CT", {ACLFlags.value("NONE"), 2, &AOClient::pktOocChat}},
-        {"CH", {ACLFlags.value("NONE"), 1, &AOClient::pktPing}},
-        {"MC", {ACLFlags.value("NONE"), 2, &AOClient::pktChangeMusic}},
-        {"RT", {ACLFlags.value("NONE"), 1, &AOClient::pktWtCe}},
-        {"HP", {ACLFlags.value("NONE"), 2, &AOClient::pktHpBar}},
-        {"WSIP", {ACLFlags.value("NONE"), 1, &AOClient::pktWebSocketIp}},
-        {"ZZ", {ACLFlags.value("NONE"), 0, &AOClient::pktModCall}},
-        {"PE", {ACLFlags.value("NONE"), 3, &AOClient::pktAddEvidence}},
-        {"DE", {ACLFlags.value("NONE"), 1, &AOClient::pktRemoveEvidence}},
-        {"EE", {ACLFlags.value("NONE"), 4, &AOClient::pktEditEvidence}}
+        {"HI",      {ACLFlags.value("NONE"), 1,  &AOClient::pktHardwareId     }},
+        {"ID",      {ACLFlags.value("NONE"), 2,  &AOClient::pktSoftwareId     }},
+        {"askchaa", {ACLFlags.value("NONE"), 0,  &AOClient::pktBeginLoad      }},
+        {"RC",      {ACLFlags.value("NONE"), 0,  &AOClient::pktRequestChars   }},
+        {"RM",      {ACLFlags.value("NONE"), 0,  &AOClient::pktRequestMusic   }},
+        {"RD",      {ACLFlags.value("NONE"), 0,  &AOClient::pktLoadingDone    }},
+        {"PW",      {ACLFlags.value("NONE"), 1,  &AOClient::pktCharPassword   }},
+        {"CC",      {ACLFlags.value("NONE"), 3,  &AOClient::pktSelectChar     }},
+        {"MS",      {ACLFlags.value("NONE"), 15, &AOClient::pktIcChat         }},
+        {"CT",      {ACLFlags.value("NONE"), 2,  &AOClient::pktOocChat        }},
+        {"CH",      {ACLFlags.value("NONE"), 1,  &AOClient::pktPing           }},
+        {"MC",      {ACLFlags.value("NONE"), 2,  &AOClient::pktChangeMusic    }},
+        {"RT",      {ACLFlags.value("NONE"), 1,  &AOClient::pktWtCe           }},
+        {"HP",      {ACLFlags.value("NONE"), 2,  &AOClient::pktHpBar          }},
+        {"WSIP",    {ACLFlags.value("NONE"), 1,  &AOClient::pktWebSocketIp    }},
+        {"ZZ",      {ACLFlags.value("NONE"), 0,  &AOClient::pktModCall        }},
+        {"PE",      {ACLFlags.value("NONE"), 3,  &AOClient::pktAddEvidence    }},
+        {"DE",      {ACLFlags.value("NONE"), 1,  &AOClient::pktRemoveEvidence }},
+        {"EE",      {ACLFlags.value("NONE"), 4,  &AOClient::pktEditEvidence   }},
     };
 
-    //// Commands
+    /**
+     * @brief Literally just an invalid default command. That's it.
+     *
+     * @note Can be used as a base for future commands.
+     *
+     * @iscommand
+     */
     void cmdDefault(int argc, QStringList argv);
+
+    /**
+     * @brief Lists all the commands that the caller client has the permissions to use.
+     *
+     * @details No arguments.
+     *
+     * @iscommand
+     */
     void cmdHelp(int argc, QStringList argv);
+
+    /**
+     * @brief Gets or sets the server's Message Of The Day.
+     *
+     * @details If called without arguments, gets the MOTD.
+     *
+     * If it has any number of arguments, it is set as the **MOTD**.
+     *
+     * @iscommand
+     */
     void cmdMOTD(int argc, QStringList argv);
+
+    /**
+     * @brief Gives a very brief description of Akashi.
+     *
+     * @details No arguments.
+     *
+     * @iscommand
+     */
     void cmdAbout(int argc, QStringList argv);
-    // Authentication
+    
+    /**
+      * @name Authentication
+      */
+    ///@{
+
+    /**
+     * @brief Logs the user in as a moderator.
+     *
+     * @details If the authorisation type is `"simple"`, then this command expects one argument, the **global moderator password**.
+     *
+     * If the authorisation type is `"advanced"`, then it requires two arguments, the **moderator's username** and the **matching password**.
+     *
+     * @iscommand
+     */
     void cmdLogin(int argc, QStringList argv);
+
+    /**
+     * @brief Starts the authorisation type change from `"simple"` to `"advanced"`.
+     *
+     * @details No arguments.
+     *
+     * @iscommand
+     */
     void cmdChangeAuth(int argc, QStringList argv);
+
+    /**
+     * @brief Sets the root user's password.
+     *
+     * @details Accepts a single argument that will be the **root user's password**.
+     *
+     * @iscommand
+     *
+     * @pre AOClient::cmdChangeAuth()
+     */
     void cmdSetRootPass(int argc, QStringList argv);
+
+    /**
+     * @brief Adds a user to the moderators in `"advanced"` authorisation type.
+     *
+     * @details The first argument is the **user's name**, the second is their **password**.
+     *
+     * @iscommand
+     */
     void cmdAddUser(int argc, QStringList argv);
+
+    /**
+     * @brief Removes a user from the moderators in `"advanced"` authorisation type.
+     *
+     * @details Takes the **targer user's name** as the argument.
+     *
+     * @iscommand
+     */
     void cmdRemoveUser(int argc, QStringList argv);
+
+    /**
+     * @brief Lists the permission of a given user.
+     *
+     * @details If called without argument, lists the caller's permissions.
+     *
+     * If called with one argument, **a username**, lists that user's permissions.
+     *
+     * @iscommand
+     */
     void cmdListPerms(int argc, QStringList argv);
+
+    /**
+     * @brief Adds permissions to a given user.
+     *
+     * @details The first argument is the **target user**, the second is the **permission** (in string form) to add to that user.
+     *
+     * @iscommand
+     */
     void cmdAddPerms(int argc, QStringList argv);
+
+    /**
+     * @brief Removes permissions from a given user.
+     *
+     * @details The first argument is the **target user**, the second is the **permission** (in string form) to remove from that user.
+     *
+     * @iscommand
+     */
     void cmdRemovePerms(int argc, QStringList argv);
+
+    /**
+     * @brief Lists all users in the server's database.
+     *
+     * @details No arguments.
+     *
+     * @iscommand
+     */
     void cmdListUsers(int argc, QStringList argv);
+
+    /**
+     * @brief Logs the caller out from their moderator user.
+     *
+     * @details No arguments.
+     *
+     * @iscommand
+     */
     void cmdLogout(int argc, QStringList argv);
-    // Areas
+
+    ///@}
+
+    /**
+      * @name Areas
+      *
+      * @brief All functions that detail the actions of commands,
+      * that are also related to area management.
+      */
+    ///@{
+
+    /**
+     * @brief Promotes a client to CM status.
+     *
+     * @details If called without arguments, promotes the caller.
+     *
+     * If called with a **user ID** as an argument, and the caller is a CM, promotes the target client to CM status.
+     *
+     * @iscommand
+     */
     void cmdCM(int argc, QStringList argv);
+
+    /**
+     * @brief Removes the CM status from the caller.
+     *
+     * @details No arguments.
+     *
+     * @iscommand
+     */
     void cmdUnCM(int argc, QStringList argv);
+
+    /**
+     * @brief Invites a client to the area.
+     *
+     * @details Needs a **user ID** as an argument.
+     *
+     * @iscommand
+     *
+     * @see AreaData::LOCKED and AreaData::SPECTATABLE for the benefits of being invited.
+     */
     void cmdInvite(int argc, QStringList argv);
+
+    /**
+     * @brief Uninvites a client to the area.
+     *
+     * @details Needs a **user ID** as an argument.
+     *
+     * @iscommand
+     *
+     * @see AreaData::LOCKED and AreaData::SPECTATABLE for the benefits of being invited.
+     */
     void cmdUnInvite(int argc, QStringList argv);
+
+    /**
+     * @brief Locks the area.
+     *
+     * @details No arguments.
+     *
+     * @iscommand
+     *
+     * @see AreaData::LOCKED
+     */
     void cmdLock(int argc, QStringList argv);
+
+    /**
+     * @brief Sets the area to spectatable.
+     *
+     * @details No arguments.
+     *
+     * @iscommand
+     *
+     * @see AreaData::SPECTATABLE
+     */
     void cmdSpectatable(int argc, QStringList argv);
+
+    /**
+     * @brief Unlocks the area.
+     *
+     * @details No arguments.
+     *
+     * @iscommand
+     *
+     * @see AreaData::FREE
+     */
     void cmdUnLock(int argc, QStringList argv);
+
+    /**
+     * @brief Lists all clients in all areas.
+     *
+     * @details No arguments.
+     *
+     * @iscommand
+     */
     void cmdGetAreas(int argc, QStringList argv);
+
+    /**
+     * @brief Lists all clients in the area the caller is in.
+     *
+     * @details No arguments.
+     *
+     * @iscommand
+     */
     void cmdGetArea(int argc, QStringList argv);
+
+    /**
+     * @brief Moves the caller to the area with the given ID.
+     *
+     * @details Takes an **area ID** as an argument.
+     *
+     * @iscommand
+     */
     void cmdArea(int argc, QStringList argv);
+
+    /**
+     * @brief Kicks a client from the area, moving them back to the default area.
+     *
+     * @details Takes one argument, the **client's ID** to kick.
+     *
+     * @iscommand
+     */
     void cmdAreaKick(int argc, QStringList argv);
+
+    /**
+     * @brief Changes the background of the current area.
+     *
+     * @details Takes the **background's internal name** (generally the background's directory's name for the clients) as the only argument.
+     *
+     * @iscommand
+     */
     void cmdSetBackground(int argc, QStringList argv);
+
+    /**
+     * @brief Locks the background, preventing it from being changed.
+     *
+     * @details No arguments.
+     *
+     * @iscommand
+     */
     void cmdBgLock(int argc, QStringList argv);
+
+    /**
+     * @brief Unlocks the background, allowing it to be changed again.
+     *
+     * @details No arguments.
+     *
+     * @iscommand
+     */
     void cmdBgUnlock(int argc, QStringList argv);
+
+    /**
+     * @brief Changes the status of the current area.
+     *
+     * @details Takes a **status** as an argument. See AreaData::Status for permitted values.
+     *
+     * @iscommand
+     */
     void cmdStatus(int argc, QStringList argv);
+
+    /**
+     * @brief Returns the currently playing music in the area, and who played it.
+     *
+     * @details No arguments.
+     *
+     * @iscommand
+     */
     void cmdCurrentMusic(int argc, QStringList argv);
-    // Moderation
+
+    ///@}
+
+    /**
+      * @name Moderation
+      *
+      * @brief All functions that detail the actions of commands,
+      * that are also related to the moderation and administration of the server.
+      */
+    ///@{
+
+    /**
+     * @brief Lists the currently logged-in moderators on the server.
+     *
+     * @details No arguments.
+     *
+     * @iscommand
+     */
     void cmdMods(int argc, QStringList argv);
+
+    /**
+     * @brief Bans a client from the server, forcibly severing its connection to the server,
+     * and disallowing their return.
+     *
+     * @details The first argument is the **target's IPID**, the second is the **reason** why the client
+     * was banned, the third is the **duration**.
+     *
+     * Both the reason and the duration must be in quotation marks.
+     *
+     * The duration can be `"perma"`, meaning a forever ban, otherwise, it must be given in the format of `"YYyWWwDDdHHhMMmSSs"` to
+     * mean a YY years, WW weeks, DD days, HH hours, MM minutes and SS seconds long ban. Any of these may be left out, for example,
+     * `"1h30m"` for a 1.5 hour long ban.
+     *
+     * Besides banning, this command kicks all clients having the given IPID,
+     * thus a multiclienting user will have all their clients be kicked from the server.
+     *
+     * The target's hardware ID is also recorded in a ban, so users with dynamic IPs will not be able to
+     * cirvumvent the ban without also changing their hardware ID.
+     *
+     * @iscommand
+     */
     void cmdBan(int argc, QStringList argv);
+
+    /**
+     * @brief Removes a ban from the database.
+     *
+     * @details Takes a single argument, the **ID** of the ban.
+     *
+     * @iscommand
+     */
     void cmdUnBan(int argc, QStringList argv);
+
+    /**
+     * @brief Kicks a client from the server, forcibly severing its connection to the server.
+     *
+     * @details The first argument is the **target's IPID**, while the remaining arguments are the **reason**
+     * the client was kicked. Both arguments are mandatory.
+     *
+     * This command kicks all clients having the given IPID, thus a multiclienting user will have all
+     * their clients be kicked from the server.
+     *
+     * @iscommand
+     */
     void cmdKick(int argc, QStringList argv);
+
+    /**
+     * @brief Sends out a decorated global message, for announcements.
+     *
+     * @details The arguments are **the message** that the client wants to send.
+     *
+     * @iscommand
+     *
+     * @see AOClient::cmdG()
+     */
     void cmdAnnounce(int argc, QStringList argv);
+
+    /**
+     * @brief Sends a message in the server-wide, moderator only chat.
+     *
+     * @details The arguments are **the message** that the client wants to send.
+     *
+     * @iscommand
+     */
     void cmdM(int argc, QStringList argv);
+
+    /**
+     * @brief Sends out a global message that is marked with an `[M]` to mean it is coming from a moderator.
+     *
+     * @details The arguments are **the message** that the client wants to send.
+     *
+     * @iscommand
+     *
+     * @see AOClient::cmdG()
+     */
     void cmdGM(int argc, QStringList argv);
+
+    /**
+     * @brief Mutes a client.
+     *
+     * @details The only argument is the **target client's user ID**.
+     *
+     * @iscommand
+     *
+     * @see #is_muted
+     */
     void cmdMute(int argc, QStringList argv);
+
+    /**
+     * @brief Removes the muted status a client.
+     *
+     * @details The only argument is the **target client's user ID**.
+     *
+     * @iscommand
+     *
+     * @see #is_muted
+     */
     void cmdUnmute(int argc, QStringList argv);
+
+    /**
+     * @brief Lists the last five bans made on the server.
+     *
+     * @details No arguments.
+     *
+     * @iscommand
+     */
     void cmdBans(int argc, QStringList argv);
-    // Casing/RP
+
+    ///@}
+
+    /**
+      * @name Roleplay
+      *
+      * @brief All functions that detail the actions of commands,
+      * that are also related to various kinds of roleplay actions in some way.
+      */
+    ///@{
+
+    /**
+     * @brief Plays music in the area.
+     *
+     * @details The arguments are **the song's filepath** originating from `base/sounds/music/`,
+     * or **the song's URL** if it's a stream.
+     *
+     * As described above, this command can be used to play songs by URL (for clients at and above version 2.9),
+     * but it can also be used to play songs locally available for the clients but not listed in the music list.
+     *
+     * @iscommand
+     */
     void cmdPlay(int argc, QStringList argv);
+
+    /**
+     * @brief A global message expressing that the client needs something (generally: players for something).
+     *
+     * @details The arguments are **the message** that the client wants to send.
+     *
+     * @iscommand
+     */
     void cmdNeed(int argc, QStringList argv);
+
+    /**
+     * @brief Flips a coin, returning heads or tails.
+     *
+     * @details No arguments.
+     *
+     * @iscommand
+     */
     void cmdFlip(int argc, QStringList argv);
+
+    /**
+     * @brief Rolls dice, summing the results.
+     *
+     * @details The first argument is the **amount of faces** each die should have.
+     * The second argument is the **amount of dice** that should be rolled.
+     *
+     * Both arguments are optional.
+     *
+     * @iscommand
+     *
+     * @see AOClient::diceThrower
+     */
     void cmdRoll(int argc, QStringList argv);
+
+    /**
+     * @brief Rolls dice, but sends the results in private to the roller.
+     *
+     * @copydetails AOClient::cmdRoll
+     */
     void cmdRollP(int argc, QStringList argv);
+
+    /**
+     * @brief Sets the `/doc` to a custom text.
+     *
+     * @details The arguments are **the text** that the client wants to set the doc to.
+     *
+     * @iscommand
+     */
     void cmdDoc(int argc, QStringList argv);
+
+    /**
+     * @brief Sets the `/doc` to `"No document."`.
+     *
+     * @details No arguments.
+     *
+     * @iscommand
+     */
     void cmdClearDoc(int argc, QStringList argv);
+
+    /**
+     * @brief Gets or sets the global or one of the area-specific timers.
+     *
+     * @details If called without arguments, sends an out-of-character message listing the statuses of both
+     * the global timer and the area-specific timers.
+     *
+     * If called with **one argument**, and that argument is between `0` and `4` (inclusive on both ends),
+     * sends an out-of-character message about the status of the given timer, where `0` is the global timer,
+     * and the remaining numbers are the first, second, third and fourth timers in the current area.
+     *
+     * If called with **two arguments**, and the second argument is
+     * * in the format of `hh:mm:ss`, then it starts the given timer,
+     *   with `hh` hours, `mm` minutes, and `ss` seconds on it, making it appear if needed.
+     * * `start`, it (re)starts the given timer, making it appear if needed.
+     * * `pause` or `stop`, it pauses the given timer.
+     * * `hide` or `unset`, it stops the timer and hides it.
+     *
+     * @iscommand
+     */
     void cmdTimer(int argc, QStringList argv);
+
+    /**
+     * @brief Changes the evidence mod in the area.
+     *
+     * @details The only argument is the **evidence mod** to change to.
+     *
+     * @iscommand
+     *
+     * @see AreaData::EvidenceMod
+     */
     void cmdEvidenceMod(int argc, QStringList argv);
+
+    /**
+     * @brief Changes the subtheme of the clients in the current area.
+     *
+     * @details The only argument is the **name of the subtheme**. Reloading is always forced.
+     *
+     * @iscommand
+     */
     void cmdSubTheme(int argc, QStringList argv);
-    // Messaging/Client
+    
+    ///@}
+
+    /**
+      * @name Messaging
+      *
+      * @brief All functions that detail the actions of commands,
+      * that are also related to messages or the client's self-management in some way.
+      */
+    ///@{
+
+    /**
+     * @brief Changes the client's position.
+     *
+     * @details The only argument is the **target position** to move the client to.
+     *
+     * @iscommand
+     */
     void cmdPos(int argc, QStringList argv);
+
+    /**
+     * @brief Forces a client, or all clients in the area, to a specific position.
+     *
+     * @details The first argument is the **client's ID**, or `\*` if the client wants to force all
+     * clients in their area into the position.
+     * If a specific client ID is given, this command can reach across areas, i.e., the caller and target
+     * clients don't have to share areas.
+     *
+     * The second argument is the **position** to force the clients to.
+     * This is not checked for nonsense values.
+     *
+     * @iscommand
+     */
     void cmdForcePos(int argc, QStringList argv);
+
+    /**
+     * @brief Switches to a different character based on character ID.
+     *
+     * @details The only argument is the **character's ID** that the client wants to switch to.
+     *
+     * @iscommand
+     */
     void cmdSwitch(int argc, QStringList argv);
+
+    /**
+     * @brief Picks a new random character for the client.
+     *
+     * @details No arguments.
+     *
+     * Can silently "fail" if the character picked is already being used by another client.
+     *
+     * @iscommand
+     */
     void cmdRandomChar(int argc, QStringList argv);
+
+    /**
+     * @brief Sends a global message (i.e., all clients in the server will be able to see it).
+     *
+     * @details The arguments are **the message** that the client wants to send.
+     *
+     * @iscommand
+     */
     void cmdG(int argc, QStringList argv);
+
+    /**
+     * @brief Toggles whether the client will ignore @ref cmdG "global" messages or not.
+     *
+     * @details No arguments.
+     *
+     * @iscommand
+     */
     void cmdToggleGlobal(int argc, QStringList argv);
+
+    /**
+     * @brief Sends a direct message to another client on the server based on ID.
+     *
+     * @details Has two arguments, the first is **the target's ID** whom the client wants to send the message to,
+     * while the second is **the message** the client wants to send.
+     *
+     * The "second" part is technically everything that isn't the first argument.
+     *
+     * @iscommand
+     */
     void cmdPM(int argc, QStringList argv);
 
-    // Command helper functions
+    ///@}
+
+    /**
+      * @name Command helper functions
+      *
+      * @brief A collection of functions of shared behaviour between command functions,
+      * allowing the abstraction of technical details in the command function definition,
+      * or the avoidance of repetition over multiple definitions.
+      */
+    ///@{
+
+    /**
+     * @brief Returns a textual representation of the time left in an area's Timer.
+     *
+     * @param area_idx The ID of the area whose timer to grab.
+     * @param timer The pointer to the area's timer.
+     *
+     * @return A textual representation of the time left over on the Timer,
+     * or `"Timer is inactive"` if the timer wasn't started.
+     */
     QString getAreaTimer(int area_idx, QTimer* timer);
+
+    /**
+     * @brief Generates a tsuserver3-style area list to be displayed to the user in the out-of-character chat.
+     *
+     * @details This list shows general details about the area the caller is currently in,
+     * like who is the owner, what players are in there, the status of the area, etc.
+     *
+     * @param area_idx The index of the area whose details should be generated.
+     *
+     * @return A QStringList of details about the given area, with every entry in the string list amounting to
+     * roughly a separate line.
+     */
     QStringList buildAreaList(int area_idx);
+
+    /**
+     * @brief Convenience function to generate a random integer number between the given minimum and maximum values.
+     *
+     * @param min The minimum possible value for the random integer, inclusive.
+     * @param max The maximum possible value for the random integer, exclusive.
+     *
+     * @warning `max` must be greater than `min`.
+     *
+     * @return A randomly generated integer within the bounds given.
+     */
     int genRand(int min, int max);
+
+    /**
+     * @brief A convenience function unifying the various dice-rolling methods.
+     *
+     * @internal
+     *  Babby's first code. <3
+     * @endinternal
+     *
+     * @param argc The amount of arguments arriving to the function through a command call,
+     * equivalent to `argv.size()`.
+     * See @ref commandArgc "CommandInfo's `action`'s first parameter".
+     * @param argv The list of arguments passed to the function through a command call.
+     * See @ref commandArgv "CommandInfo's `action`'s second parameter".
+     * @param Type The type of the dice-rolling being done.
+     */
     void diceThrower(int argc, QStringList argv, RollType Type);
+
+    /**
+     * @brief Interprets an expression of time into amount of seconds.
+     *
+     * @param input A string in the format of `"XXyXXwXXdXXhXXmXXs"`, where every `XX` is some integer.
+     * There is no limit on the length of the integers, the `XX` text is just a placeholder, and is not intended to
+     * indicate a limit of two digits maximum.
+     *
+     * The string gets interpreted as follows:
+     * * `XXy` is parsed into `XX` amount of years,
+     * * `XXw` is parsed into `XX` amount of weeks,
+     * * `XXd` is parsed into `XX` amount of days,
+     * * `XXh` is parsed into `XX` amount of hours,
+     * * `XXm` is parsed into `XX` amount of minutes, and
+     * * `XXs` is parsed into `XX` amount of seconds.
+     *
+     * Any of these may be left out, but the order must be kept (i.e., `"10s5y"` is a malformed text).
+     *
+     * @return The parsed text, converted into their respective durations, summed up, then converted into seconds.
+     */
     long long parseTime(QString input);
 
-    // Command function global variables
+    ///@}
+
+    /**
+     * @brief A helper variable that is used to direct the called of the `/changeAuth` command through the process
+     * of changing the authorisation method from simple to advanced.
+     *
+     * @see cmdChangeAuth and cmdSetRootPass
+     */
     bool change_auth_started = false;
 
+    /**
+     * @brief Describes a command's details.
+     */
     struct CommandInfo {
-        unsigned long long acl_mask;
-        int minArgs;
+        unsigned long long acl_mask; //!< The permissions necessary to be able to run the command. @see ACLFlags.
+        int minArgs; //!< The minimum mandatory arguments needed for the command to function.
         void (AOClient::*action)(int, QStringList);
     };
 
+    /**
+      * @property CommandInfo::action
+      *
+      * @brief A function reference that contains what the command actually does.
+      *
+      * @param int When called, this parameter will be filled with the argument count. @anchor commandArgc
+      * @param QStringList When called, this parameter will be filled the list of arguments. @anchor commandArgv
+      */
+
+    /**
+      * @brief The list of commands available on the server.
+      *
+      * @details Generally called with the format of `/command parameters` in the out-of-character chat.
+      * @showinitializer
+      *
+      * @tparam QString The name of the command, without the leading slash.
+      * @tparam CommandInfo The details of the command.
+      * See @ref CommandInfo "the type's documentation" for more details.
+      */
     const QMap<QString, CommandInfo> commands {
-        {"login", {ACLFlags.value("NONE"), 1, &AOClient::cmdLogin}},
-        {"getareas", {ACLFlags.value("NONE"), 0 , &AOClient::cmdGetAreas}},
-        {"getarea", {ACLFlags.value("NONE"), 0, &AOClient::cmdGetArea}},
-        {"ban", {ACLFlags.value("BAN"), 2, &AOClient::cmdBan}},
-        {"kick", {ACLFlags.value("KICK"), 2, &AOClient::cmdKick}},
-        {"changeauth", {ACLFlags.value("SUPER"), 0, &AOClient::cmdChangeAuth}},
-        {"rootpass", {ACLFlags.value("SUPER"), 1, &AOClient::cmdSetRootPass}},
-        {"background", {ACLFlags.value("NONE"), 1, &AOClient::cmdSetBackground}},
-        {"bg", {ACLFlags.value("NONE"), 1, &AOClient::cmdSetBackground}},
-        {"bglock", {ACLFlags.value("BGLOCK"), 0, &AOClient::cmdBgLock}},
-        {"bgunlock", {ACLFlags.value("BGLOCK"), 0, &AOClient::cmdBgUnlock}},
-        {"adduser", {ACLFlags.value("MODIFY_USERS"), 2, &AOClient::cmdAddUser}},
-        {"listperms", {ACLFlags.value("NONE"), 0, &AOClient::cmdListPerms}},
-        {"addperm", {ACLFlags.value("MODIFY_USERS"), 2, &AOClient::cmdAddPerms}},
-        {"removeperm", {ACLFlags.value("MODIFY_USERS"), 2, &AOClient::cmdRemovePerms}},
-        {"listusers", {ACLFlags.value("MODIFY_USERS"), 0, &AOClient::cmdListUsers}},
-        {"logout", {ACLFlags.value("NONE"), 0, &AOClient::cmdLogout}},
-        {"pos", {ACLFlags.value("NONE"), 1, &AOClient::cmdPos}},
-        {"g", {ACLFlags.value("NONE"), 1, &AOClient::cmdG}},
-        {"need", {ACLFlags.value("NONE"), 1, &AOClient::cmdNeed}},
-        {"coinflip", {ACLFlags.value("NONE"), 0, &AOClient::cmdFlip}},
-        {"roll", {ACLFlags.value("NONE"), 0, &AOClient::cmdRoll}},
-        {"rollp", {ACLFlags.value("NONE"), 0, &AOClient::cmdRollP}},
-        {"doc", {ACLFlags.value("NONE"), 0, &AOClient::cmdDoc}},
-        {"cleardoc", {ACLFlags.value("NONE"), 0, &AOClient::cmdClearDoc}},
-        {"cm", {ACLFlags.value("NONE"), 0, &AOClient::cmdCM}},
-        {"uncm", {ACLFlags.value("CM"), 0, &AOClient::cmdUnCM}},
-        {"invite", {ACLFlags.value("CM"), 1, &AOClient::cmdInvite}},
-        {"uninvite", {ACLFlags.value("CM"), 1, &AOClient::cmdUnInvite}},
-        {"lock", {ACLFlags.value("CM"), 0, &AOClient::cmdLock}},
-        {"area_lock", {ACLFlags.value("CM"), 0, &AOClient::cmdLock}},
-        {"spectatable", {ACLFlags.value("CM"), 0, &AOClient::cmdSpectatable}},
-        {"area_spectate", {ACLFlags.value("CM"), 0, &AOClient::cmdSpectatable}},
-        {"unlock", {ACLFlags.value("CM"), 0, &AOClient::cmdUnLock}},
-        {"area_unlock", {ACLFlags.value("CM"), 0, &AOClient::cmdUnLock}},
-        {"timer", {ACLFlags.value("CM"), 0, &AOClient::cmdTimer}},
-        {"area", {ACLFlags.value("NONE"), 1, &AOClient::cmdArea}},
-        {"play", {ACLFlags.value("CM"), 1, &AOClient::cmdPlay}},
-        {"areakick", {ACLFlags.value("CM"), 1, &AOClient::cmdAreaKick}},
-        {"area_kick", {ACLFlags.value("CM"), 1, &AOClient::cmdAreaKick}},
-        {"randomchar", {ACLFlags.value("NONE"), 0, &AOClient::cmdRandomChar}},
-        {"switch", {ACLFlags.value("NONE"), 1, &AOClient::cmdSwitch}},
-        {"toggleglobal", {ACLFlags.value("NONE"), 0, &AOClient::cmdToggleGlobal}},
-        {"mods", {ACLFlags.value("NONE"), 0, &AOClient::cmdMods}},
-        {"help", {ACLFlags.value("NONE"), 0, &AOClient::cmdHelp}},
-        {"status", {ACLFlags.value("NONE"), 1, &AOClient::cmdStatus}},
-        {"forcepos", {ACLFlags.value("CM"), 2, &AOClient::cmdForcePos}},
-        {"currentmusic", {ACLFlags.value("NONE"), 0, &AOClient::cmdCurrentMusic}},
-        {"pm", {ACLFlags.value("NONE"), 2, &AOClient::cmdPM}},
-        {"evidence_mod", {ACLFlags.value("EVI_MOD"), 1, &AOClient::cmdEvidenceMod}},
-        {"motd", {ACLFlags.value("NONE"), 0, &AOClient::cmdMOTD}},
-        {"announce", {ACLFlags.value("ANNOUNCE"), 1, &AOClient::cmdAnnounce}},
-        {"m", {ACLFlags.value("MODCHAT"), 1, &AOClient::cmdM}},
-        {"gm", {ACLFlags.value("MODCHAT"), 1, &AOClient::cmdGM}},
-        {"mute", {ACLFlags.value("MUTE"), 1, &AOClient::cmdMute}},
-        {"unmute", {ACLFlags.value("MUTE"), 1, &AOClient::cmdUnmute}},
-        {"bans", {ACLFlags.value("BAN"), 0, &AOClient::cmdBans}},
-        {"unban", {ACLFlags.value("BAN"), 1, &AOClient::cmdUnBan}},
-        {"removeuser", {ACLFlags.value("MODIFY_USERS"), 1, &AOClient::cmdRemoveUser}},
-        {"subtheme", {ACLFlags.value("CM"), 1, &AOClient::cmdSubTheme}},
-        {"about", {ACLFlags.value("NONE"), 0, &AOClient::cmdAbout}}
+        {"login",         {ACLFlags.value("NONE"),         1, &AOClient::cmdLogin}},
+        {"getareas",      {ACLFlags.value("NONE"),         0, &AOClient::cmdGetAreas}},
+        {"getarea",       {ACLFlags.value("NONE"),         0, &AOClient::cmdGetArea}},
+        {"ban",           {ACLFlags.value("BAN"),          2, &AOClient::cmdBan}},
+        {"kick",          {ACLFlags.value("KICK"),         2, &AOClient::cmdKick}},
+        {"changeauth",    {ACLFlags.value("SUPER"),        0, &AOClient::cmdChangeAuth}},
+        {"rootpass",      {ACLFlags.value("SUPER"),        1, &AOClient::cmdSetRootPass}},
+        {"background",    {ACLFlags.value("NONE"),         1, &AOClient::cmdSetBackground}},
+        {"bg",            {ACLFlags.value("NONE"),         1, &AOClient::cmdSetBackground}},
+        {"bglock",        {ACLFlags.value("BGLOCK"),       0, &AOClient::cmdBgLock}},
+        {"bgunlock",      {ACLFlags.value("BGLOCK"),       0, &AOClient::cmdBgUnlock}},
+        {"adduser",       {ACLFlags.value("MODIFY_USERS"), 2, &AOClient::cmdAddUser}},
+        {"listperms",     {ACLFlags.value("NONE"),         0, &AOClient::cmdListPerms}},
+        {"addperm",       {ACLFlags.value("MODIFY_USERS"), 2, &AOClient::cmdAddPerms}},
+        {"removeperm",    {ACLFlags.value("MODIFY_USERS"), 2, &AOClient::cmdRemovePerms}},
+        {"listusers",     {ACLFlags.value("MODIFY_USERS"), 0, &AOClient::cmdListUsers}},
+        {"logout",        {ACLFlags.value("NONE"),         0, &AOClient::cmdLogout}},
+        {"pos",           {ACLFlags.value("NONE"),         1, &AOClient::cmdPos}},
+        {"g",             {ACLFlags.value("NONE"),         1, &AOClient::cmdG}},
+        {"need",          {ACLFlags.value("NONE"),         1, &AOClient::cmdNeed}},
+        {"coinflip",      {ACLFlags.value("NONE"),         0, &AOClient::cmdFlip}},
+        {"roll",          {ACLFlags.value("NONE"),         0, &AOClient::cmdRoll}},
+        {"rollp",         {ACLFlags.value("NONE"),         0, &AOClient::cmdRollP}},
+        {"doc",           {ACLFlags.value("NONE"),         0, &AOClient::cmdDoc}},
+        {"cleardoc",      {ACLFlags.value("NONE"),         0, &AOClient::cmdClearDoc}},
+        {"cm",            {ACLFlags.value("NONE"),         0, &AOClient::cmdCM}},
+        {"uncm",          {ACLFlags.value("CM"),           0, &AOClient::cmdUnCM}},
+        {"invite",        {ACLFlags.value("CM"),           1, &AOClient::cmdInvite}},
+        {"uninvite",      {ACLFlags.value("CM"),           1, &AOClient::cmdUnInvite}},
+        {"lock",          {ACLFlags.value("CM"),           0, &AOClient::cmdLock}},
+        {"area_lock",     {ACLFlags.value("CM"),           0, &AOClient::cmdLock}},
+        {"spectatable",   {ACLFlags.value("CM"),           0, &AOClient::cmdSpectatable}},
+        {"area_spectate", {ACLFlags.value("CM"),           0, &AOClient::cmdSpectatable}},
+        {"unlock",        {ACLFlags.value("CM"),           0, &AOClient::cmdUnLock}},
+        {"area_unlock",   {ACLFlags.value("CM"),           0, &AOClient::cmdUnLock}},
+        {"timer",         {ACLFlags.value("CM"),           0, &AOClient::cmdTimer}},
+        {"area",          {ACLFlags.value("NONE"),         1, &AOClient::cmdArea}},
+        {"play",          {ACLFlags.value("CM"),           1, &AOClient::cmdPlay}},
+        {"areakick",      {ACLFlags.value("CM"),           1, &AOClient::cmdAreaKick}},
+        {"area_kick",     {ACLFlags.value("CM"),           1, &AOClient::cmdAreaKick}},
+        {"randomchar",    {ACLFlags.value("NONE"),         0, &AOClient::cmdRandomChar}},
+        {"switch",        {ACLFlags.value("NONE"),         1, &AOClient::cmdSwitch}},
+        {"toggleglobal",  {ACLFlags.value("NONE"),         0, &AOClient::cmdToggleGlobal}},
+        {"mods",          {ACLFlags.value("NONE"),         0, &AOClient::cmdMods}},
+        {"help",          {ACLFlags.value("NONE"),         0, &AOClient::cmdHelp}},
+        {"status",        {ACLFlags.value("NONE"),         1, &AOClient::cmdStatus}},
+        {"forcepos",      {ACLFlags.value("CM"),           2, &AOClient::cmdForcePos}},
+        {"currentmusic",  {ACLFlags.value("NONE"),         0, &AOClient::cmdCurrentMusic}},
+        {"pm",            {ACLFlags.value("NONE"),         2, &AOClient::cmdPM}},
+        {"evidence_mod",  {ACLFlags.value("EVI_MOD"),      1, &AOClient::cmdEvidenceMod}},
+        {"motd",          {ACLFlags.value("NONE"),         0, &AOClient::cmdMOTD}},
+        {"announce",      {ACLFlags.value("ANNOUNCE"),     1, &AOClient::cmdAnnounce}},
+        {"m",             {ACLFlags.value("MODCHAT"),      1, &AOClient::cmdM}},
+        {"gm",            {ACLFlags.value("MODCHAT"),      1, &AOClient::cmdGM}},
+        {"mute",          {ACLFlags.value("MUTE"),         1, &AOClient::cmdMute}},
+        {"unmute",        {ACLFlags.value("MUTE"),         1, &AOClient::cmdUnmute}},
+        {"bans",          {ACLFlags.value("BAN"),          0, &AOClient::cmdBans}},
+        {"unban",         {ACLFlags.value("BAN"),          1, &AOClient::cmdUnBan}},
+        {"removeuser",    {ACLFlags.value("MODIFY_USERS"), 1, &AOClient::cmdRemoveUser}},
+        {"subtheme",      {ACLFlags.value("CM"),           1, &AOClient::cmdSubTheme}},
+        {"about",         {ACLFlags.value("NONE"),         0, &AOClient::cmdAbout}},
     };
 
+    /**
+     * @brief Filled with part of a packet if said packet could not be read fully from the client's socket.
+     *
+     * @details Per AO2's network protocol, a packet is finished with the character `%`.
+     *
+     * @see #is_partial
+     */
     QString partial_packet;
+
+    /**
+     * @brief True when the previous `readAll()` call from the client's socket returned an unfinished packet.
+     *
+     * @see #partial_packet
+     */
     bool is_partial;
 
+    /**
+     * @brief The hardware ID of the client.
+     *
+     * @details Generated based on the client's own supplied hardware ID.
+     * The client supplied hardware ID is generally a machine unique ID.
+     */
     QString hwid;
+
+    /**
+     * @brief The IPID of the client.
+     *
+     * @details Generated based on the client's IP, but cannot be reversed to identify the client's IP.
+     */
     QString ipid;
+
+    /**
+     * @brief The time in seconds since the client last sent a Witness Testimony / Cross Examination
+     * popup packet.
+     *
+     * @details Used to filter out potential spam.
+     */
     long last_wtce_time;
+
+    /**
+     * @brief The text of the last in-character message that was sent by the client.
+     *
+     * @details Used to determine if the incoming message is a duplicate.
+     */
     QString last_message;
 };
 
diff --git a/include/aopacket.h b/include/aopacket.h
index c66eb88..3510687 100644
--- a/include/aopacket.h
+++ b/include/aopacket.h
@@ -23,14 +23,51 @@
 #include <QString>
 #include <QStringList>
 
+/**
+ * @brief An Attorney Online 2 compatible packet.
+ *
+ * @see https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md for a general explanation
+ * on Attorney Online 2's network protocol.
+ */
 class AOPacket {
   public:
+    /**
+     * @brief Creates an AOPacket with the given header and contents.
+     *
+     * @param p_header The header for the packet.
+     * @param p_contents The contents of the packet.
+     */
     AOPacket(QString p_header, QStringList p_contents);
+
+    /**
+     * @brief AOPacket Interprets a string of a full (header + content) packet into an AOPacket.
+     *
+     * @param packet The string to interpret.
+     */
     AOPacket(QString packet);
+
+    /**
+     * @brief Returns the string representation of the packet.
+     *
+     * @return See brief description.
+     */
     QString toString();
+
+    /**
+     * @brief Convenience function over AOPacket::toString() + QString::toUtf8().
+     *
+     * @return A UTF-8 representation of the packet.
+     */
     QByteArray toUtf8();
 
+    /**
+     * @brief The string that indentifies the type of the packet.
+     */
     QString header;
+
+    /**
+     * @brief The list of parameters for the packet. Can be empty.
+     */
     QStringList contents;
 };
 
diff --git a/include/area_data.h b/include/area_data.h
index 49f0a28..6ec803a 100644
--- a/include/area_data.h
+++ b/include/area_data.h
@@ -28,58 +28,248 @@
 #include <QElapsedTimer>
 
 class Logger;
+
+/**
+ * @brief Represents an area on the server, a distinct "room" for people to chat in.
+ */
 class AreaData : public QObject {
   Q_OBJECT
   public:
+    /**
+     * @brief Constructor for the AreaData class.
+     *
+     * @param p_name The name of the area. This must be in the format of `"X:YYYYYY"`, where `X` is an integer,
+     * and `YYYYYY` is the actual name of the area.
+     * @param p_index The index of the area in the area list.
+     */
     AreaData(QString p_name, int p_index);
 
+    /**
+     * @brief The data for evidence in the area.
+     */
     struct Evidence {
-        QString name;
-        QString description;
-        QString image;
+        QString name; //!< The name of the evidence, shown when hovered over clientside.
+        QString description; //!< The longer description of the evidence, when the user opens the evidence window.
+        QString image; //!< A path originating from `base/evidence/` that points to an image file.
     };
+
+    /**
+     * @brief The list of timers available in the area.
+     */
     QList<QTimer*> timers;
+
+    /**
+     * @brief The user-facing and internal name of the area.
+     */
     QString name;
+
+    /**
+     * @brief The index of the area in the server's area list.
+     */
     int index;
+
+    /**
+     * @brief A list of the character IDs of all characters taken.
+     */
     QList<int> characters_taken;
+
+    /**
+     * @brief A list of Evidence currently available in the area's court record.
+     *
+     * @details This contains *all* evidence, not just the ones a given side can see.
+     *
+     * @see HIDDEN_CM
+     */
     QList<Evidence> evidence;
+
+    /**
+     * @brief The amount of clients inside the area.
+     */
     int player_count;
+
+    /**
+     * @brief The status of an area.
+     *
+     * @details This is purely aesthetic, and serves no functional purpose from a gameplay perspective.
+     * It's only benefit is giving the users a rough idea as to what is going on in an area.
+     */
     enum Status {
-      IDLE,
-      RP,
-      CASING,
-      LOOKING_FOR_PLAYERS,
-      RECESS,
-      GAMING
+      IDLE, //!< The area is currently not busy with anything, or the area is empty.
+      RP, //!< There is some (non-Ace Attorney-related) roleplay going on in the area.
+      CASING, //!< An Ace Attorney or Danganronpa-styled case is currently being held in the area.
+      LOOKING_FOR_PLAYERS, //!< Something is being planned in the area, but it needs more players.
+      RECESS, //!< The area is currently taking a break from casing, but will continue later.
+      GAMING //!< The users inside the area are playing some game outside of AO, and are using the area to communicate.
     };
+
+    /// Exposes the metadata of the Status enum.
     Q_ENUM(Status);
+
+    /**
+     * @brief The status of the area.
+     *
+     * @see Status
+     */
     Status status;
+
+    /**
+     * @brief The IDs of all the owners (or Case Makers / CMs) of the area.
+     */
     QList<int> owners;
+
+    /**
+     * @brief The list of clients invited to the area.
+     *
+     * @see LOCKED and SPECTATABLE for the benefits of being invited.
+     */
     QList<int> invited;
+
+    /**
+     * @brief Determines who may traverse and communicate in the area.
+     */
     enum LockStatus {
       FREE,
       LOCKED,
       SPECTATABLE
     };
+
+    /**
+     * @var LockStatus FREE
+     * Anyone may enter the area, and there are no restrictions on communicating in-character.
+     */
+
+    /**
+     * @var LockStatus LOCKED
+     * Only invited clients may enter the area, but those who are invited are free to communicate in-character.
+     *
+     * When an area transitions from FREE to LOCKED, anyone present in the area
+     * at the time of the transition is considered invited.
+     */
+
+    /**
+     * @var LockStatus SPECTATABLE
+     * Anyone may enter the area, but only invited clients may communicate in-character.
+     *
+     * When an area transitions from FREE to SPECTATABLE, anyone present in the area
+     * at the time of the transition is considered invited.
+     */
+
+    /// Exposes the metadata of the LockStatus enum.
     Q_ENUM(LockStatus);
+
+    /**
+     * @brief The status of the area's accessibility to clients.
+     *
+     * @see LockStatus
+     */
     LockStatus locked;
+
+    /**
+     * @brief The background of the area.
+     *
+     * @details Represents a directory's name in `base/background/` clientside.
+     */
     QString background;
+
+    /**
+     * @brief If true, nobody may become the CM of this area.
+     */
     bool is_protected;
+
+    /**
+     * @brief If true, clients are allowed to put on "shownames", custom names
+     * in place of their character's normally displayed name.
+     */
     bool showname_allowed;
+
+    /**
+     * @brief If true, clients are allowed to use the cursed art of iniswapping in the area.
+     */
     bool iniswap_allowed;
+
+    /**
+     * @brief If true, the background of the area cannot be changed except by a moderator.
+     */
     bool bg_locked;
+
+    /**
+     * @brief The hyperlink to the document of the area.
+     *
+     * @details Documents are generally used for cases or roleplays, where they contain the related game's
+     * rules. #document can also be something like "None" if there is no case or roleplay being run.
+     */
     QString document;
+
+    /**
+     * @brief The Confidence Gauge's value for the Defence side.
+     *
+     * @details Unit is 10%, and the values range from 0 (= 0%) to 10 (= 100%).
+     */
     int def_hp;
+
+    /**
+     * @brief The Confidence Gauge's value for the Prosecutor side.
+     *
+     * @copydetails #def_hp
+     */
     int pro_hp;
+
+    /**
+     * @brief The title of the music currently being played in the area.
+     *
+     * @details Title is a path to the music file, with the starting point on
+     * `base/sounds/music/` clientside, with file extension.
+     */
     QString current_music;
+
+    /**
+     * @brief The name of the client (or client's character) that started the currently playing music.
+     */
     QString music_played_by;
+
+    /**
+     * @brief A pointer to a Logger, used to send requests to log data.
+     */
     Logger* logger;
+
+    /**
+     * @brief The level of "authorisation" needed to be able to modify, add, and remove evidence in the area.
+     */
     enum EvidenceMod{
         FFA,
         MOD,
         CM,
         HIDDEN_CM
     };
+
+    /**
+     * @var EvidenceMod FFA
+     * "Free-for-all" -- anyone can add, remove or modify evidence.
+     */
+
+    /**
+     * @var EvidenceMod MOD
+     * Only mods can add, remove or modify evidence.
+     */
+
+    /**
+     * @var EvidenceMod CM
+     * Only Case Makers and Mods can add, remove or modify evidence.
+     */
+
+    /**
+     * @var EvidenceMod HIDDEN_CM
+     * Only Case Makers and Mods can add, remove or modify evidence.
+     *
+     * CMs can also hide evidence from various sides by putting `<owner=XXX>` into the evidence's description,
+     * where `XXX` is either a position, of a list of positions separated by `,`.
+     */
+
+    /**
+     * @brief The evidence mod of the area.
+     *
+     * @see EvidenceMod
+     */
     EvidenceMod evi_mod;
 };
 
diff --git a/include/config_manager.h b/include/config_manager.h
index 4c1baa2..8c95af3 100644
--- a/include/config_manager.h
+++ b/include/config_manager.h
@@ -26,26 +26,72 @@
 #include <QFileInfo>
 #include <QSettings>
 
+/**
+ * @brief The config file handler class.
+ */
 class ConfigManager {
   public:
-    ConfigManager();
+    /**
+     * @brief An empty constructor for ConfigManager.
+     */
+    ConfigManager() {};
+
+    /**
+     * @brief Performs some preliminary checks for the various configuration files used by the server.
+     *
+     * @return True if the config file exists, is up-to-date, and valid, false otherwise.
+     */
     bool initConfig();
+
+    /**
+     * @brief Updates the config file's version to the one used by the server currently.
+     *
+     * @details The function can return false if the server's expected config version is 0
+     * (doesn't actually exist), or negative (nonsense).
+     * If the current config file lags more than one version behind the expected, all intermediate
+     * updates are also performed on the config file.
+     *
+     * @param current_version The current configuration version expected by the server.
+     *
+     * @return True if a version update took place, false otherwise.
+     */
     bool updateConfig(int current_version);
 
+    /**
+     * @brief The collection of server-specific settings.
+     */
     struct server_settings {
-        QString ms_ip;
-        int port;
-        int ws_port;
-        int ms_port;
-        QString name;
-        QString description;
-        bool advertise_server;
-        int zalgo_tolerance;
+        QString ms_ip; //!< The IP address of the master server to establish connection to.
+        int port; //!< The TCP port the server will accept client connections through.
+        int ws_port; //!< The WebSocket port the server will accept client connections through.
+        int ms_port; //!< The port of the master server to establish connection to.
+        QString name; //!< The name of the server as advertised on the server browser.
+        QString description; //!< The description of the server as advertised on the server browser.
+        bool advertise_server; //!< The server will only be announced to the master server (and thus appear on the master server list) if this is true.
+        int zalgo_tolerance; //!< The amount of subscripts zalgo is stripped by.
     };
 
+    /**
+     * @brief Loads the server settings into the given struct from the config file.
+     *
+     * @param[out] settings Pointer to a server_settings file to be filled with data.
+     *
+     * @return False if any of the ports (the master server connection port,
+     * the TCP port used by clients, or the WebSocket port used by WebAO) failed
+     * to be read in from the settings correctly, true otherwise.
+     *
+     * @pre initConfig() must have been run beforehand to check for the config file's existence.
+     */
     bool loadServerSettings(server_settings* settings);
 
   private:
+    /**
+     * @brief Convenience function to check if the object exists, and is a file.
+     *
+     * @param file The object to check.
+     *
+     * @return See brief description.
+     */
     bool fileExists(QFileInfo *file);
 };
 
diff --git a/include/db_manager.h b/include/db_manager.h
index 636f3f1..575df07 100644
--- a/include/db_manager.h
+++ b/include/db_manager.h
@@ -28,47 +28,236 @@
 #include <QSqlError>
 #include <QSqlQuery>
 
+/**
+ * @brief A class used to handle database interaction.
+ *
+ * @details This class offers a layer above the QSqlDatabase class to manage semi-critical data.
+ * Contrast with Logger, which dumbs its data into simple `.log` files.
+ *
+ * The DBManager handles user data, keeping track of only 'special' persons who are handled
+ * differently than the average user.
+ * This comes in two forms, when the user's client is banned, and when the user is a moderator.
+ */
 class DBManager{
 public:
+    /**
+     * @brief Constructor for the DBManager class.
+     *
+     * @details Creates a database file at `config/akashi.db`, and creates two tables in it:
+     * one for banned clients, and one for authorised users / moderators.
+     */
     DBManager();
+
+    /**
+      * @brief Destructor for the DBManager class. Closes the underlying database.
+      */
     ~DBManager();
 
+    /**
+     * @brief Checks if there is a record in the Bans table with the given IP address.
+     *
+     * @param ip The IP address to check if it is banned.
+     *
+     * @return True if the query could return at least one such record.
+     */
     bool isIPBanned(QHostAddress ip);
+
+    /**
+     * @brief Checks if there is a record in the Bans table with the given hardware ID.
+     *
+     * @param hdid The hardware ID to check if it is banned.
+     *
+     * @return True if the query could return at least one such record.
+     */
     bool isHDIDBanned(QString hdid);
 
+    /**
+     * @brief Returns the reason the given IP address was banned with.
+     *
+     * @param ip The IP address whose ban reason needs to be returned.
+     *
+     * @return The ban reason if the IP address is actually banned,
+     * or `"Ban reason not found."` if the IP address is not actually banned.
+     */
     QString getBanReason(QHostAddress ip);
+
+    /**
+     * @overload
+     */
     QString getBanReason(QString hdid);
-    long long getBanDuration(QString hdid);
+
+    /**
+     * @brief Returns the reason the given IP address was banned with.
+     *
+     * @param ip The IP address whose ban duration to get.
+     *
+     * @return The ban duration if the IP address is actually banned,
+     * or `-1` if the IP address is not actually banned.
+     */
     long long getBanDuration(QHostAddress ip);
-    int getBanID(QString hdid);
+
+    /**
+     * @overload
+     */
+    long long getBanDuration(QString hdid);
+
+    /**
+     * @brief Gets the ID number of a given ban.
+     *
+     * @param ip The IP address whose associated ban's ID we need.
+     *
+     * @return The ID of the ban if the IP address is actually banned,
+     * or `-1` if the IP address is not actually banned.
+     */
     int getBanID(QHostAddress ip);
 
+    /**
+     * @overload
+     */
+    int getBanID(QString hdid);
+
+    /**
+     * @brief Details about a ban.
+     */
     struct BanInfo {
-        QString ipid;
-        QHostAddress ip;
-        QString hdid;
-        unsigned long time;
-        QString reason;
-        long long duration;
+        QString ipid; //!< The banned user's IPID.
+        QHostAddress ip; //!< The banned user's IP.
+        QString hdid; //!< The banned user's hardware ID.
+        unsigned long time; //!< The time the ban was registered.
+        QString reason; //!< The reason given for the ban by the moderator who registered it.
+        long long duration; //!< The duration of the ban, in seconds.
     };
+
+    /**
+     * @brief Gets the last five bans made on the server.
+     *
+     * @return See brief description.
+     */
     QList<BanInfo> getRecentBans();
 
+    /**
+     * @brief Registers a ban into the database.
+     *
+     * @param ban The details of the ban.
+     */
     void addBan(BanInfo ban);
+
+    /**
+     * @brief Sets the duration of a given ban to 0, effectively removing the ban the associated user.
+     *
+     * @param id The ID of the ban to invalidate.
+     *
+     * @return False if no such ban exists, true if the invalidation was successful.
+     */
     bool invalidateBan(int id);
 
+    /**
+     * @brief Creates an authorised user.
+     *
+     * @param username The username clients can use to log in with.
+     * @param salt The salt to obfuscate the password with.
+     * @param password The user's password.
+     * @param acl The user's authority bitflag -- what special permissions does the user have.
+     *
+     * @return False if the user already exists, true if the user was successfully created.
+     *
+     * @see AOClient::cmdLogin() and AOClient::cmdLogout() for the username and password's contexts.
+     * @see AOClient::ACLFlags for the potential special permissions a user may have.
+     */
     bool createUser(QString username, QString salt, QString password, unsigned long long acl);
+
+    /**
+     * @brief Deletes an authorised user from the database.
+     *
+     * @param username The username whose associated user to delete.
+     *
+     * @return False if the user didn't even exist, true if the user was successfully deleted.
+     */
     bool deleteUser(QString username);
+
+    /**
+     * @brief Gets the permissions of a given user.
+     *
+     * @param moderator_name The authorised user's name.
+     *
+     * @return `0` if `moderator_name` is empty, `0` if such user does not exist in the Users table,
+     * or the primitive representation of an AOClient::ACLFlags permission matrix if neither of the above are true.
+     *
+     * @see AOClient::ACLFlags for the potential permissions a user may have.
+     */
     unsigned long long getACL(QString moderator_name);
+
+    /**
+     * @brief Authenticates a given user.
+     *
+     * @param username The username of the user trying to log in.
+     * @param password The password of the user.
+     *
+     * @return True if the salted version of the inputted password matches the one stored in the user's record,
+     * false if the user does not exist in the records, of if the passwords don't match.
+     */
     bool authenticate(QString username, QString password);
+
+    /**
+     * @brief Updates the permissions of a given user.
+     *
+     * @details This function can add or remove permissions as needed.
+     * `acl` determines what permissions are modified, while `mode` determines whether said permissions are
+     * added or removed.
+     *
+     * `acl` **is not** the user's current permissions *or* the sum permissions you want for the user at the end
+     * -- it is the 'difference' between the user's current and desired permissions.
+     *
+     * If `acl` is `"NONE"`, then no matter the mode, the user's permissions are cleared.
+     *
+     * For some practical examples, consult this example table:
+     *
+     * | Starting permissions |    `acl`    | `mode`  | Resulting permissions |
+     * | -------------------: | :---------: | :-----: | :-------------------- |
+     * | KICK                 | BAN         | `TRUE`  | KICK, BAN             |
+     * | BAN, KICK            | BAN         | `TRUE`  | KICK, BAN             |
+     * | KICK                 | BAN, BGLOCK | `TRUE`  | KICK, BAN, BGLOCK     |
+     * | BGLOCK, BAN, KICK    | NONE        | `TRUE`  | NONE                  |
+     * | KICK                 | BAN         | `FALSE` | KICK                  |
+     * | BAN, KICK            | BAN         | `FALSE` | KICK                  |
+     * | BGLOCK, BAN, KICK    | BAN, BGLOCK | `FALSE` | KICK                  |
+     * | BGLOCK, BAN, KICK    | NONE        | `FALSE` | NONE                  |
+     *
+     * @param username The username of the user whose permissions should be updated.
+     * @param acl The primitive representation of the permission matrix being modified.
+     * @param mode If true, the permissions described in `acl` are *added* to the user;
+     * if false, they are removed instead.
+     *
+     * @return True if the modification was successful, false if the user does not exist in the records.
+     */
     bool updateACL(QString username, unsigned long long acl, bool mode);
+
+    /**
+     * @brief Returns a list of the recorded users' usernames, ordered by ID.
+     *
+     * @return See brief description.
+     */
     QStringList getUsers();
 
 private:
+    /**
+     * @brief The name of the database connection driver.
+     */
     const QString DRIVER;
+
+    /**
+     * @note Unused.
+     */
     const QString CONN_NAME;
 
+    /**
+     * @note Unused.
+     */
     void openDB();
 
+    /**
+     * @brief The backing database that stores user details.
+     */
     QSqlDatabase db;
 };
 
diff --git a/include/logger.h b/include/logger.h
index fe21ff7..e73d77f 100644
--- a/include/logger.h
+++ b/include/logger.h
@@ -30,24 +30,113 @@
 
 class AOClient;
 class AreaData;
+
+/**
+ * @brief A class associated with an AreaData class to log various events happening inside the latter.
+ */
 class Logger
 {
 public:
-    Logger(int p_max_length, AreaData* p_area);
+    /**
+     * @brief Constructs a Logger instance.
+     *
+     * @param p_max_length The maximum amount of entries the Logger can store at once.
+     * @param p_area The area associated with the Logger from which it should log entries.
+     */
+    Logger(int p_max_length, AreaData* p_area) : max_length(p_max_length), area(p_area) {};
 
+    /**
+     * @brief Logs an IC message.
+     *
+     * @param client The client who sent the IC message.
+     * @param packet The IC packet itself, used to grab the text of the IC message.
+     */
     void logIC(AOClient* client, AOPacket* packet);
+
+    /**
+     * @brief Logs an OOC message.
+     *
+     * @param client The client who sent the OOC message.
+     * @param packet The OOC packet itself, used to grab the text of the OOC message.
+     */
     void logOOC(AOClient* client, AOPacket* packet);
+
+    /**
+     * @brief Logs a mod call message.
+     *
+     * @param client The client who sent the mod call.
+     * @param packet The ZZ packet itself, used to grab the reason field of the modcall.
+     */
     void logModcall(AOClient* client, AOPacket* packet);
+
+    /**
+     * @brief Logs a command called in OOC.
+     *
+     * @details If the command is not one of any of the 'special' ones, it defaults to logOOC().
+     * The only thing that makes a command 'special' if it is handled differently in here.
+     *
+     * @param client The client who sent the command.
+     * @param packet The OOC packet. Passed to logOOC() if the command is not 'special' (see details).
+     * @param cmd The command called in the OOC -- this is the first word after the `/` character.
+     * @param args The arguments interpreted for the command, every word separated by a whitespace.
+     */
     void logCmd(AOClient* client, AOPacket* packet, QString cmd, QStringList args);
+
+    /**
+     * @brief Logs a login attempt.
+     *
+     * @param client The client that attempted to login.
+     * @param success True if the client successfully authenticated as a mod.
+     * @param modname If the client logged in with a modname, then this is it. Otherwise, it's `"moderator"`.
+     *
+     * @note Why does this exist? logCmd() already does this in part.
+     */
     void logLogin(AOClient* client, bool success, QString modname);
+
+    /**
+     * @brief Appends the contents of #buffer into `config/server.log`, emptying the former.
+     */
     void flush();
 
 private:
+    /**
+     * @brief Convenience function to format entries to the acceptable standard for logging.
+     *
+     * @param client The client who 'caused' the source event for the entry to happen.
+     * @param type The type of entry that is being built, something that uniquely identifies entries of similar being.
+     * @param message Any additional information related to the entry.
+     *
+     * @return A formatted string representation of the entry.
+     */
     QString buildEntry(AOClient* client, QString type, QString message);
+
+    /**
+     * @brief Convenience function to add an entry to #buffer.
+     *
+     * @details If the buffer's size is equal to #max_length, the first entry in the queue is removed,
+     * and the newest entry is added to the end.
+     *
+     * @param entry The string representation of the entry to add.
+     *
+     * @pre You would probably call buildEntry() to format the entry before adding it to the buffer.
+     */
     void addEntry(QString entry);
 
+    /**
+     * @brief The max amount of entries that may be contained in #buffer.
+     */
     int max_length;
+
+    /**
+     * @brief Contains entries that have not yet been flushed out into a log file.
+     */
     QQueue<QString> buffer;
+
+    /**
+     * @brief A pointer to the area this logger is associated with.
+     *
+     * @details Used for logging in what area did a given packet event happen.
+     */
     AreaData* area;
 };
 
diff --git a/include/server.h b/include/server.h
index cac743e..96cba1a 100644
--- a/include/server.h
+++ b/include/server.h
@@ -38,47 +38,214 @@ class AOClient;
 class DBManager;
 class AreaData;
 
+/**
+ * @brief The class that represents the actual server as it is.
+ */
 class Server : public QObject {
     Q_OBJECT
 
   public:
+    /**
+     * @brief Creates a Server instance.
+     *
+     * @param p_port The TCP port to listen for connections on.
+     * @param p_ws_port The WebSocket port to listen for connections on.
+     * @param parent Qt-based parent, passed along to inherited constructor from QObject.
+     */
     Server(int p_port, int p_ws_port, QObject* parent = nullptr);
+
+    /**
+      * @brief Destructor for the Server class.
+      *
+      * @details Marks every Client, the WSProxy, the underlying #server, and the database manager to be deleted later.
+      */
     ~Server();
 
+    /**
+     * @brief Starts the server.
+     *
+     * @details Amongst other things, this function starts the listening on the given TCP port, sets up the server
+     * according to the configuration file, and starts listening on the WebSocket port if it is not `-1`.
+     *
+     * Advertising is not done here -- see Advertiser::contactMasterServer() for that.
+     */
     void start();
+
+    /**
+     * @brief Gets a pointer to a client by IPID.
+     *
+     * @param ipid The IPID to look for.
+     *
+     * @return A pointer to the client if found, a nullpointer if not.
+     *
+     * @see Server::getClientsByIpid() to get all clients ran by the same user.
+     */
+    AOClient* getClient(QString ipid);
+
+    /**
+     * @brief Gets a list of pointers to all clients with the given IPID.
+     *
+     * @param ipid The IPID to look for.
+     *
+     * @return A list of clients whose IPID match. List may be empty.
+     */
     QList<AOClient*> getClientsByIpid(QString ipid);
+    
+    /**
+     * @brief Gets a pointer to a client by user ID.
+     *
+     * @param id The user ID to look for.
+     *
+     * @return A pointer to the client if found, a nullpointer if not.
+     */
     AOClient* getClientByID(int id);
+
+    /**
+     * @brief Updates which characters are taken in the given area, and sends out an update packet to
+     * all clients present the area.
+     *
+     * @param area The area in which to update the list of characters.
+     */
     void updateCharsTaken(AreaData* area);
+
+    /**
+     * @brief Sends a packet to all clients in a given area.
+     *
+     * @param packet The packet to send to the clients.
+     * @param area_index The index of the area to look for clients in.
+     *
+     * @note Does nothing if an area by the given index does not exist.
+     */
     void broadcast(AOPacket packet, int area_index);
+
+    /**
+     * @brief Sends a packet to all clients in the server.
+     *
+     * @param packet The packet to send to the clients.
+     */
     void broadcast(AOPacket packet);
+
+    /**
+     * @brief Returns the server's name according to the configuration file.
+     *
+     * @return See brief description.
+     */
     QString getServerName();
+
+    /**
+     * @brief Returns some value regarding the @ref AOClient::diceThrower "dice thrower commands".
+     *
+     * @param value_type `max_value` for the maximum amount of faces a die may have,
+     * `max_dice` for the maximum amount of dice that may be thrown at once.
+     *
+     * @return The associated value if it is found in the configuration file under the "Dice" section,
+     * or `100` if not.
+     */
     int getDiceValue(QString value_type);
+
+    /**
+     * @brief Returns the character's character ID (= their index in the character list).
+     *
+     * @param char_name The 'internal' name for the character whose character ID to look up. This is equivalent to
+     * the name of the directory of the character.
+     *
+     * @return The character ID if a character with that name exists in the character selection list, `-1` if not.
+     */
     int getCharID(QString char_name);
 
+    /**
+     * @brief The collection of all currently connected clients.
+     */
     QVector<AOClient*> clients;
 
+    /**
+     * @brief The overall player count in the server.
+     */
     int player_count;
+
+    /**
+     * @brief The characters available on the server to use.
+     */
     QStringList characters;
+
+    /**
+     * @brief The areas on the server.
+     */
     QVector<AreaData*> areas;
+
+    /**
+     * @brief The names of the areas on the server.
+     *
+     * @details Equivalent to iterating over #areas and getting the area names individually, but grouped together
+     * here for faster access.
+     */
     QStringList area_names;
+
+    /**
+     * @brief The available songs on the server.
+     *
+     * @details Does **not** include the area names, the actual music list packet should be constructed from
+     * #area_names and this combined.
+     */
     QStringList music_list;
+
+    /**
+     * @brief The backgrounds on the server that may be used in areas.
+     */
     QStringList backgrounds;
+
+    /**
+     * @brief The database manager on the server, used to store users' bans and authorisation details.
+     */
     DBManager* db_manager;
+
+    /**
+     * @brief The user-facing server name.
+     *
+     * @note Unused. getServerName() serves its purpose instead.
+     */
     QString server_name;
+
+    /**
+     * @brief The Message Of The Day of the server, shown upon entry to the server and on request.
+     */
     QString MOTD;
 
+    /**
+     * @brief The server-wide global timer.
+     */
     QTimer* timer;
 
-  signals:
-
   public slots:
+    /**
+     * @brief Handles a new connection.
+     *
+     * @details The function creates an AOClient to represent the user, assigns a user ID to them, and
+     * checks if the client is banned.
+     */
     void clientConnected();
 
   private:
+    /**
+     * @brief The proxy used for WebSocket connections.
+     *
+     * @see WSProxy and WSClient for an explanation as to why this is a thing.
+     */
     WSProxy* proxy;
+
+    /**
+     * @brief Listens for incoming TCP connections.
+     */
     QTcpServer* server;
 
+    /**
+     * @brief The port through which the server will accept TCP connections.
+     */
     int port;
+
+    /**
+     * @brief The port through which the server will accept WebSocket connections.
+     */
     int ws_port;
 };
 
diff --git a/include/ws_client.h b/include/ws_client.h
index 7c824bc..f5b1d96 100644
--- a/include/ws_client.h
+++ b/include/ws_client.h
@@ -23,21 +23,86 @@
 #include <QTcpSocket>
 #include <QString>
 
+/**
+ * @brief Represents a WebSocket client (generally WebAO) connected to the server.
+ *
+ * @details To give a common interface to both desktop AO and WebAO clients, the incoming data from
+ * WebSocket connections are directed through local TCP sockets.
+ *
+ * This class is a very thin layer -- see WSProxy for the actual mechanics of this WebSocket-to-TCP proxy solution.
+ */
 class WSClient : public QObject {
     Q_OBJECT
 public:
-    WSClient(QTcpSocket* p_tcp_socket, QWebSocket* p_web_socket, QObject* parent = nullptr);
+    /**
+     * @brief Creates an instance of the WSClient class.
+     *
+     * @param p_tcp_socket The locally created TCP socket to direct data through.
+     * @param p_web_socket The WebSocket that actually represents the connecting client.
+     * @param parent Qt-based parent, passed along to inherited constructor from QObject.
+     *
+     * @pre This class will not connect up the ports to each other in any way. Unless some setup is done, this class
+     * by default will never be prompted to read and/or write from/to either of the sockets.
+     */
+    WSClient(QTcpSocket* p_tcp_socket, QWebSocket* p_web_socket, QObject* parent = nullptr)
+        : QObject(parent), tcp_socket(p_tcp_socket), web_socket(p_web_socket) {};
+
+    /**
+      * @brief Destructor for the WSClient class.
+      *
+      * @details Marks the TCP and WebSocket for later deletion.
+      */
     ~WSClient();
 public slots:
+    /**
+     * @brief A slot that can be signalled when #tcp_socket has data ready for reading.
+     * Will read all data in the socket.
+     *
+     * @details The incoming data is separated per-packet due to the WebAO bug, and the packets are sent
+     * through #web_socket.
+     */
     void onTcpData();
+
+    /**
+     * @brief A slot that can be signalled to push packets received from WebSocket into the
+     * associated local TCP socket.
+     *
+     * @param message The incoming packet.
+     */
     void onWsData(QString message);
+
+    /**
+     * @brief A slot that can be signalled when the WebSocket client disconnect.
+     * Disconnects the associated TCP socket.
+     *
+     * @see onTcpDisconnect() for the opposite scenario.
+     */
     void onWsDisconnect();
+
+    /**
+     * @brief A slot that can be signalled when the TCP socket is disconnected.
+     * Severs the connection to the WebSocket.
+     *
+     * @see onWsDisconnect() for the opposite scenario.
+     */
     void onTcpDisconnect();
+
+    /**
+     * @brief A slot that can be signalled when the TCP socket is connected.
+     * Sends identification over the socket.
+     */
     void onTcpConnect();
 
 
 private:
+    /**
+     * @brief The local TCP socket used as a proxy to connect with the server.
+     */
     QTcpSocket* tcp_socket;
+
+    /**
+     * @brief The WebSocket representing an incoming connection.
+     */
     QWebSocket* web_socket;
 };
 
diff --git a/include/ws_proxy.h b/include/ws_proxy.h
index 440d453..d83bed3 100644
--- a/include/ws_proxy.h
+++ b/include/ws_proxy.h
@@ -25,21 +25,66 @@
 #include <QtWebSockets/QtWebSockets>
 #include <QHostAddress>
 
+/**
+ * @brief Handles WebSocket connections by redirecting data sent through them through a local TCP connection
+ * for common handling.
+ */
 class WSProxy : public QObject {
     Q_OBJECT
   public:
+    /**
+     * @brief Creates a WSProxy instance.
+     *
+     * @param p_local_port The port through which the TCP connection should be directed. Should the same as with
+     * non-WebAO connections.
+     * @param p_ws_port The WebSocket port. Should the same that is opened for WebSockets connections.
+     * @param parent Qt-based parent, passed along to inherited constructor from QObject.
+     */
     WSProxy(int p_local_port, int p_ws_port, QObject* parent);
+
+    /**
+      * @brief Destructor for the WSProxy class.
+      *
+      * @details Marks the WebSocket server that is used to handle the proxy process to be deleted later.
+      */
     ~WSProxy();
 
+    /**
+     * @brief Starts listening for WebSocket connections on the given port.
+     */
     void start();
+
 public slots:
+    /**
+     * @brief Sets up the proxy process to the newly connected WebSocket.
+     *
+     * @details This function creates a TCP socket to establish the proxy, creates a WSClient to represent the client connecting through WebSocket.
+     */
     void wsConnected();
 
   private:
+    /**
+     * @brief The WebSocket server listening to incoming WebSocket connections.
+     */
     QWebSocketServer* server;
+
+    /**
+     * @brief Every client connected through WebSocket.
+     */
     QVector<WSClient*> clients;
 
+    /**
+     * @brief The TCP port that the WebSocket connections will be redirected through.
+     *
+     * @note Should be the same that desktop clients connect through, and that was announced to the master server.
+     */
     int local_port;
+
+    /**
+     * @brief The port for incoming WebSocket connections.
+     *
+     * @note Should be the same that was announced to the master server.
+     */
     int ws_port;
 };
 
diff --git a/src/advertiser.cpp b/src/advertiser.cpp
index a45c33d..5921b53 100644
--- a/src/advertiser.cpp
+++ b/src/advertiser.cpp
@@ -17,19 +17,6 @@
 //////////////////////////////////////////////////////////////////////////////////////
 #include "include/advertiser.h"
 
-Advertiser::Advertiser(QString p_ip, int p_port, int p_ws_port,
-                       int p_local_port, QString p_name, QString p_description,
-                       QObject* parent)
-    : QObject(parent)
-{
-    ip = p_ip;
-    port = p_port;
-    ws_port = p_ws_port;
-    local_port = p_local_port;
-    name = p_name;
-    description = p_description;
-}
-
 void Advertiser::contactMasterServer()
 {
     socket = new QTcpSocket(this);
diff --git a/src/aoclient.cpp b/src/aoclient.cpp
index 10521af..b9207bc 100644
--- a/src/aoclient.cpp
+++ b/src/aoclient.cpp
@@ -17,23 +17,6 @@
 //////////////////////////////////////////////////////////////////////////////////////
 #include "include/aoclient.h"
 
-AOClient::AOClient(Server* p_server, QTcpSocket* p_socket, QObject* parent, int user_id)
-    : QObject(parent)
-{
-    socket = p_socket;
-    server = p_server;
-    id = user_id;
-    joined = false;
-    password = "";
-    current_area = 0;
-    current_char = "";
-    remote_ip = p_socket->peerAddress();
-    calculateIpid();
-    is_partial = false;
-    last_wtce_time = 0;
-    last_message = "";
-}
-
 void AOClient::clientData()
 {
     QString data = QString::fromUtf8(socket->readAll());
diff --git a/src/area_data.cpp b/src/area_data.cpp
index b03500d..f30b36d 100644
--- a/src/area_data.cpp
+++ b/src/area_data.cpp
@@ -17,12 +17,18 @@
 //////////////////////////////////////////////////////////////////////////////////////
 #include "include/area_data.h"
 
-AreaData::AreaData(QString p_name, int p_index)
+AreaData::AreaData(QString p_name, int p_index) :
+    index(p_index),
+    player_count(0),
+    status(IDLE),
+    locked(FREE),
+    document("No document."),
+    def_hp(10),
+    pro_hp(10)
 {
     QStringList name_split = p_name.split(":");
     name_split.removeFirst();
     name = name_split.join(":");
-    index = p_index;
     QSettings areas_ini("config/areas.ini", QSettings::IniFormat);
     areas_ini.beginGroup(p_name);
     background = areas_ini.value("background", "gs4").toString();
@@ -31,12 +37,6 @@ AreaData::AreaData(QString p_name, int p_index)
     bg_locked = areas_ini.value("bg_locked", "false").toBool();
     QString configured_evi_mod = areas_ini.value("evidence_mod", "FFA").toString().toLower();
     areas_ini.endGroup();
-    player_count = 0;
-    locked = FREE;
-    status = IDLE;
-    def_hp = 10;
-    pro_hp = 10;
-    document = "No document.";
     QSettings config_ini("config/config.ini", QSettings::IniFormat);
     config_ini.beginGroup("Options");
     int log_size = config_ini.value("logbuffer", 50).toInt();
diff --git a/src/config_manager.cpp b/src/config_manager.cpp
index 7364d9d..69de3cf 100644
--- a/src/config_manager.cpp
+++ b/src/config_manager.cpp
@@ -17,8 +17,6 @@
 //////////////////////////////////////////////////////////////////////////////////////
 #include "include/config_manager.h"
 
-ConfigManager::ConfigManager() { }
-
 // Validate and set up the config
 bool ConfigManager::initConfig()
 {
@@ -145,7 +143,7 @@ bool ConfigManager::loadServerSettings(server_settings* settings)
     settings->description =
         config.value("server_description", "This is my flashy new server")
             .toString();
-    settings->zalgo_tolerance = 
+    settings->zalgo_tolerance =
         config.value("zalgo_tolerance", "3").toInt(&zalgo_tolerance_conversion_success);
     config.endGroup();
     if (!port_conversion_success || !ws_port_conversion_success ||
diff --git a/src/logger.cpp b/src/logger.cpp
index 9e33240..0b5f333 100644
--- a/src/logger.cpp
+++ b/src/logger.cpp
@@ -17,12 +17,6 @@
 //////////////////////////////////////////////////////////////////////////////////////
 #include "include/logger.h"
 
-Logger::Logger(int p_max_length, AreaData* p_area)
-{
-    area = p_area;
-    max_length = p_max_length;
-}
-
 void Logger::logIC(AOClient *client, AOPacket *packet)
 {
     QString message = packet->contents[4];
diff --git a/src/server.cpp b/src/server.cpp
index 17c6efc..148dce2 100644
--- a/src/server.cpp
+++ b/src/server.cpp
@@ -17,17 +17,17 @@
 //////////////////////////////////////////////////////////////////////////////////////
 #include "include/server.h"
 
-Server::Server(int p_port, int p_ws_port, QObject* parent) : QObject(parent)
+Server::Server(int p_port, int p_ws_port, QObject* parent) :
+    QObject(parent),
+    player_count(0),
+    port(p_port),
+    ws_port(p_ws_port)
 {
     server = new QTcpServer(this);
     connect(server, SIGNAL(newConnection()), this, SLOT(clientConnected()));
 
-    port = p_port;
-    ws_port = p_ws_port;
     timer = new QTimer();
 
-    player_count = 0;
-
     db_manager = new DBManager();
 }
 
diff --git a/src/ws_client.cpp b/src/ws_client.cpp
index 7865fb0..e74c65a 100644
--- a/src/ws_client.cpp
+++ b/src/ws_client.cpp
@@ -17,13 +17,6 @@
 //////////////////////////////////////////////////////////////////////////////////////
 #include "include/ws_client.h"
 
-WSClient::WSClient(QTcpSocket* p_tcp_socket, QWebSocket* p_web_socket, QObject* parent)
-    : QObject(parent)
-{
-    tcp_socket = p_tcp_socket;
-    web_socket = p_web_socket;
-}
-
 void WSClient::onWsData(QString message)
 {
     tcp_socket->write(message.toUtf8());
diff --git a/src/ws_proxy.cpp b/src/ws_proxy.cpp
index 619b434..0dd412f 100644
--- a/src/ws_proxy.cpp
+++ b/src/ws_proxy.cpp
@@ -17,10 +17,11 @@
 //////////////////////////////////////////////////////////////////////////////////////
 #include "include/ws_proxy.h"
 
-WSProxy::WSProxy(int p_local_port, int p_ws_port, QObject* parent) : QObject(parent)
+WSProxy::WSProxy(int p_local_port, int p_ws_port, QObject* parent) :
+    QObject(parent),
+    local_port(p_local_port),
+    ws_port(p_ws_port)
 {
-    local_port = p_local_port;
-    ws_port = p_ws_port;
     server = new QWebSocketServer(QStringLiteral(""),
                                   QWebSocketServer::NonSecureMode, this);
     connect(server, &QWebSocketServer::newConnection, this,