diff --git a/.gitignore b/.gitignore index 67a4fd6dac..dc7d8e58e8 100644 --- a/.gitignore +++ b/.gitignore @@ -48,6 +48,7 @@ build.ninja # Build directories /build* +/doxygen .flatpak-builder # Nix build artifacts diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 27e7117bc1..51a3aed0f8 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,6 +8,15 @@ build: os: ubuntu-22.04 tools: python: "3.10" + apt_packages: + - graphviz + jobs: + pre_build: + # Creates the documentation in the doxygen/ subfolder + - doxygen + post_build: + # Move the output to be hosted + - mv doxygen/html $READTHEDOCS_OUTPUT/html/Doxygen # Build documentation in the docs/ directory with Sphinx sphinx: diff --git a/doc/freeciv.doxygen b/Doxyfile similarity index 65% rename from doc/freeciv.doxygen rename to Doxyfile index e6a01464ce..c3f96a2480 100644 --- a/doc/freeciv.doxygen +++ b/Doxyfile @@ -1,4 +1,4 @@ -# Doxyfile 1.8.8 +# Doxyfile 1.9.8 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -12,16 +12,26 @@ # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all text -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv -# for the list of possible encodings. +# This tag specifies the encoding used for all characters in the 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 @@ -32,7 +42,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = Freeciv +PROJECT_NAME = Freeciv21 # 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 @@ -44,32 +54,44 @@ PROJECT_NUMBER = # 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 = +PROJECT_BRIEF = Develop your civilization from humble roots to a global empire -# With the PROJECT_LOGO tag one can specify an logo or icon that is included in -# the documentation. The maximum height of the logo should not exceed 55 pixels -# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo -# to the output directory. +# 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 = +PROJECT_LOGO = data/icons/64x64/freeciv21-client.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 = doc/doxygen +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 +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 +# sub-directories (in 2 levels) under the output directory of each output format +# and will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes -# performance problems for the file system. +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. # The default value is: NO. CREATE_SUBDIRS = NO +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode @@ -81,26 +103,26 @@ 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. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English -# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# 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 +# 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 @@ -135,7 +157,7 @@ ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# 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. @@ -179,6 +201,16 @@ SHORT_NAMES = NO JAVADOC_AUTOBRIEF = YES +# 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 @@ -199,15 +231,23 @@ QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. INHERIT_DOCS = YES -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a -# new page for each member. If set to NO, the documentation of a member will be -# part of the file/class/namespace that contains it. +# 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 @@ -222,20 +262,19 @@ TAB_SIZE = 8 # the documentation. An alias has the form: # name=value # For example adding -# "sideeffect=@par Side Effects:\n" +# "sideeffect=@par Side Effects:^^" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines. +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) ALIASES = -# 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 @@ -264,28 +303,40 @@ OPTIMIZE_FOR_FORTRAN = 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, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: -# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: -# Fortran. In the later case the parser tries to guess whether the code is fixed -# or free formatted code, this is the default for Fortran type files), VHDL. For -# instance to make doxygen treat .inc files as Fortran files (default is PHP), -# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. # -# Note For files without extension you can use no_extension as a placeholder. +# Note: 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. +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable -# documentation. See http://daringfireball.net/projects/markdown/ for details. +# 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. @@ -293,10 +344,30 @@ EXTENSION_MAPPING = MARKDOWN_SUPPORT = YES +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to +# generate identifiers for the Markdown headings. Note: Every identifier is +# unique. +# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a +# sequence number starting at 0 and GITHUB use the lower case version of title +# with any whitespace replaced by '-' and punctuation characters removed. +# The default value is: DOXYGEN. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_ID_STYLE = DOXYGEN + # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by by putting a % sign in front of the word -# or globally by setting AUTOLINK_SUPPORT to NO. +# 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 @@ -318,7 +389,7 @@ BUILTIN_STL_SUPPORT = YES CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# 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. @@ -336,13 +407,20 @@ SIP_SUPPORT = NO 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 +# 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 @@ -397,11 +475,32 @@ TYPEDEF_HIDES_STRUCT = NO LOOKUP_CACHE_SIZE = 0 +# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +# If the TIMESTAMP tag is set different from NO then each generated page will +# contain the date or date and time when the page was generated. Setting this to +# NO can help when comparing the output of multiple runs. +# Possible values are: YES, NO, DATETIME and DATE. +# The default value is: NO. + +TIMESTAMP = YES + #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# 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. @@ -411,35 +510,41 @@ LOOKUP_CACHE_SIZE = 0 EXTRACT_ALL = YES -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# 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_PACKAGE tag is set to YES all members with package or internal +# 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 +# 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 +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES -# This flag is only useful for Objective-C code. When set to YES local methods, +# 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 in the documentation. If set to NO, only methods in the interface are # included. # The default value is: NO. @@ -454,6 +559,13 @@ EXTRACT_LOCAL_METHODS = NO EXTRACT_ANON_NSPACES = NO +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation @@ -464,21 +576,22 @@ 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. +# to NO, these classes will be included in the various overviews. This option +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO these declarations will be -# included in the documentation. +# 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 +# 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. @@ -491,22 +604,43 @@ HIDE_IN_BODY_DOCS = 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 -# and Mac users are advised to set this option to NO. -# The default value is: system dependent. +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. CASE_SENSE_NAMES = 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 +# their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. @@ -534,14 +668,14 @@ 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. +# 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 +# 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. @@ -586,27 +720,25 @@ SORT_BY_SCOPE_NAME = NO STRICT_PROTO_MATCHING = NO -# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the -# todo list. This list is created by putting \todo commands in the -# documentation. +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. # The default value is: YES. GENERATE_TODOLIST = YES -# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the -# test list. This list is created by putting \test commands in the -# documentation. +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. # The default value is: YES. GENERATE_TESTLIST = YES -# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# 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 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. @@ -631,8 +763,8 @@ ENABLED_SECTIONS = 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 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 = NO @@ -666,7 +798,8 @@ FILE_VERSION_FILTER = # 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. +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE @@ -677,7 +810,7 @@ LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# 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. @@ -696,7 +829,7 @@ CITE_BIB_FILES = QUIET = YES # 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 +# 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. @@ -704,7 +837,7 @@ QUIET = YES WARNINGS = YES -# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# 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. @@ -712,34 +845,81 @@ WARNINGS = 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. +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return -# value. If set to NO doxygen will only warn about wrong or incomplete parameter -# documentation, but not about the absence of documentation. +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC # The default value is: NO. WARN_NO_PARAMDOC = NO +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about +# undocumented enumeration values. If set to NO, doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not +# write the warning messages in between other messages but write them at the end +# of a run, in case a WARN_LOGFILE is defined the warning messages will be +# besides being in the defined file also be shown at the end of a run, unless +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case +# the behavior will remain as with the setting FAIL_ON_WARNINGS. +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. +# The default value is: NO. + +WARN_AS_ERROR = NO + # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard -# error (stderr). +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). WARN_LOGFILE = @@ -750,33 +930,53 @@ WARN_LOGFILE = # 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. +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. INPUT = $(doxy_srcdir)utility \ $(doxy_srcdir)common \ $(doxy_srcdir)server \ $(doxy_srcdir)client \ - $(doxy_srcdir)ai \ + $(doxy_srcdir)ai \ $(doxy_srcdir)tools # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: http://www.gnu.org/software/libiconv) for the list of -# possible encodings. +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING # The default value is: UTF-8. INPUT_ENCODING = UTF-8 +# This tag can be used to specify the character encoding of the source files +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding +# "INPUT_ENCODING" for further information on supported encodings. + +INPUT_FILE_ENCODING = + # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank the -# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, -# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, -# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, -# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, -# *.qsf, *.as and *.js. +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, +# *.cpp, *.cppm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, +# *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, *.php, +# *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be +# provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. FILE_PATTERNS = @@ -815,10 +1015,7 @@ EXCLUDE_PATTERNS = # (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/* +# ANamespace::AClass, ANamespace::*Test EXCLUDE_SYMBOLS = @@ -862,6 +1059,15 @@ IMAGE_PATH = # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. +# +# Note that doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. INPUT_FILTER = @@ -871,11 +1077,15 @@ INPUT_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 +# 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. @@ -896,6 +1106,15 @@ FILTER_SOURCE_PATTERNS = USE_MDFILE_AS_MAINPAGE = +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- @@ -923,7 +1142,7 @@ INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# function all documented functions referencing it will be listed. +# entity all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = YES @@ -935,7 +1154,7 @@ REFERENCED_BY_RELATION = YES 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 +# 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. @@ -955,12 +1174,12 @@ SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system -# (see http://www.gnu.org/software/global/global.html). You will need version +# (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 config file +# - 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 # @@ -982,17 +1201,25 @@ USE_HTAGS = NO 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. +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced +# performance. This can be particularly helpful with template rich C++ code for +# which doxygen's built-in parser lacks the necessary type information. # Note: The availability of this option depends on whether or not doxygen was -# compiled with the --with-libclang option. +# generated with the -Duse_libclang=ON option for CMake. # The default value is: NO. CLANG_ASSISTED_PARSING = NO +# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS +# tag is set to YES then doxygen will add the directory of each input to the +# include path. +# The default value is: YES. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_ADD_INC_PATHS = YES + # If clang assisted parsing is enabled you can provide the compiler with command # line options that you would normally use when invoking the compiler. Note that # the include paths will already be set by doxygen for the files and directories @@ -1001,6 +1228,19 @@ CLANG_ASSISTED_PARSING = NO CLANG_OPTIONS = +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the directory containing a file called compile_commands.json. This +# file is the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the +# options used when the source files were built. This is equivalent to +# specifying the -p option to a clang tool, such as clang-check. These options +# will then be passed to the parser. Any options specified with CLANG_OPTIONS +# will be added as well. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- @@ -1012,17 +1252,11 @@ CLANG_OPTIONS = 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. +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = @@ -1031,7 +1265,7 @@ IGNORE_PREFIX = # Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES @@ -1097,11 +1331,16 @@ HTML_STYLESHEET = # 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 therefor more robust against future updates. +# 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 stylesheet files is of importance (e.g. the last -# stylesheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = @@ -1116,10 +1355,23 @@ HTML_EXTRA_STYLESHEET = HTML_EXTRA_FILES = +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generate light mode output, DARK always +# generate dark mode output, AUTO_LIGHT automatically set the mode according to +# the user preference, use light mode if no preference is set (the default), +# AUTO_DARK automatically set the mode according to the user preference, use +# dark mode if no preference is set and TOGGLE allow to user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the stylesheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. @@ -1128,7 +1380,7 @@ HTML_EXTRA_FILES = HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A +# in the HTML output. For a value of 0 the output will use gray-scales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1146,13 +1398,16 @@ HTML_COLORSTYLE_SAT = 100 HTML_COLORSTYLE_GAMMA = 80 -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to NO can help when comparing the output of multiple runs. +# If the HTML_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_TIMESTAMP = 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 @@ -1162,6 +1417,13 @@ HTML_TIMESTAMP = YES HTML_DYNAMIC_SECTIONS = YES +# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be +# dynamically folded and expanded in the generated HTML source code. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_CODE_FOLDING = YES + # 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 @@ -1177,13 +1439,14 @@ HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: http://developer.apple.com/tools/xcode/), introduced with -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a -# Makefile in the HTML output directory. Running make will produce the docset in -# that directory and running make install will install the docset in +# 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 http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. +# 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. @@ -1197,6 +1460,13 @@ GENERATE_DOCSET = NO DOCSET_FEEDNAME = "Doxygen generated docs" +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. @@ -1222,8 +1492,12 @@ 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: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML @@ -1245,28 +1519,28 @@ GENERATE_HTMLHELP = NO 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 +# 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 GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# 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 +# 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. @@ -1280,6 +1554,16 @@ BINARY_TOC = NO TOC_EXPAND = NO +# The SITEMAP_URL tag is used to specify the full URL of the place where the +# generated documentation will be placed on the server by the user during the +# deployment of the documentation. The generated sitemap is called sitemap.xml +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL +# is specified no sitemap is generated. For information about the sitemap +# protocol see https://www.sitemaps.org +# This tag requires that the tag GENERATE_HTML is set to YES. + +SITEMAP_URL = + # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help @@ -1298,7 +1582,8 @@ QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# (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. @@ -1306,8 +1591,8 @@ QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- -# folders). +# 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. @@ -1315,30 +1600,30 @@ 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: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). +# 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: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). +# 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: -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# 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. +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = @@ -1361,7 +1646,7 @@ GENERATE_ECLIPSEHELP = NO # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. -ECLIPSE_DOC_ID = org.freeciv +ECLIPSE_DOC_ID = net.longturn # 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 @@ -1380,16 +1665,28 @@ DISABLE_INDEX = NO # 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 stylesheets (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. +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -GENERATE_TREEVIEW = NO +GENERATE_TREEVIEW = YES + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. @@ -1408,13 +1705,31 @@ ENUM_VALUES_PER_LINE = 4 TREEVIEW_WIDTH = 250 -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = svg + # 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 @@ -1424,20 +1739,15 @@ EXT_LINKS_IN_WINDOW = NO FORMULA_FONTSIZE = 10 -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to 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_TRANSPARENT = YES +FORMULA_MACROFILE = # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# http://www.mathjax.org) which uses client side Javascript for the rendering -# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# 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. @@ -1446,11 +1756,29 @@ FORMULA_TRANSPARENT = YES USE_MATHJAX = NO +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + # When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). # Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. @@ -1463,22 +1791,29 @@ MATHJAX_FORMAT = HTML-CSS # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of -# MathJax from http://www.mathjax.org before deployment. -# The default value is: http://cdn.mathjax.org/mathjax/latest. +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. @@ -1506,7 +1841,7 @@ MATHJAX_CODEFILE = 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 +# 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 @@ -1523,9 +1858,10 @@ SERVER_BASED_SEARCH = NO # 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 +# Doxygen ships with an example indexer (doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: http://xapian.org/). +# Xapian (see: +# https://xapian.org/). # # See the section "External Indexing and Searching" for details. # The default value is: NO. @@ -1536,10 +1872,11 @@ 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 +# Doxygen ships with an example indexer (doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: http://xapian.org/). See the section "External Indexing and -# Searching" for details. +# 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 = @@ -1574,7 +1911,7 @@ EXTRA_SEARCH_MAPPINGS = # Configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. +# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. # The default value is: YES. GENERATE_LATEX = NO @@ -1590,22 +1927,36 @@ LATEX_OUTPUT = latex # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. # -# Note that when enabling USE_PDFLATEX this option is only used for generating -# bitmaps for formulas in the HTML output, but not in the Makefile that is -# written to the output directory. -# The default file is: latex. +# 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 = latex # 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 -# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX +# 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. @@ -1620,44 +1971,60 @@ COMPACT_LATEX = NO # The default value is: a4. # This tag requires that the tag GENERATE_LATEX is set to YES. -PAPER_TYPE = a4wide +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. To get the times font for -# instance you can specify -# EXTRA_PACKAGES=times +# 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. +# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for +# the generated LaTeX document. The header should contain everything until the +# first chapter. If it is left blank doxygen will generate a standard header. It +# is highly recommended to start with a default header using +# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty +# and then modify the file new_header.tex. See also section "Doxygen usage" for +# information on how to generate the default header that doxygen normally uses. # -# Note: Only use a user-defined header if you know what you are doing! The -# following commands have a special meaning inside the header: $title, -# $datetime, $date, $doxygenversion, $projectname, $projectnumber, -# $projectbrief, $projectlogo. Doxygen will replace $title with the empy string, -# for the replacement values of the other commands the user is refered to -# HTML_HEADER. +# Note: Only use a user-defined header if you know what you are doing! +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. The following +# commands have a special meaning inside the header (and footer): For a +# description of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_HEADER = -# The LATEX_FOOTER tag can be used to specify a 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 +# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for +# the generated LaTeX document. The footer should contain everything after the +# last chapter. If it is left blank doxygen will generate a standard footer. See # LATEX_HEADER for more information on how to generate a default footer and what -# special commands can be used inside the footer. -# -# Note: Only use a user-defined footer if you know what you are doing! +# special commands can be used inside the footer. See also section "Doxygen +# usage" for information on how to generate the default footer that doxygen +# normally uses. Note: Only use a user-defined footer if you know what you are +# doing! # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_FOOTER = +# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# LaTeX style sheets that are included after the standard style sheets created +# by doxygen. Using this option one can overrule certain style aspects. Doxygen +# will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EXTRA_STYLESHEET = + # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the LATEX_OUTPUT output # directory. Note that the files will be copied as-is; there are no commands or @@ -1675,18 +2042,26 @@ LATEX_EXTRA_FILES = 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. +# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as +# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX +# files. Set this option to YES, to get a higher quality PDF documentation. +# +# See also section LATEX_CMD_NAME for selecting the engine. # The default value is: YES. # This tag requires that the tag GENERATE_LATEX is set to YES. USE_PDFLATEX = YES -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode -# command to the generated LaTeX files. This will instruct LaTeX to keep running -# if errors occur, instead of asking the user for help. This option is also used -# when generating formulas in HTML. +# The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error. +# Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch +# mode nothing is printed on the terminal, errors are scrolled as if is +# hit at every error; missing files that TeX tries to input or request from +# keyboard input (\read on a not open input stream) cause the job to abort, +# NON_STOP In nonstop mode the diagnostic message will appear on the terminal, +# but there is no possibility of user interaction just like in batch mode, +# SCROLL In scroll mode, TeX will stop only for missing files to input or if +# keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at +# each error, asking for user intervention. # The default value is: NO. # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -1699,29 +2074,27 @@ LATEX_BATCHMODE = NO 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 -# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. +# https://en.wikipedia.org/wiki/BibTeX and \cite for more info. # The default value is: plain. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_BIB_STYLE = plain +# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) +# path from which the emoji images will be read. If a relative path is entered, +# it will be relative to the LATEX_OUTPUT directory. If left blank the +# LATEX_OUTPUT directory will be used. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EMOJI_DIRECTORY = + #--------------------------------------------------------------------------- # Configuration options related to the RTF output #--------------------------------------------------------------------------- -# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The +# 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. @@ -1736,7 +2109,7 @@ GENERATE_RTF = NO RTF_OUTPUT = rtf -# If the COMPACT_RTF tag is set to YES doxygen generates more compact 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. @@ -1756,9 +2129,9 @@ COMPACT_RTF = NO RTF_HYPERLINKS = NO -# Load stylesheet definitions from file. Syntax is similar to doxygen's config -# file, i.e. a series of assignments. You only have to provide replacements, -# missing definitions are set to their default value. +# 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. @@ -1767,8 +2140,8 @@ RTF_HYPERLINKS = NO RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an RTF document. Syntax is -# similar to doxygen's config file. A template extensions file can be generated -# using doxygen -e rtf extensionFile. +# 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 = @@ -1777,7 +2150,7 @@ RTF_EXTENSIONS_FILE = # Configuration options related to the man page output #--------------------------------------------------------------------------- -# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for +# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for # classes and files. # The default value is: NO. @@ -1821,7 +2194,7 @@ 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 +# 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. @@ -1835,7 +2208,7 @@ GENERATE_XML = NO XML_OUTPUT = xml -# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program +# 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. @@ -1844,11 +2217,18 @@ XML_OUTPUT = xml 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 +# 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. @@ -1862,32 +2242,49 @@ GENERATE_DOCBOOK = NO 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. +#--------------------------------------------------------------------------- +# Configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an +# AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures +# the structure of the code including all documentation. Note that this feature +# is still experimental and incomplete at the moment. # The default value is: NO. -# This tag requires that the tag GENERATE_DOCBOOK is set to YES. -DOCBOOK_PROGRAMLISTING = NO +GENERATE_AUTOGEN_DEF = NO #--------------------------------------------------------------------------- -# Configuration options for the AutoGen Definitions output +# Configuration options related to Sqlite3 output #--------------------------------------------------------------------------- -# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen -# Definitions (see http://autogen.sf.net) file that captures the structure of -# the code including all documentation. Note that this feature is still -# experimental and incomplete at the moment. +# If the GENERATE_SQLITE3 tag is set to YES doxygen will generate a Sqlite3 +# database with symbols found by doxygen stored in tables. # The default value is: NO. -GENERATE_AUTOGEN_DEF = NO +GENERATE_SQLITE3 = NO + +# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be +# put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put +# in front of it. +# The default directory is: sqlite3. +# This tag requires that the tag GENERATE_SQLITE3 is set to YES. + +SQLITE3_OUTPUT = sqlite3 + +# The SQLITE3_OVERWRITE_DB tag is set to YES, the existing doxygen_sqlite3.db +# database file will be recreated with each doxygen run. If set to NO, doxygen +# will warn if an a database file is already found and not modify it. +# The default value is: YES. +# This tag requires that the tag GENERATE_SQLITE3 is set to YES. + +SQLITE3_RECREATE_DB = YES #--------------------------------------------------------------------------- # Configuration options related to the Perl module output #--------------------------------------------------------------------------- -# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module +# 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. @@ -1895,7 +2292,7 @@ GENERATE_AUTOGEN_DEF = NO GENERATE_PERLMOD = NO -# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary +# 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. @@ -1903,9 +2300,9 @@ GENERATE_PERLMOD = NO PERLMOD_LATEX = NO -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely +# 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 +# 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. @@ -1925,14 +2322,14 @@ PERLMOD_MAKEVAR_PREFIX = # Configuration options related to the preprocessor #--------------------------------------------------------------------------- -# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all +# 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 +# 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. @@ -1948,7 +2345,7 @@ MACRO_EXPANSION = NO EXPAND_ONLY_PREDEF = NO -# If the SEARCH_INCLUDES tag is set to YES the includes files in the +# 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. @@ -1957,7 +2354,8 @@ 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. +# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of +# RECURSIVE has no effect here. # This tag requires that the tag SEARCH_INCLUDES is set to YES. INCLUDE_PATH = @@ -2022,64 +2420,34 @@ TAGFILES = # 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 = +GENERATE_TAGFILE = doxygen/tagfile.xml -# 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. +# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces +# will be listed in the class and namespace index. If set to NO, only the +# inherited external classes will be listed. # The default value is: NO. ALLEXTERNALS = NO -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in -# the modules index. If set to NO, only the current project's groups will be +# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed +# in the topic index. If set to NO, only the current project's groups will be # listed. # The default value is: YES. EXTERNAL_GROUPS = YES -# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in +# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in # the related pages index. If set to NO, only the current project's pages will # be listed. # The default value is: YES. EXTERNAL_PAGES = YES -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of 'which perl'). -# The default file (with absolute path) is: /usr/bin/perl. - -PERL_PATH = /usr/bin/perl - #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# Configuration options related to diagram generator tools #--------------------------------------------------------------------------- -# 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 define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see: -# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the -# default search path. - -MSCGEN_PATH = - -# You can include diagrams made with dia in doxygen documentation. Doxygen will -# then run dia to produce the diagram and insert it in the documentation. The -# DIA_PATH tag allows you to specify the directory where the dia binary resides. -# If left empty dia is assumed to be found in the default search path. - -DIA_PATH = - -# If set to YES, the inheritance and collaboration graphs will hide inheritance +# 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. @@ -2087,12 +2455,12 @@ 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 +# https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent # Bell Labs. The other options in this section have no effect if this option is # set to NO # The default value is: YES. -HAVE_DOT = NO +HAVE_DOT = YES # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed # to run in parallel. When set to 0 doxygen will base this on the number of @@ -2104,55 +2472,79 @@ HAVE_DOT = NO 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. +# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of +# subgraphs. When you want a differently looking font in the dot files that +# doxygen generates you can specify fontname, fontcolor and fontsize attributes. +# For details please see Node, +# Edge and Graph Attributes specification You need to make sure dot is able +# to find the font, which can be done by putting it in a standard location or by +# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. Default graphviz fontsize is 14. +# The default value is: fontname=Helvetica,fontsize=10. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTNAME = FreeSans.ttf +DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" -# 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. +# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can +# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. Complete documentation about +# arrows shapes. +# The default value is: labelfontname=Helvetica,labelfontsize=10. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTSIZE = 10 +DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=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. +# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes +# around nodes set 'shape=plain' or 'shape=plaintext' Shapes specification +# The default value is: shape=box,height=0.2,width=0.4. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" + +# You can set the path where dot can find font specified with fontname in +# DOT_COMMON_ATTR and others dot attributes. # This tag requires that the tag HAVE_DOT is set to YES. DOT_FONTPATH = -# If the CLASS_GRAPH tag is set to YES 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. +# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will +# generate a graph for each documented class showing the direct and indirect +# inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and +# HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case +# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the +# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used. +# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance +# relations will be shown as texts / links. +# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN. # 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. +# class with other documented classes. Explicit enabling a collaboration graph, +# when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the +# command \collaborationgraph. Disabling a collaboration graph can be +# accomplished by means of the command \hidecollaborationgraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. COLLABORATION_GRAPH = YES # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for -# groups, showing the direct groups dependencies. +# groups, showing the direct groups dependencies. Explicit enabling a group +# dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means +# of the command \groupgraph. Disabling a directory graph can be accomplished by +# means of the command \hidegroupgraph. See also the chapter Grouping in the +# manual. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. GROUP_GRAPHS = YES -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# 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. @@ -2169,10 +2561,32 @@ UML_LOOK = NO # 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. +# This tag requires that the tag UML_LOOK is set to YES. UML_LIMIT_NUM_FIELDS = 10 +# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and +# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS +# tag is set to YES, doxygen will add type and arguments for attributes and +# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen +# will not generate fields with class member information in the UML graphs. The +# class diagrams will look similar to the default class diagrams but using UML +# notation for the relationships. +# Possible values are: NO, YES and NONE. +# The default value is: NO. +# This tag requires that the tag UML_LOOK is set to YES. + +DOT_UML_DETAILS = NO + +# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters +# to display on a single line. If the actual line length exceeds this threshold +# significantly it will wrapped across multiple lines. Some heuristics are apply +# to avoid ugly line breaks. +# Minimum value: 0, maximum value: 1000, default value: 17. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_WRAP_THRESHOLD = 17 + # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and # collaboration graphs will show the relations between templates and their # instances. @@ -2184,7 +2598,9 @@ 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. +# files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO, +# can be accomplished by means of the command \includegraph. Disabling an +# include graph can be accomplished by means of the command \hideincludegraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2193,7 +2609,10 @@ 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. +# files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set +# to NO, can be accomplished by means of the command \includedbygraph. Disabling +# an included by graph can be accomplished by means of the command +# \hideincludedbygraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2204,7 +2623,8 @@ INCLUDED_BY_GRAPH = YES # # 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. +# 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. @@ -2215,7 +2635,8 @@ CALL_GRAPH = NO # # 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. +# 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. @@ -2231,24 +2652,37 @@ 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. +# files in the directories. Explicit enabling a directory graph, when +# DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command +# \directorygraph. Disabling a directory graph can be accomplished by means of +# the command \hidedirectorygraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. DIRECTORY_GRAPH = YES +# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels +# of child directories generated in directory dependency graphs by dot. +# Minimum value: 1, maximum value: 25, default value: 1. +# This tag requires that the tag DIRECTORY_GRAPH is set to YES. + +DIR_GRAPH_MAX_DEPTH = 1 + # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. +# generated by dot. For an explanation of the image formats see the section +# output formats in the documentation of the dot tool (Graphviz (see: +# https://www.graphviz.org/)). # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order # to make the SVG files visible in IE 9+ (other browsers do not have this # requirement). -# Possible values are: png, 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 and svg. +# Possible values are: png, 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 +DOT_IMAGE_FORMAT = svg # 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. @@ -2260,7 +2694,7 @@ DOT_IMAGE_FORMAT = png # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. -INTERACTIVE_SVG = NO +INTERACTIVE_SVG = YES # 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. @@ -2275,11 +2709,12 @@ DOT_PATH = 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). +# 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. -MSCFILE_DIRS = +DIA_PATH = # The DIAFILE_DIRS tag can be used to specify one or more directories that # contain dia files that are included in the documentation (see the \diafile @@ -2288,14 +2723,23 @@ MSCFILE_DIRS = 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. -# This tag requires that the tag HAVE_DOT is set to YES. +# path where java can find the plantuml.jar file or to the filename of jar file +# to be used. If left blank, it is assumed PlantUML is not used or called during +# a preprocessing step. Doxygen will generate a warning when it encounters a +# \startuml command in this case and will not generate output for the diagram. PLANTUML_JAR_PATH = +# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a +# configuration file for plantuml. + +PLANTUML_CFG_FILE = + +# When using plantuml, the specified paths are searched for files specified by +# the !include statement in a plantuml block. + +PLANTUML_INCLUDE_PATH = + # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes # that will be shown in the graph. If the number of nodes in a graph becomes # larger than this value, doxygen will truncate the graph, which is visualized @@ -2320,19 +2764,7 @@ DOT_GRAPH_MAX_NODES = 50 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 allow dot to generate multiple output +# 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. @@ -2344,14 +2776,34 @@ DOT_MULTI_TARGETS = YES # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page # explaining the meaning of the various boxes and arrows in the dot generated # graphs. +# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal +# graphical representation for inheritance and collaboration diagrams is used. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. GENERATE_LEGEND = YES -# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate # files that are used to generate the various graphs. +# +# Note: This setting is not only used for dot files but also for msc temporary +# files. # The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. DOT_CLEANUP = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will +# use a built-in version of mscgen tool to produce the charts. Alternatively, +# the MSCGEN_TOOL tag can also specify the name an external tool. For instance, +# specifying prog as the value, doxygen will call the tool as prog -T +# -o . The external tool should support +# output file formats "png", "eps", "svg", and "ismap". + +MSCGEN_TOOL = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the \mscfile +# command). + +MSCFILE_DIRS = diff --git a/client/control.cpp b/client/control.cpp index 2b33acacf0..834d3e7192 100644 --- a/client/control.cpp +++ b/client/control.cpp @@ -2518,7 +2518,7 @@ void do_map_click(struct tile *ptile, enum quickselect_type qtype) } /** - Quickselecting a unit is normally done with left, right click, + Quickselecting a unit is normally done with [control] left, right click, for the current tile. Bypassing the stack popup is quite convenient, and can be tactically important in furious multiplayer games. */ diff --git a/client/shortcuts.cpp b/client/shortcuts.cpp index ff2e7190ac..1d8674c152 100644 --- a/client/shortcuts.cpp +++ b/client/shortcuts.cpp @@ -444,7 +444,7 @@ void shortcut_edit::set_shortcut(const fc_shortcut &shortcut) } /** - * \reimp + * Reimplemented from QObject */ bool shortcut_edit::event(QEvent *event) { diff --git a/client/tileset/drawn_sprite.h b/client/tileset/drawn_sprite.h index f34f57d0bc..d329a0cefe 100644 --- a/client/tileset/drawn_sprite.h +++ b/client/tileset/drawn_sprite.h @@ -17,10 +17,10 @@ class QRect; struct tileset; struct drawn_sprite { - explicit drawn_sprite(const tileset *ts, const QPixmap *sprite, + explicit drawn_sprite(const struct tileset *ts, const QPixmap *sprite, bool foggable = true, int offset_x = 0, int offset_y = 0); - explicit drawn_sprite(const tileset *ts, const QPixmap *sprite, + explicit drawn_sprite(const struct tileset *ts, const QPixmap *sprite, bool foggable, const QPoint &offset); drawn_sprite(const drawn_sprite &other) = default; drawn_sprite(drawn_sprite &&other) = default; diff --git a/client/tileset/layer_base_flags.cpp b/client/tileset/layer_base_flags.cpp index f1e72fb615..5759ac7f7e 100644 --- a/client/tileset/layer_base_flags.cpp +++ b/client/tileset/layer_base_flags.cpp @@ -23,7 +23,7 @@ namespace freeciv { /** * @class layer_base_flags * - * Map layer that draws flags for bases that have @ref EF_SHOW_FLAG set. + * Map layer that draws flags for bases that have EF_SHOW_FLAG set. */ layer_base_flags::layer_base_flags(struct tileset *ts, const QPoint &offset) diff --git a/client/utils/colorizer.cpp b/client/utils/colorizer.cpp index b2c115cf8a..283d961fb3 100644 --- a/client/utils/colorizer.cpp +++ b/client/utils/colorizer.cpp @@ -12,7 +12,7 @@ namespace freeciv { /** - * @class colorizer Swaps colors in QPixmap + * @class colorizer colorizer.h Swaps colors in QPixmap * * Starting from a base pixmap, this class generates new pixmaps with one * color replaced (for instance, all pink pixels changed to green). diff --git a/client/views/view_map_common.cpp b/client/views/view_map_common.cpp index 86e78ce09f..85bc92ea63 100644 --- a/client/views/view_map_common.cpp +++ b/client/views/view_map_common.cpp @@ -581,7 +581,7 @@ void set_mapview_origin(float gui_x0, float gui_y0) /** Return the scroll dimensions of the clipping window for the mapview - window.. + window. Imagine the entire map in scroll coordinates. It is a rectangle. Now imagine the mapview "window" sliding around through this rectangle. How diff --git a/common/aicore/path_finding.cpp b/common/aicore/path_finding.cpp index 9c1e695d69..c57cc830d7 100644 --- a/common/aicore/path_finding.cpp +++ b/common/aicore/path_finding.cpp @@ -92,14 +92,14 @@ struct pf_map { /** * Casts to `pf_map` * - * \fixme Capitalized because this used to be a macro. + * \todo Capitalized because this used to be a macro. */ pf_map *PF_MAP(void *x) { return reinterpret_cast(x); } /** * Casts to `pf_map` * - * \fixme Capitalized because this used to be a macro. + * \todo Capitalized because this used to be a macro. */ const pf_map *PF_MAP(const void *x) { diff --git a/common/game.cpp b/common/game.cpp index 01d1adba2f..b5a32ea8c6 100644 --- a/common/game.cpp +++ b/common/game.cpp @@ -738,10 +738,10 @@ static char *year_suffix() Generate a default save file name and place it in the provided buffer. Within the name the following custom formats are allowed: - %R = - %S = - %T = - %Y = + %R = [reason] + %S = [suffix] + %T = [game.info.turn] + %Y = [game.info.year] Examples: 'freeciv-T%04T-Y%+04Y-%R' => 'freeciv-T0099-Y-0050-manual' diff --git a/common/mapimg.cpp b/common/mapimg.cpp index 37da5df2e8..2571445278 100644 --- a/common/mapimg.cpp +++ b/common/mapimg.cpp @@ -1042,8 +1042,8 @@ bool mapimg_id2str(int id, char *str, size_t str_len) /** Create the requested map image. The filename is created as - -. where - contains the map definition and the selected image extension. + `basename as used for savegames-mapstr.mapext` where `mapstr` + contains the map definition and `mapext` the selected image extension. If 'force' is FALSE, the image is only created if game.info.turn is a multiple of the map setting turns. */ @@ -1150,9 +1150,8 @@ bool mapimg_create(struct mapdef *pmapdef, bool force, const char *savename, /** Create images which shows all map colors (playercolor, terrain colors). - One image is created for each supported toolkit and image format. The - filename will be -colortest-.. + One image is created for each supported image format. The filename will be + [basename as used for savegames]-colortest.[format]. */ bool mapimg_colortest(const char *savename, const char *path) { @@ -1413,11 +1412,10 @@ static void mapimg_log(const char *file, const char *function, int line, /** Generate an identifier for a map image. - MZP + `M[map options]Z[zoom factor]P[players]` - map options - zoom factor - player ID or vector of size MAX_NUM_PLAYER_SLOTS [0/1] + Where `[players]` is the player ID or vector of size MAX_NUM_PLAYER_SLOTS + [0/1]. For the player bitvector all MAX_NUM_PLAYER_SLOTS values are used due to the possibility of additional players during the game (civil war, diff --git a/common/rgbcolor.cpp b/common/rgbcolor.cpp index 4b5d6090cd..18696c59bc 100644 --- a/common/rgbcolor.cpp +++ b/common/rgbcolor.cpp @@ -72,8 +72,8 @@ void rgbcolor_destroy(struct rgbcolor *prgbcolor) } /** - Lookup an RGB color definition (.red, .green and - .blue). Returns TRUE on success and FALSE on error. + Lookup an RGB color definition (`[colorpath].red`, `[colorpath].green` and + `[colorpath].blue`). Returns TRUE on success and FALSE on error. */ bool rgbcolor_load(struct section_file *file, struct rgbcolor **prgbcolor, const char *path, ...) @@ -103,8 +103,8 @@ bool rgbcolor_load(struct section_file *file, struct rgbcolor **prgbcolor, } /** - Save an RGB color definition (.red, .green and - .blue). + Save an RGB color definition (`[colorpath].red`, `[colorpath].green` and + `[colorpath].blue`). */ void rgbcolor_save(struct section_file *file, const struct rgbcolor *prgbcolor, const char *path, ...) diff --git a/common/scriptcore/luascript.cpp b/common/scriptcore/luascript.cpp index 43491d4398..418a2b71cb 100644 --- a/common/scriptcore/luascript.cpp +++ b/common/scriptcore/luascript.cpp @@ -258,7 +258,8 @@ int luascript_error_vargs(lua_State *L, const char *format, va_list vargs) /** Like script_error, but using a prefix identifying the called lua function: - bad argument #narg to '': msg + + bad argument #narg to 'func': msg */ int luascript_arg_error(lua_State *L, int narg, const char *msg) { diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index b74113b1b0..c3f031710c 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -6,15 +6,29 @@ else() find_package(Sphinx QUIET) endif() -if(SPHINX_FOUND) - message(STATUS "Sphinx Found, configuring.") +find_package(Doxygen) + +if (SPHINX_FOUND AND DOXYGEN_FOUND) + message(STATUS "Sphinx and Doxygen found, configuring.") + set(SPHINX_SOURCE ${CMAKE_SOURCE_DIR}/docs) set(SPHINX_BUILD ${CMAKE_CURRENT_BINARY_DIR}) set(SPHINX_MAN ${CMAKE_CURRENT_BINARY_DIR}/man) + # We need to run doxygen before sphinx to update doxygen/tagfile.xml. This + # command does it. The output is a dummy one so the command always runs. + # doxygen has some level of caching so it doesn't take that long, and + # collecting a list of all source files would be cumbersome. + add_custom_command(OUTPUT dummy-doxygen + COMMAND Doxygen::doxygen + WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}" + COMMENT "Running Doxygen") + + # This builds the main documentation website. add_custom_target(docs COMMAND ${SPHINX_EXECUTABLE} -b html ${SPHINX_SOURCE} ${SPHINX_BUILD} + DEPENDS dummy-doxygen WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generating documentation with Sphinx") diff --git a/docs/Coding/ai.rst b/docs/Coding/ai.rst index 6dab4547ab..4631931bf7 100644 --- a/docs/Coding/ai.rst +++ b/docs/Coding/ai.rst @@ -41,7 +41,7 @@ The long-term goals for Freeciv21 :term:`AI` development are: Want Calculations ================= -Build calculations are expressed through a structure called :code:`adv_choice`. This has a variable called +Build calculations are expressed through a structure called :freeciv21:`adv_choice`. This has a variable called "want", which determines how much the :term:`AI` wants whatever item is pointed to by :code:`choice->type`. :code:`choice->want` is: @@ -69,11 +69,11 @@ Diplomats, in particular, seem to violate these standards. Amortize ======== -Hard fact: :code:`amortize(benefit, delay)` returns +Hard fact: :freeciv21:`amortize` returns :math:`\texttt{benefit} \times \left(1 - \frac{1}{\texttt{MORT}}\right)^{\texttt{delay}}`. Speculation: What is better... to receive $10 annually starting in 5 years from now or $5 annually starting -from this year? How can you take inflation into account? The function :code:`amortize()` is meant to help you +from this year? How can you take inflation into account? The function :freeciv21:`amortize` is meant to help you answer these questions. To achieve this, it re-scales the future benefit in terms of today's money. Suppose we have a constant rate of inflation, :math:`x` percent. Then in five years $10 will buy as much @@ -81,7 +81,7 @@ as :math:`10\left(\frac{100}{100 + x}\right)^5` will buy today. Denoting :math:` :math:`q` we get the general formula, :math:`N` dollars, :math:`Y` years from now will be worth :math:`N\times q^Y` in today's money. If we receive :math:`N` every year starting :math:`Y` years from now, the total amount receivable (in today's money) is :math:`\frac{\,N\,\times\, q^Y}{1 - q}`. This is the sum of -infinite geometric series. This is exactly the operation that the :code:`amortize()` function performs, the +infinite geometric series. This is exactly the operation that the :code:`amortize` function performs, the multiplication by some :math:`q < 1` raised to power :math:`Y`. Note that the factor :math:`\frac{1}{1 - q}` does not depend on the parameters :math:`N` and :math:`Y`, and can be ignored. The connection between the :math:`\texttt{MORT}` constant and the inflation rate :math:`x` is given by @@ -89,16 +89,16 @@ does not depend on the parameters :math:`N` and :math:`Y`, and can be ignored. T :math:`\texttt{MORT} = 24` corresponds to the inflation rate, or the rate of expansion of your civilization of 4.3% -Most likely this explanation is not what the authors of :code:`amortize()` had in mind, but the basic idea is +Most likely this explanation is not what the authors of :freeciv21:`amortize` had in mind, but the basic idea is correct: the value of the payoff decays exponentially with the delay. -The version of amortize used in the military code (:code:`military_amortize()`) remains a complete mystery. +The version of amortize used in the military code (:freeciv21:`military_amortize`) remains a complete mystery. Estimation of Profit From a Military Operation ============================================== -This estimation is implemented by the :code:`kill_desire()` function, which is not perfect, the +This estimation is implemented by the :freeciv21:`kill_desire` function, which is not perfect, the :code:`multi-victim` part is flawed, plus some corrections. In general: .. math:: @@ -126,7 +126,7 @@ Selecting Military Units The code dealing with choosing military units to be built and targets for them is especially messy. -Military units are requested in the :code:`military_advisor_choose_build()` function. It first considers the +Military units are requested in the :freeciv21:`military_advisor_choose_build` function. It first considers the defensive units and then ventures into selection of attackers (if home is safe). There are two possibilities here: we just build a new attacker or we already have an attacker which was forced, for some reason, to defend. In the second case it is easy: we calculate how good the existing attacker is and if it is good, we build a @@ -135,17 +135,17 @@ defender to free it up. Building a brand new attacker is more complicated. First, the :code:`ai_choose_attacker_*` functions are called to find the first approximation to the best attacker that can be built here. This prototype attacker is selected using very simple :math:`\texttt{attack\_power}\times\texttt{speed}` formula. Then, already in the -:code:`kill_something_with()` function, we search for targets for the prototype attacker using the -:code:`find_something_to_kill()` function. Having found a target, we do the last refinement by calling the -:code:`process_attacker_want()` function to look for the best attacker type to take out the target. This type -will be our attacker of choice. Note that the :code:`function process_attacker_want()` function has side-effects +:freeciv21:`kill_something_with` function, we search for targets for the prototype attacker using the +:freeciv21:`find_something_to_kill` function. Having found a target, we do the last refinement by calling the +:freeciv21:`process_attacker_want` function to look for the best attacker type to take out the target. This type +will be our attacker of choice. Note that the function :freeciv21:`process_attacker_want` function has side-effects with regards to the Technology selection. Here is an example: -First the :code:`ai_choose_attacker_land()` function selects a :unit:`Dragoon` because it is strong and fast. -Then the :code:`find_something_to_kill()` function finds a victim for the (virtual) :unit:`Dragoon`, an enemy -:unit:`Riflemen` standing right next to the city. Then the :code:`process_attacker_want()` function figures +First the :freeciv21:`dai_choose_attacker` function selects a :unit:`Dragoon` because it is strong and fast. +Then the :freeciv21:`find_something_to_kill` function finds a victim for the (virtual) :unit:`Dragoon`, an enemy +:unit:`Riflemen` standing right next to the city. Then the :freeciv21:`process_attacker_want` function figures out that since the enemy is right beside us, it can be taken out easier using an :unit:`Artillery`. It also figures that a :unit:`Howitzer` would do this job even better, so bumps up our desire for :advance:`Robotics`. @@ -232,7 +232,7 @@ There are currently seven difficulty levels: The ``hard`` level is no-holds-barred. ``Cheating`` is the same except that it has ruleset defined extra bonuses, while ``normal`` has a number of handicaps. In ``easy``, the :term:`AI` also does random stupid -things through the :code:`ai_fuzzy()` function. In ``novice`` the :term:`AI` researches slower than normal +things through the :freeciv21:`ai_fuzzy` function. In ``novice`` the :term:`AI` researches slower than normal players. The ``experimental`` level is only for coding. You can gate new code with the ``H_EXPERIMENTAL`` handicap and test ``experimental`` level :term:`AI`'s against ``hard`` level :term:`AI`'s. @@ -261,7 +261,7 @@ Other handicaps used are: ``H_DANGER`` Always thinks its city is in danger. ================= ======= -For an up-to-date list of all handicaps and their use for each difficulty level see :file:`ai/handicaps.h`. +For an up-to-date list of all handicaps and their use for each difficulty level see :freeciv21:`handicaps.h`. Things That Need To Be Fixed @@ -278,7 +278,7 @@ Things That Need To Be Fixed * :term:`AI` sometimes believes that wasting a horde of weak military units to kill one enemy is profitable. * Stop building shore defense improvements in landlocked cities with a Lake adjacent. * Fix the :term:`AI` valuation of :improvement:`Supermarket`. It currently never builds it. See the - :code:`farmland_food()` and :code:`ai_eval_buildings()` functions in :file:`advdomestic.cpp`. + :freeciv21:`building_advisor_choose` function in :freeciv21:`advbuilding.cpp`. * Teach the :term:`AI` to coordinate the units in an attack. @@ -286,7 +286,7 @@ Idea Space ========== * Friendly cities can be used as beachheads. -* The :code:`Assess_danger()` function should acknowledge positive feedback between multiple attackers. +* The :freeciv21:`assess_danger` function should acknowledge positive feedback between multiple attackers. * It would be nice for a bodyguard and charge to meet en-route more elegantly. -* The :code:`struct choice` should have a priority indicator in it. This will reduce the number of "special" +* The :freeciv21:`choice` struct should have a priority indicator in it. This will reduce the number of "special" want values and remove the necessity to have want capped, thus reducing confusion. diff --git a/docs/Coding/hacking.rst b/docs/Coding/hacking.rst index 3a0a99862b..b0445cf22d 100644 --- a/docs/Coding/hacking.rst +++ b/docs/Coding/hacking.rst @@ -73,8 +73,8 @@ If you plan to compare results of autogames the following changes can be helpful Old Lists ========= -For variable length list of units and cities Freeciv21 uses a :code:`genlist`, which is implemented in -:file:`utility/genlist.cpp`. By some macro magic type specific macros have been defined, creating a lot of +For variable length list of units and cities Freeciv21 uses a :freeciv21:`genlist`, which is implemented in +:freeciv21:`genlist.cpp`. By some macro magic type specific macros have been defined, creating a lot of trouble for C++ programmers. These macro-based lists are being phased out in favor of STL containers. In the meantime, we preserve here an explanation of how to use them. @@ -98,15 +98,15 @@ Note that the macro itself declares the variable :code:`punit`. Similarly there There are other operations than iterating that can be performed on a list; inserting, deleting, or sorting -etc. See :file:`utility/speclist.h`. Note that the way the :code:`*_list_iterate macro` is implemented means +etc. See :freeciv21:`speclist.h`. Note that the way the :code:`*_list_iterate macro` is implemented means you can use "continue" and "break" in the usual manner. One thing you should keep in the back of your mind. Say you are iterating through a unit list, and then somewhere inside the iteration decide to disband a unit. In the server you would do this by calling -:code:`wipe_unit(punit)`, which would then remove the unit node from all the relevant unit lists. However, by -the way :code:`unit_list_iterate` works, if the removed unit was the following node :code:`unit_list_iterate` +:freeciv21:`wipe_unit`, which would then remove the unit node from all the relevant unit lists. However, by +the way :freeciv21:`unit_list_iterate` works, if the removed unit was the following node :freeciv21:`unit_list_iterate` will already have saved the pointer, and use it in a moment, with a segfault as the result. To avoid this, use -:code:`unit_list_iterate_safe` instead. +:freeciv21:`unit_list_iterate_safe` instead. Graphics ======== @@ -132,8 +132,8 @@ Map Structure ============= The map is maintained in a pretty straightforward C array, containing :math:`X\times Y` tiles. You can use the -function :code:`struct tile *map_pos_to_tile(x, y)` to find a pointer to a specific tile. A tile has various -fields; see the struct in :file:`common/map.h`. +function :freeciv21:`map_pos_to_tile` to find a pointer to a tile at specific coordinates. A tile has various +fields; see the struct :freeciv21:`tile`. You may iterate tiles, you may use the following methods: @@ -195,7 +195,7 @@ for iterating all tiles in the radius defined ``radius`` (in square distance, se for iterating all tiles in the radius defined ``radius`` (in real distance, see below), beginning by ``center_tile``. Actually, this is the duplicate of square_iterate, or various tricky ones defined in -:file:`common/map.h`, which automatically adjust the tile values. The defined macros should be used whenever +:freeciv21:`map.h`, which automatically adjust the tile values. The defined macros should be used whenever possible, the examples above were only included to give people the knowledge of how things work. Note that the following: @@ -215,14 +215,14 @@ is not a reliable way to iterate all adjacent tiles for all topologies, so such Also available are the functions calculating distance between tiles. In Freeciv21, we are using 3 types of distance between tiles: -* The :code:`map_distance(ptile0, ptile1)` function returns the *Manhattan* distance between tiles, i.e. the +* The :freeciv21:`map_distance` function returns the *Manhattan* distance between tiles, i.e. the distance from :code:`ptile0` to :code:`ptile1`, only using cardinal directions. For example, :math:`|dx| + |dy|` for non-hexagonal topologies. -* The :code:`real_map_distance(ptile0, ptile1)` function returns the *normal* distance between tiles, i.e. the +* The :freeciv21:`real_map_distance` function returns the *normal* distance between tiles, i.e. the minimal distance from :code:`ptile0` to :code:`ptile1` using all valid directions for the current topology. -* The :code:`sq_map_distance(ptile0, ptile1)` function returns the *square* distance between tiles. This is a +* The :freeciv21:`sq_map_distance` function returns the *square* distance between tiles. This is a simple way to make Pythagorean effects for making circles on the map for example. For non-hexagonal topologies, it would be :math:`dx^2 + dy^2`. Only useless square root is missing. @@ -355,17 +355,17 @@ When performing operations in map coordinates (like a translation of tile :code: -> :code:`(x + dx, y + dy)`), the new map coordinates may be unsuitable for the current map. In case, you should use one of the following functions or macros: -* :code:`map_pos_to_tile()`: return ``NULL`` if normalization is not possible; +* :freeciv21:`map_pos_to_tile`: return ``nullptr`` if normalization is not possible; -* :code:`normalize_map_pos()`: return ``TRUE`` if normalization have been done (wrapping X and Y coordinates +* :freeciv21:`normalize_map_pos`: return ``true`` if normalization have been done (wrapping X and Y coordinates if the current topology allows it); -* :code:`is_normal_map_pos()`: return ``TRUE`` if the map coordinates exist for the map; +* :freeciv21:`is_normal_map_pos`: return ``true`` if the map coordinates exist for the map; -* :code:`CHECK_MAP_POS()`: assert whether the map coordinates exist for the map. +* :freeciv21:`CHECK_MAP_POS`: assert whether the map coordinates exist for the map. Map coordinates are quite central in the coordinate system, and they may be easily converted to any other -coordinates: :code:`MAP_TO_NATURAL_POS()`, :code:`MAP_TO_NATIVE_POS()`, or :code:`map_pos_to_index()` +coordinates: :freeciv21:`MAP_TO_NATURAL_POS`, :freeciv21:`MAP_TO_NATIVE_POS`, or :freeciv21:`map_pos_to_index` functions. Natural Coordinates @@ -399,7 +399,7 @@ With an isometric view, this looks like: Natural coordinates are mostly used for operations which concern the user view. It is the best way to determine the horizontal and the vertical axis of the view. -The only coordinates conversion is done using the :code:`NATURAL_TO_MAP_POS()` function. +The only coordinates conversion is done using the :freeciv21:`NATURAL_TO_MAP_POS` function. Native Coordinates ^^^^^^^^^^^^^^^^^^ @@ -439,18 +439,18 @@ coordinates by compressing the natural representation in the X axis to get the 3 The resulting coordinate system is much easier to use than map coordinates for some operations. These -include most internal topology operations (e.g., :code:`normalize_map_pos`, or :code:`whole_map_iterate`) as +include most internal topology operations (e.g., :freeciv21:`normalize_map_pos`, or :freeciv21:`whole_map_iterate`) as well as storage (in ``map.tiles`` and savegames, for instance). In general, native coordinates can be defined based on this property; the basic map becomes a continuous (gap-free) cardinally-oriented rectangle when expressed in native coordinates. -Native coordinates can be easily converted to map coordinates using the :code:`NATIVE_TO_MAP_POS()` function, -to index using the code:`native_pos_to_index()` function and to tile (shortcut) using the -:code:`native_pos_to_tile()` function. +Native coordinates can be easily converted to map coordinates using the :freeciv21:`NATIVE_TO_MAP_POS` function, +to index using the code: :freeciv21:`native_pos_to_index` function and to tile (shortcut) using the +:freeciv21:`native_pos_to_tile` function. -After operations, such as the :code:`FC_WRAP(x, map.xsize)` function, the result may be checked with the -:code:`CHECK_NATIVE_POS()` function. +After operations, such as the :freeciv21:`FC_WRAP` function, the result may be checked with the +:freeciv21:`CHECK_NATIVE_POS` function. Index Coordinates ^^^^^^^^^^^^^^^^^ @@ -460,10 +460,10 @@ coordinate system is closely tied to the ordering of the tiles in native coordin easier to use for some operations (like storage) because it is one-dimensional. In general you cannot assume anything about the ordering of the positions within the system. -Indexes can be easily converted to native coordinates using the :code:`index_to_native_pos()` function or to -map positions (shortcut) using the :code:`index_to_map_pos()` function. +Indexes can be easily converted to native coordinates using the :freeciv21:`index_to_native_pos` function or to +map positions (shortcut) using the :freeciv21:`index_to_map_pos` function. -A map index can tested using the :code:`CHECK_INDEX` macro. +A map index can tested using the :freeciv21:`CHECK_INDEX` macro. With a classical rectangular map, the first three coordinate systems are equivalent. When we introduce isometric maps, the distinction becomes important, as demonstrated above. Many places in the code have @@ -523,13 +523,13 @@ The math then works out to: y_\texttt{nat} &= x_\texttt{map} + y_\texttt{map} - x_\texttt{size} \\ x_\texttt{nat} &= \left\lfloor x_\texttt{map} - y_\texttt{map} + \dfrac{x_\texttt{size}}{2} \right\rfloor -which leads to the macros :code:`NATIVE_TO_MAP_POS()`, and :code:`MAP_TO_NATIVE_POS()` that are defined in -:file:`map.h`. +which leads to the macros :freeciv21:`NATIVE_TO_MAP_POS`, and :freeciv21:`MAP_TO_NATIVE_POS` that are defined in +:freeciv21:`map.h`. Unknown Tiles and Fog of War ---------------------------- -In :file:`common/player.h`, there are several fields: +In :freeciv21:`player.h`, there are several fields: .. code-block:: cpp @@ -549,7 +549,7 @@ In :file:`common/player.h`, there are several fields: }; -While :code:`tile_get_known()` returns: +While :freeciv21:`tile_get_known` returns: .. code-block:: cpp @@ -561,11 +561,11 @@ While :code:`tile_get_known()` returns: }; -The values :code:`TILE_UNKNOWN` and :code:`TILE_KNOWN_SEEN` are straightforward. :code:`TILE_KNOWN_UNSEEN` is +The values :freeciv21:`TILE_UNKNOWN` and :freeciv21:`TILE_KNOWN_SEEN` are straightforward. :freeciv21:`TILE_KNOWN_UNSEEN` is a tile of which the user knows the terrain, but not recent cities, roads, etc. -:code:`TILE_UNKNOWN` tiles never are (nor should be) sent to the client. In the past, :code:`UNKNOWN` tiles -that were adjacent to :code:`UNSEEN` or :code:`SEEN` were sent to make the drawing process easier, but this +:freeciv21:`TILE_UNKNOWN` tiles never are (nor should be) sent to the client. In the past, :freeciv21:`TILE_UNKNOWN` tiles +that were adjacent to :freeciv21:`TILE_KNOWN_UNSEEN` or :freeciv21:`TILE_KNOWN_SEEN` were sent to make the drawing process easier, but this has now been removed. This means exploring new land may sometimes change the appearance of existing land (but this is not fundamentally different from what might happen when you transform land). Sending the extra info, however, not only confused the goto code but allowed cheating. @@ -574,18 +574,17 @@ Fog of War is the fact that even when you have seen a tile once you are not sent the sight range of one of your units or cities. We keep track of Fog of War by counting the number of units and cities of each client that can see the tile. -This requires a number per player, per tile, so each :code:`player_tile` has a :code:`short[]`. Every time a +This requires a number per player, per tile, so each :freeciv21:`player_tile` has a :code:`short[]`. Every time a unit, city, or something else can observe a tile 1 is added to its player's number at the tile, and when it cannot observe any more (killed/moved/pillaged) 1 is subtracted. In addition to the initialization/loading of -a game this array is manipulated with the :code:`void unfog_area(struct player *pplayer, int x, int y, int -len)` and :code:`void fog_area(struct player *pplayer, int x, int y, int len)` functions. The :code:`int len` +a game this array is manipulated with the :freeciv21:`unfog_area` and :freeciv21:`fog_area` functions. The :code:`int len` variable is the radius of the area that should be fogged/unfogged, i.e. a ``len`` of 1 is a normal unit. In -addition to keeping track of Fog of War, these functions also make sure to reveal :code:`TILE_UNKNOWN` tiles -you get near, and send information about :code:`TILE_UNKNOWN` tiles near that the client needs for drawing. -They then send the tiles to the :code:`void send_tile_info(struct player *dest, int x, int y)` function, which +addition to keeping track of Fog of War, these functions also make sure to reveal :freeciv21:`TILE_UNKNOWN` tiles +you get near, and send information about :freeciv21:`TILE_UNKNOWN` tiles near that the client needs for drawing. +They then send the tiles to the :freeciv21:`send_tile_info` function, which then sets the correct ``known_type`` and sends the tile to the client. -If you want to just show the terrain and cities of the square the function :code:`show_area()` does this. The +If you want to just show the terrain and cities of the square the function :freeciv21:`show_area` does this. The tiles remain fogged. If you play without Fog of War all the values of the seen arrays are initialized to 1. So you are using the exact same code, you just never get down to 0. As changes in the "fogginess" of the tiles are only sent to the client when the value shifts between zero and non-zero, no redundant packages are sent. @@ -605,8 +604,8 @@ This field is not kept up to date as long as the player can see the tile and it gets fogged the date is updated. There is a Shared Vision feature, meaning that if ``p1`` gives Shared Vision to ``p2``, every time a function -like :code:`show_area()`, :code:`fog_area()`, :code:`unfog_area()`, or -:code:`give_tile_info_from_player_to_player()` is called on ``p1``, ``p2`` also gets the information. Note +like :freeciv21:`show_area`, :freeciv21:`fog_area`, :freeciv21:`unfog_area`, or +:freeciv21:`give_tile_info_from_player_to_player` is called on ``p1``, ``p2`` also gets the information. Note that if ``p2`` gives Shared Vision to ``p3``, ``p3`` also gets the information for ``p1``. This is controlled by ``p1's`` really_gives_vision bitvector, where the dependencies will be kept. diff --git a/docs/Coding/index.rst b/docs/Coding/index.rst index 1bf71bfdcf..96914b7312 100644 --- a/docs/Coding/index.rst +++ b/docs/Coding/index.rst @@ -17,4 +17,5 @@ architected. logging.rst network-protocol.rst scorelog.rst + Doxygen Documentation :maxdepth: 1 diff --git a/docs/Coding/internationalization.rst b/docs/Coding/internationalization.rst index a2d95fbc18..d7b902dc19 100644 --- a/docs/Coding/internationalization.rst +++ b/docs/Coding/internationalization.rst @@ -28,7 +28,7 @@ Translating Text Translating user-facing text is the most work-intensive part of internationalization. As a developer, you only need to make sure that strings are marked for translation when appropriate. In Freeciv21, this is done using a set of macros based on the `gettext `_ -library (defined in ``utility/fcintl.h``). The most simple one returns a translated version of a string: +library (defined in :freeciv21:`fcintl.h`). The most simple one returns a translated version of a string: .. code-block:: cpp diff --git a/docs/Coding/mapgen.rst b/docs/Coding/mapgen.rst index f5ea9450df..1188bd065f 100644 --- a/docs/Coding/mapgen.rst +++ b/docs/Coding/mapgen.rst @@ -15,22 +15,19 @@ This page describes how maps are generated in Freeciv21, from a technical perspective. There are several generators the user can choose from (``generator`` server setting), but they share a lot of code. The map generator code is located under ``server/generator``. The entry point is -``map_generate`` in ``mapgen.cpp``. +:freeciv21:`map_generate` in :freeciv21:`mapgen.cpp`. .. note:: See :doc:`/Manuals/Advanced/map-generator` for a less technical introduction. This page expects the reader to already be familiar with the settings governing map creation. -.. note:: - Code references are as of August 2024. - Map generation is performed in multiple passes. After some initialization, the first step, shared between all generators, is the creation of a basic temperature map. Since no terrain information exists at this stage, the temperature is simply a measure of the distance to the pole (the "colatitude"). Unless ``alltemperate`` is set, the world is then divided in four regions: -frozen, cold, temperate, and tropical (``create_tmap()``). +frozen, cold, temperate, and tropical (:freeciv21:`create_tmap`). After the temperature is set, the actual map generation starts. This depends on the map generator chosen by the user, with various fallbacks in place. The @@ -41,18 +38,18 @@ may already have been placed (this is for instance the case with the "fair islands" generator). At this stage, tiny (1x1) islands are removed if disabled in the settings -(``tinyislands`` parameter, ``remove_tiny_islands()``). Water is also fine-tuned -to always have shallow ocean next to the coast and be generally smooth -(``smooth_water_depth()``). Continent numbers are assigned and small seas are -turned to lakes (``assign_continent_numbers()`` and ``regenerate_lakes()``). The -temperature map is reset after this is done. +(``tinyislands`` parameter, :freeciv21:`remove_tiny_islands`). Water is also +fine-tuned to always have shallow ocean next to the coast and be generally +smooth (:freeciv21:`smooth_water_depth`). Continent numbers are assigned and +small seas are turned to lakes (:freeciv21:`assign_continent_numbers` and +:freeciv21:`regenerate_lakes`). The temperature map is reset after this is done. If not done earlier, resources are then added to the map with at least one tile between them. For each tile that gets a resource, one is picked at random from -the list of allowed resources for the terrain (``add_resources()``). Huts are -added in a similar way but with a minimum distance of 3 tiles (``make_huts()``). -The final step is to distribute players, as described in -:ref:`Player Placement ` below. +the list of allowed resources for the terrain (:freeciv21:`add_resources`). Huts +are added in a similar way but with a minimum distance of 3 tiles +(:freeciv21:`make_huts`). The final step is to distribute players, as described +in :ref:`Player Placement ` below. .. todo:: This page is missing information about the Fair Islands generator. Please feel @@ -76,8 +73,8 @@ similar way and is thus also described in this section. The equations used to derive the fraction of each terrain are highly arbitrary and have likely been determined through trial and error. Since the details are not particularly enlightening, only the general ideas are discussed below. The -interested reader can read the function ``adjust_terrain_param()`` in -``mapgen.cpp``. +interested reader can read the function :freeciv21:`adjust_terrain_param` in +:freeciv21:`mapgen.cpp`. The first fraction to be computed is the amount of polar terrain, decided based on the average temperature and the size of the map (larger maps get less). Since @@ -120,7 +117,7 @@ generators and is described in :ref:`mapgen-terrain-assignment`. Fully Random Height ^^^^^^^^^^^^^^^^^^^ -Entry point: ``make_random_hmap()``. +Entry point: :freeciv21:`make_random_hmap`. This generator is extremely simple: it builds a completely random height map and smoothes it out. @@ -133,7 +130,7 @@ below, and :ref:`rivers are added on top `. Pseudo-Fractal Height ^^^^^^^^^^^^^^^^^^^^^ -Entry point: ``make_pseudofractal1_hmap()``. +Entry point: :freeciv21:`make_pseudofractal_hmap`. This generator works by dividing the map in blocks (five plus the number of player islands to be created) and assigning a random height to their @@ -154,7 +151,7 @@ generate rivers as described in :ref:`mapgen-terrain-assignment` and Fracture Map ^^^^^^^^^^^^ -Entry point: ``make_fracture_map()``. +Entry point: :freeciv21:`make_fracture_hmap`. The ``FRACTURE`` generator starts from points distributed randomly on the map and grows them until they meet their neighbors. Each point is given a random @@ -199,7 +196,7 @@ Terrain Assignment Generators that use a height map to generate the map share a common routine to assign terrain to the generated tiles, whose algorithm is described in this -section. The code is in the ``make_land()`` function. +section. The code is in the :freeciv21:`make_land` function. The first input is a "normalized" height map where the tile heights range from 0 to 1000 and are spread uniformly in this range. This allows for @@ -209,7 +206,7 @@ frozen, cold, temperate, and tropical. The very first step taken by the algorithm is to reduce the height of terrain near the polar strips, if any. This prevents generating land next to them and -disconnects land from the poles. (``normalize_hmap_poles()``) +disconnects land from the poles. (:freeciv21:`normalize_hmap_poles`) Oceans and poles are generated next. Sea level is determined as the percentage of sea tiles, 100 minus the ``landmass`` server setting. Any tile with a low @@ -222,7 +219,7 @@ shapes. At this stage, all tiles above sea level are filled with a dummy land terrain. Having generated the "sea" poles, the lowering is reverted to allow for cold -land terrain in the area. (``renormalize_hmap_poles()``) +land terrain in the area. (:freeciv21:`renormalize_hmap_poles`) The temperature map is recomputed after creating oceans. In addition to the distance from the poles, it now takes other factors into account. High ground is @@ -232,7 +229,7 @@ simplified to four groups: frozen, cold, temperate, and tropical. In rulesets without frozen oceans, it may happen that the poles have still not been generated. They are marked back as land tiles by setting them to the -"unknown" terrain. (``make_polar_land()``) +"unknown" terrain. (:freeciv21:`make_polar_land`) The next step is to place relief, i.e. hills and mountains. This is again based on the height map: the highest land tiles become hills or mountains. The exact @@ -240,11 +237,12 @@ fraction of land tiles that will become a hill or mountain is governed by the ``steepness`` server setting. Large chunks of steep terrain are avoided by randomly converting only half of the tiles and not converting tiles that are significantly higher than one their neighbors. In addition to the above, steep -terrain is added in places that would otherwise be too flat. (``make_relief()``) +terrain is added in places that would otherwise be too flat. +(:freeciv21:`make_relief`) .. note:: The ``FRACTURE`` generator uses a different logic for placing hills. The - code is in ``make_fracture_relief()``. + code is in :freeciv21:`make_fracture_relief`. Once it is decided that a tile will be steep, it is set to hilly terrain if the tile is in the region of hot temperature, and mountains otherwise. About 70% of @@ -286,7 +284,8 @@ on the tile. The following combinations are generated one at a time: Terrain patches expand outwards from a seed tile until the required tile properties are no longer met or a threshold (*Thr.* in the table) in colatitude and height difference is reached. Ice, tundra, and plains/grassland are -generated to fill in gaps and do not expand in patches. (``make_terrains()``) +generated to fill in gaps and do not expand in patches. +(:freeciv21:`make_terrains`) The algorithm to match the desired terrain properties to the ruleset-defined terrain types by first collecting all terrains with the required property. Then, @@ -295,7 +294,7 @@ non-zero "avoided" property are removed from the set. Of the remaining terrains, one is picked at random, with a higher chance to be selected when the required property has a high value in the ruleset. If this search fails, it is resumed without the "preferred" property. If this fails again, the "avoided" property is -also dropped. (``pick_terrain()``) +also dropped. (:freeciv21:`pick_terrain`) .. _mapgen-height-rivers: @@ -308,7 +307,7 @@ there may not be a river in the area yet. The algorithm also tries to avoid springs in locations with many hills and mountains nearby, or in ice and deserts (according to the corresponding terrain properties: ``mountainous``, ``frozen``, ``dry``). The entry point to generate rivers is the -``make_rivers()`` function. +:freeciv21:`make_rivers` function. Once a spring is found, the river is flown from there one tile at a time. To decide which direction the river takes, the possible directions are tested in @@ -529,7 +528,7 @@ Starting positions are allocated using the chosen method. If a method fails, another method is tried in the following order: ``SINGLE``, ``2or3``, ``ALL``, and finally ``VARIABLE``. -The code is located in the ``create_start_positions()`` function. +The code is located in the :freeciv21:`create_start_positions` function. Placement tries to find fair starting positions using a "tile value" metric, computed as the sum of all outputs produced by the tile (food, production, and diff --git a/docs/Coding/network-protocol.rst b/docs/Coding/network-protocol.rst index a32df8e114..3b7f14a6a0 100644 --- a/docs/Coding/network-protocol.rst +++ b/docs/Coding/network-protocol.rst @@ -16,9 +16,9 @@ data and transported over the network. Packets ======= -The packets used in the protocol are defined in ``common/networking/packets.def``. Each packet has a type +The packets used in the protocol are defined in :file:`common/networking/packets.def`. Each packet has a type identifier (a number) and some fields. The packet definition file is parsed by -``common/generate_packets.py``, which generates a set of C++ functions to serialize them. +:file:`common/generate_packets.py`, which generates a set of C++ functions to serialize them. For each ``foo`` packet structure, there is one send and one receive function: .. code-block:: cpp @@ -29,14 +29,14 @@ For each ``foo`` packet structure, there is one send and one receive function: The :code:`send_packet_foo()` function serializes a structure into a bytestream and adds this to the send buffer in the connection struct. The :code:`receive_packet_foo()` function de-serializes a bytestream into a -structure and removes the bytestream from the input buffer in the connection struct. The connection struct is -defined in :file:`common/connection.h`. +structure and removes the bytestream from the input buffer in the connection struct. +The :freeciv21:`connection` struct is defined in :freeciv21:`connection.h`. Each structure field in a structure is serialized using architecture independent functions such as -:code:`dio_put_uint32()` and de-serialized with functions like :code:`dio_get_uint32()`. +:freeciv21:`dio_put_uint32_raw` and de-serialized with functions like :freeciv21:`dio_get_uint32_raw`. A packet is constituted by a header followed by the serialized structure data. The header contains the -following fields (the sizes are defined in :file:`common/packets.cpp`:code:`packet_header_set()`): +following fields (the sizes are defined in`:freeciv21:`packet_header_set`): .. code-block:: cpp @@ -46,7 +46,7 @@ following fields (the sizes are defined in :file:`common/packets.cpp`:code:`pack For backward compatibility reasons, packets used for the initial protocol (notably before checking the capabilities) have different header fields sizes as defined in -:file:`common/packets.c`:code:`packet_header_init()`: +:freeciv21:`packet_header_init`: .. code-block:: cpp @@ -139,9 +139,9 @@ There are 4 ways to solve this problem: #. We modify the client to deal with a fast server gracefully. We mitigated the problem by increasing the send buffer size on the server and making it dynamic. We also added -in strategic places in the code calls to a new :code:`flush_packets()` function that makes the server stall +in strategic places in the code calls to a new :freeciv21:`flush_packets` function that makes the server stall for some time draining the send buffers. Strategic places include whenever we send the whole map. The maximum -amount of time spent per :code:`flush_packets()` call is specified by the ``netwait`` variable. +amount of time spent per :freeciv21:`flush_packets` call is specified by the ``netwait`` variable. To disconnect unreachable clients, the server pings the client after a certain time elapses (set using the :literal:`pingtimeout` variable). If the client does not diff --git a/docs/Contributing/style-guide.rst b/docs/Contributing/style-guide.rst index d72a23f5ae..a5b8366263 100644 --- a/docs/Contributing/style-guide.rst +++ b/docs/Contributing/style-guide.rst @@ -112,6 +112,8 @@ to alter is placed inside back-ticks. to it like this: :literal:`:ref:`My Anchor``. Notice that the anchor has an underscore at the beginning. This is required for sphinx to recognize it. Also notice the use of the anchor in :literal:`:ref:` leaves the underscore off. +* :literal:`:freeciv21:` -- Creates a reference to a C++ code entity or file documended using + Doxygen, powered by :external+intersphinx:doc:`Intersphinx `. * :literal:`:numref:` -- Create a cross-reference to a named figure. * :literal:`:table:` -- Create a named table reference. Place an anchor (e.g. :literal:`.. _My Anchor:`) above to enable :literal:`:numref:`. @@ -119,6 +121,7 @@ to alter is placed inside back-ticks. above to enable :literal:`:numref:`. * :literal:`:emphasis:` -- Emphasis is used to :emphasis:`bring attention to something`. * :literal:`:file:` -- File is used for file names and paths such as :file:`~/.local/share/freeciv21/saves`. + For C++ source files, prefer ``:freeciv21:`` above. * :literal:`:guilabel:` -- GUI Label is used to bring attention to something on the screen like the :guilabel:`Next` button on the installer wizard. * :literal:`:literal:` -- Literal is used when you want to note a text element in its raw form. This is diff --git a/docs/conf.py b/docs/conf.py index 7a8fc8c04b..f08dacda2b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,6 +27,22 @@ except ImportError: has_updated_by_git = False +try: + import sphinxcontrib.doxylink.doxylink + # Standard doxylink fails to parse our tagfile. A fixed version exists in + # which Entry has a "matches" member. Check for this function to detect if + # we can use doxylink. To install the fixed version, create a virtualenv and + # activate it, then do: + # + # pip install git+https://github.com/lmoureaux/doxylink + # + # If building the documentation through CMake, you will need to run cmake + # from within the virtualenv. + sphinxcontrib.doxylink.doxylink.Entry.matches + tags.add('doxylink') +except (AttributeError, ImportError) as e: + print(e) + ... # -- Project information ----------------------------------------------------- @@ -63,6 +79,8 @@ extensions.append('sphinx_rtd_theme') if has_updated_by_git: extensions.append('sphinx_last_updated_by_git') +if 'doxylink' in tags: + extensions.append('sphinxcontrib.doxylink') # See https://github.com/readthedocs/recommonmark#linking-to-headings-in-other-files autosectionlabel_prefix_document = True @@ -229,9 +247,20 @@ # -- Options for intersphinx extension --------------------------------------- # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} +intersphinx_mapping = { + 'python': ('https://docs.python.org/3', None), + 'intersphinx': ('https://sphinxcontrib-doxylink.readthedocs.io/en/stable/', None), +} # -- Options for todo extension ---------------------------------------------- # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True + +# -- Options for doxylink extension ------------------------------------------ +# add_function_parentheses = False +doxylink_is_internal = True +doxylink = { + 'freeciv21': ('doxygen/tagfile.xml', + 'https://longturn.readthedocs.io/en/latest/Doxygen'), +} diff --git a/docs/requirements.txt b/docs/requirements.txt index fee8d36991..c6a2a6dd8a 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,6 @@ sphinx<7.2 # See #2023 sphinx_rtd_theme sphinx_last_updated_by_git + +# Optional: link Doxygen docs from sphinx +git+https://github.com/lmoureaux/doxylink diff --git a/server/rscompat.cpp b/server/rscompat.cpp index a9702d3d84..3d9cb1374c 100644 --- a/server/rscompat.cpp +++ b/server/rscompat.cpp @@ -1073,10 +1073,11 @@ void rscompat_postprocess(struct rscompat_info *info) } /** - * Adds req to all unit/city vision reqs, - * as compat for missing CAP_VUT_VISIONLAYER + * Adds `VisionLayer`, `Main`, `Local`, `True` req to all unit/city vision + * reqs, as compat for missing CAP_VUT_VISIONLAYER * - * @data is a struct rscompat_info *. + * @param peffect The effect to change. + * @param data A struct rscompat_info *. */ static bool rscompat_vision_effect_cb(struct effect *peffect, void *data) { diff --git a/server/scripting/script_server.cpp b/server/scripting/script_server.cpp index a2fd38182a..b3ae12f350 100644 --- a/server/scripting/script_server.cpp +++ b/server/scripting/script_server.cpp @@ -508,7 +508,7 @@ static void script_server_signals_create() /** Add server callback functions; these must be defined in the lua script - '/script.lua': + '[rulesetdir]/script.lua': respawn_callback (optional): - callback lua function for the respawn command diff --git a/server/stdinhand.cpp b/server/stdinhand.cpp index 5fe9f514a2..eaafa4e57c 100644 --- a/server/stdinhand.cpp +++ b/server/stdinhand.cpp @@ -2020,7 +2020,7 @@ static bool connectmsg_command(struct connection *caller, char *str, /** Translate an AI level back to its CMD_* value. - If we just used /set ailevel we wouldn't have to do this - rp + If we just used `/set ailevel ` we wouldn't have to do this - rp */ static enum command_id cmd_of_level(enum ai_level level) { @@ -2662,7 +2662,7 @@ static bool vote_command(struct connection *caller, char *str, bool check) } /** - Cancel a vote... /cancelvote |all. + Cancel a vote... /cancelvote (vote number)|all. */ static bool cancelvote_command(struct connection *caller, char *arg, bool check) diff --git a/utility/registry_ini.cpp b/utility/registry_ini.cpp index b55cd9914e..34f220b6f5 100644 --- a/utility/registry_ini.cpp +++ b/utility/registry_ini.cpp @@ -12,142 +12,148 @@ \____/ ********************************************************/ /** - \file - the idea with this file is to create something similar to the ms-windows - .ini files functions. - however the interface is nice. ie: - secfile_lookup_str(file, "player%d.unit%d.name", plrno, unitno); - - Description of the file format - ============================== - - (This is based on a format by the original authors, with - various incremental extensions. --dwp) - - - Whitespace lines are ignored, as are lines where the first - non-whitespace character is ';' (comment lines). - Optionally '#' can also be used for comments. - - - A line of the form: - *include "filename" - includes the named file at that point. (The '*' must be the - first character on the line.) The file is found by looking in - FREECIV_DATA_PATH. Non-infinite recursive includes are allowed. - - - A line with "[name]" labels the start of a section with - that name; one of these must be the first non-comment line in - the file. Any spaces within the brackets are included in the - name, but this feature (?) should probably not be used... - - - Within a section, lines have one of the following forms: - subname = "stringvalue" - subname = -digits - subname = digits - subname = TRUE - sunname = FALSE - for a value with given name and string, negative integer, and - positive integer values, respectively. These entries are - referenced in the following functions as "sectionname.subname". - The section name should not contain any dots ('.'); the subname - can, but they have no particular significance. There can be - optional whitespace before and/or after the equals sign. - You can put a newline after (but not before) the equals sign. - - Backslash is an escape character in strings (double-quoted strings - only, not names); recognised escapes are \n, \\, and \". - (Any other \ is just treated as .) - - - Gettext markings: You can surround strings like so: - foo = _("stringvalue") - The registry just ignores these extra markings, but this is - useful for marking strings for translations via gettext tools. - - - Multiline strings: Strings can have embeded newlines, eg: - foo = _(" - This is a string - over multiple lines - ") - This is equivalent to: - foo = _("\nThis is a string\nover multiple lines\n") - Note that if you missplace the trailing doublequote you can - easily end up with strange errors reading the file... - - - Strings read from a file: A file can be read as a string value: - foo = *filename.txt* - - - Vector format: An entry can have multiple values separated - by commas, eg: - foo = 10, 11, "x" - These are accessed by names "foo", "foo,1" and "foo,2" - (with section prefix as above). So the above is equivalent to: - foo = 10 - foo,1 = 11 - foo,2 = "x" - As in the example, in principle you can mix integers and strings, - but the calling program will probably require elements to be the - same type. Note that the first element of a vector is not "foo,0", - in order that the name of the first element is the same whether or - not there are subsequent elements. However as a convenience, if - you try to lookup "foo,0" then you get back "foo". (So you should - never have "foo,0" as a real name in the datafile.) - - - Tabular format: The lines: - foo = { "bar", "baz", "bax" - "wow", 10, -5 - "cool", "str" - "hmm", 314, 99, 33, 11 - } - are equivalent to the following: - foo0.bar = "wow" - foo0.baz = 10 - foo0.bax = -5 - foo1.bar = "cool" - foo1.baz = "str" - foo2.bar = "hmm" - foo2.baz = 314 - foo2.bax = 99 - foo2.bax,1 = 33 - foo2.bax,2 = 11 - The first line specifies the base name and the column names, and the - subsequent lines have data. Again it is possible to mix string and - integer values in a column, and have either more or less values - in a row than there are column headings, but the code which uses - this information (via the registry) may set more stringent conditions. - If a row has more entries than column headings, the last column is - treated as a vector (as above). You can optionally put a newline - after '=' and/or after '{'. - - The equivalence above between the new and old formats is fairly - direct: internally, data is converted to the old format. - In principle it could be a good idea to represent the data - as a table (2-d array) internally, but the current method - seems sufficient and relatively simple... - - There is a limited ability to save data in tabular: - So long as the section_file is constructed in an expected way, - tabular data (with no missing or extra values) can be saved - in tabular form. (See section_file_save().) - - - Multiline vectors: if the last non-comment non-whitespace - character in a line is a comma, the line is considered to - continue on to the next line. Eg: - foo = 10, - 11, - "x" - This is equivalent to the original "vector format" example above. - Such multi-lines can occur for column headings, vectors, or - table rows, again with some potential for strange errors... - - Hashing registry lookups - ======================== - - (by dwp) - - Have a hash table direct to entries, bypassing sections division. - - For convenience, store the key (the full section+entry name) - in the hash table (some memory overhead). - - The number of entries is fixed when the hash table is built. - - Now uses hash.c - */ + * \file + * the idea with this file is to create something similar to the ms-windows + * .ini files functions. + * however the interface is nice. ie: + * secfile_lookup_str(file, "player%d.unit%d.name", plrno, unitno); + * + * Description of the file format + * ============================== + * + * (This is based on a format by the original authors, with + * various incremental extensions. --dwp) + * + * - Whitespace lines are ignored, as are lines where the first + * non-whitespace character is ';' (comment lines). + * Optionally '#' can also be used for comments. + * + * - A line of the form: + * *include "filename" + * includes the named file at that point. (The '*' must be the + * first character on the line.) The file is found by looking in + * FREECIV_DATA_PATH. Non-infinite recursive includes are allowed. + * + * - A line with "[name]" labels the start of a section with + * that name; one of these must be the first non-comment line in + * the file. Any spaces within the brackets are included in the + * name, but this feature (?) should probably not be used... + * + * - Within a section, lines have one of the following forms: + * subname = "stringvalue" + * subname = -digits + * subname = digits + * subname = TRUE + * sunname = FALSE + * for a value with given name and string, negative integer, and + * positive integer values, respectively. These entries are + * referenced in the following functions as "sectionname.subname". + * The section name should not contain any dots ('.'); the subname + * can, but they have no particular significance. There can be + * optional whitespace before and/or after the equals sign. + * You can put a newline after (but not before) the equals sign. + * + * Backslash is an escape character in strings (double-quoted strings + * only, not names); recognised escapes are \\n, \\\\, and \\". + * (Any other \\\ is just treated as \.) + * + * - Gettext markings: You can surround strings like so: + * + * foo = _("stringvalue") + * + * The registry just ignores these extra markings, but this is + * useful for marking strings for translations via gettext tools. + * + * - Multiline strings: Strings can have embeded newlines, eg: + * + * foo = _(" + * This is a string + * over multiple lines + * ") + * + * This is equivalent to: + * + * foo = _("\\nThis is a string\\nover multiple lines\\n") + * + * Note that if you missplace the trailing doublequote you can + * easily end up with strange errors reading the file... + * + * - Strings read from a file: A file can be read as a string value: + * foo = *filename.txt* + * + * - Vector format: An entry can have multiple values separated + * by commas, eg: + * foo = 10, 11, "x" + * These are accessed by names "foo", "foo,1" and "foo,2" + * (with section prefix as above). So the above is equivalent to: + * foo = 10 + * foo,1 = 11 + * foo,2 = "x" + * As in the example, in principle you can mix integers and strings, + * but the calling program will probably require elements to be the + * same type. Note that the first element of a vector is not "foo,0", + * in order that the name of the first element is the same whether or + * not there are subsequent elements. However as a convenience, if + * you try to lookup "foo,0" then you get back "foo". (So you should + * never have "foo,0" as a real name in the datafile.) + * + * - Tabular format: The lines: + * foo = { "bar", "baz", "bax" + * "wow", 10, -5 + * "cool", "str" + * "hmm", 314, 99, 33, 11 + * } + * are equivalent to the following: + * foo0.bar = "wow" + * foo0.baz = 10 + * foo0.bax = -5 + * foo1.bar = "cool" + * foo1.baz = "str" + * foo2.bar = "hmm" + * foo2.baz = 314 + * foo2.bax = 99 + * foo2.bax,1 = 33 + * foo2.bax,2 = 11 + * The first line specifies the base name and the column names, and the + * subsequent lines have data. Again it is possible to mix string and + * integer values in a column, and have either more or less values + * in a row than there are column headings, but the code which uses + * this information (via the registry) may set more stringent conditions. + * If a row has more entries than column headings, the last column is + * treated as a vector (as above). You can optionally put a newline + * after '=' and/or after '{'. + * + * The equivalence above between the new and old formats is fairly + * direct: internally, data is converted to the old format. + * In principle it could be a good idea to represent the data + * as a table (2-d array) internally, but the current method + * seems sufficient and relatively simple... + * + * There is a limited ability to save data in tabular: + * So long as the section_file is constructed in an expected way, + * tabular data (with no missing or extra values) can be saved + * in tabular form. (See section_file_save().) + * + * - Multiline vectors: if the last non-comment non-whitespace + * character in a line is a comma, the line is considered to + * continue on to the next line. Eg: + * foo = 10, + * 11, + * "x" + * This is equivalent to the original "vector format" example above. + * Such multi-lines can occur for column headings, vectors, or + * table rows, again with some potential for strange errors... + * + * Hashing registry lookups + * ======================== + * + * (by dwp) + * - Have a hash table direct to entries, bypassing sections division. + * - For convenience, store the key (the full section+entry name) + * in the hash table (some memory overhead). + * - The number of entries is fixed when the hash table is built. + * - Now uses hash.c + **/ // KArchive #include diff --git a/utility/support.cpp b/utility/support.cpp index 736d4c7825..f3c77d12ce 100644 --- a/utility/support.cpp +++ b/utility/support.cpp @@ -141,9 +141,9 @@ void make_escapes(const char *str, char *buf, size_t buf_len) Copies a string. Backslash followed by a genuine newline always removes the newline. If full_escapes is TRUE: - - '\n' -> newline translation. - - Other '\c' sequences (any character 'c') are just passed - through with the '\' removed (eg, includes '\\', '\"'). + - `\\n` -> newline translation. + - Other `\\c` sequences (any character `c`) are just passed + through with the `\\` removed (eg, includes `\\`, `"`). See also make_escapes(). */ QString remove_escapes(const QString &str, bool full_escapes)