소스 검색

Added Doxygen configuration.
Also, thousands of small changes and fixes in code documentation.

Iñigo Valentin 3 년 전
부모
커밋
b3d9d8b15e
100개의 변경된 파일3738개의 추가작업 그리고 1053개의 파일을 삭제
  1. 2734 0
      Doxyfile
  2. 3 3
      V-Gears-Installer/include/DataInstaller.h
  3. 7 7
      V-Gears-Installer/include/FieldTextWriter.h
  4. 2 2
      V-Gears-Installer/include/MainWindow.h
  5. 3 3
      V-Gears-Installer/include/ModelsAndAnimationsDb.h
  6. 2 2
      V-Gears-Installer/include/VGearsUtility.h
  7. 10 10
      V-Gears-Installer/include/common/BinGZipFile.h
  8. 3 3
      V-Gears-Installer/include/common/BinaryReader.h
  9. 5 5
      V-Gears-Installer/include/common/DrawSkeleton.h
  10. 7 7
      V-Gears-Installer/include/common/FontFile.h
  11. 10 10
      V-Gears-Installer/include/common/Logger.h
  12. 1 1
      V-Gears-Installer/include/common/Lzs.h
  13. 10 10
      V-Gears-Installer/include/common/OgreBase.h
  14. 27 27
      V-Gears-Installer/include/common/OgreGenUtilites.h
  15. 14 14
      V-Gears-Installer/include/common/Surface.h
  16. 3 2
      V-Gears-Installer/include/common/TimToVram.h
  17. 16 16
      V-Gears-Installer/include/common/Vram.h
  18. 38 37
      V-Gears-Installer/include/decompiler/CodeGenerator.h
  19. 16 16
      V-Gears-Installer/include/decompiler/ControlFlow.h
  20. 9 9
      V-Gears-Installer/include/decompiler/DecompilerException.h
  21. 9 9
      V-Gears-Installer/include/decompiler/Disassembler.h
  22. 7 6
      V-Gears-Installer/include/decompiler/Engine.h
  23. 2 2
      V-Gears-Installer/include/decompiler/Function.h
  24. 21 21
      V-Gears-Installer/include/decompiler/Graph.h
  25. 7 7
      V-Gears-Installer/include/decompiler/LuaLanguage.h
  26. 2 2
      V-Gears-Installer/include/decompiler/ObjectFactory.h
  27. 2 2
      V-Gears-Installer/include/decompiler/RefCounted.h
  28. 12 11
      V-Gears-Installer/include/decompiler/ScriptFormatter.h
  29. 3 3
      V-Gears-Installer/include/decompiler/Stack.h
  30. 58 58
      V-Gears-Installer/include/decompiler/Value.h
  31. 37 37
      V-Gears-Installer/include/decompiler/field/FieldCodeGenerator.h
  32. 6 6
      V-Gears-Installer/include/decompiler/field/FieldDecompiler.h
  33. 43 44
      V-Gears-Installer/include/decompiler/field/FieldDisassembler.h
  34. 32 31
      V-Gears-Installer/include/decompiler/field/FieldEngine.h
  35. 13 13
      V-Gears-Installer/include/decompiler/field/FieldScriptFormatter.h
  36. 5 5
      V-Gears-Installer/include/decompiler/field/instruction/FieldBackgroundInstruction.h
  37. 5 5
      V-Gears-Installer/include/decompiler/field/instruction/FieldCameraInstruction.h
  38. 5 5
      V-Gears-Installer/include/decompiler/field/instruction/FieldCondJumpInstruction.h
  39. 13 13
      V-Gears-Installer/include/decompiler/field/instruction/FieldControlFlowInstruction.h
  40. 7 7
      V-Gears-Installer/include/decompiler/field/instruction/FieldMathInstruction.h
  41. 5 5
      V-Gears-Installer/include/decompiler/field/instruction/FieldMediaInstruction.h
  42. 15 15
      V-Gears-Installer/include/decompiler/field/instruction/FieldModelInstruction.h
  43. 9 9
      V-Gears-Installer/include/decompiler/field/instruction/FieldModuleInstruction.h
  44. 5 5
      V-Gears-Installer/include/decompiler/field/instruction/FieldNoOperationInstruction.h
  45. 5 5
      V-Gears-Installer/include/decompiler/field/instruction/FieldPartyInstruction.h
  46. 5 5
      V-Gears-Installer/include/decompiler/field/instruction/FieldUncategorizedInstruction.h
  47. 5 5
      V-Gears-Installer/include/decompiler/field/instruction/FieldUncondJumpInstruction.h
  48. 7 7
      V-Gears-Installer/include/decompiler/field/instruction/FieldWalkmeshInstruction.h
  49. 5 5
      V-Gears-Installer/include/decompiler/field/instruction/FieldWindowInstruction.h
  50. 4 3
      V-Gears-Installer/include/decompiler/instruction/BinaryOpStackInstruction.h
  51. 4 3
      V-Gears-Installer/include/decompiler/instruction/BoolNegateStackInstruction.h
  52. 4 3
      V-Gears-Installer/include/decompiler/instruction/DupStackInstruction.h
  53. 15 14
      V-Gears-Installer/include/decompiler/instruction/Instruction.h
  54. 5 4
      V-Gears-Installer/include/decompiler/instruction/KernelCallStackInstruction.h
  55. 4 3
      V-Gears-Installer/include/decompiler/instruction/ReturnInstruction.h
  56. 7 4
      V-Gears-Installer/include/decompiler/instruction/UnaryOpPostfixStackInstruction.h
  57. 7 4
      V-Gears-Installer/include/decompiler/instruction/UnaryOpPrefixStackInstruction.h
  58. 4 3
      V-Gears-Installer/include/decompiler/instruction/UncondJumpInstruction.h
  59. 7 7
      V-Gears-Installer/include/decompiler/world/WorldCodeGenerator.h
  60. 8 8
      V-Gears-Installer/include/decompiler/world/WorldDisassembler.h
  61. 7 7
      V-Gears-Installer/include/decompiler/world/WorldEngine.h
  62. 4 4
      V-Gears-Installer/include/decompiler/world/instruction/WorldBinaryEqualStackInstruction.h
  63. 5 5
      V-Gears-Installer/include/decompiler/world/instruction/WorldCondJumpInstruction.h
  64. 4 4
      V-Gears-Installer/include/decompiler/world/instruction/WorldKernelCallInstruction.h
  65. 4 4
      V-Gears-Installer/include/decompiler/world/instruction/WorldLoadBankInstruction.h
  66. 4 4
      V-Gears-Installer/include/decompiler/world/instruction/WorldLoadInstruction.h
  67. 4 4
      V-Gears-Installer/include/decompiler/world/instruction/WorldNoOutputInstruction.h
  68. 4 4
      V-Gears-Installer/include/decompiler/world/instruction/WorldStackInstruction.h
  69. 4 4
      V-Gears-Installer/include/decompiler/world/instruction/WorldStoreInstruction.h
  70. 4 4
      V-Gears-Installer/include/decompiler/world/instruction/WorldSubStackInstruction.h
  71. 4 4
      V-Gears-Installer/include/decompiler/world/instruction/WorldUncondJumpInstruction.h
  72. 62 62
      V-Gears-Installer/src/DataInstaller.cpp
  73. 8 8
      V-Gears-Installer/src/decompiler/ControlFlow.cpp
  74. 2 2
      V-Gears-Installer/src/decompiler/Disassembler.cpp
  75. 1 1
      V-Gears-Installer/src/decompiler/Engine.cpp
  76. 3 46
      V-Gears-Installer/src/decompiler/ScriptFormatter.cpp
  77. 0 17
      V-Gears-Installer/src/decompiler/field/FieldScriptFormatter.cpp
  78. 2 2
      V-Gears-Installer/src/main.cpp
  79. 1 1
      V-Gears/include/FF7Character.h
  80. 15 15
      V-Gears/include/common/File.h
  81. 11 11
      V-Gears/include/common/FileSystem.h
  82. 30 32
      V-Gears/include/common/FinalFantasy7/FF7NameLookup.h
  83. 11 11
      V-Gears/include/common/LzsFile.h
  84. 10 11
      V-Gears/include/common/VGearsApplication.h
  85. 15 15
      V-Gears/include/common/VGearsManualObject.h
  86. 9 12
      V-Gears/include/common/VGearsResource.h
  87. 6 6
      V-Gears/include/common/VGearsStringUtil.h
  88. 2 2
      V-Gears/include/core/Assert.h
  89. 6 6
      V-Gears/include/core/AudioManager.h
  90. 53 52
      V-Gears/include/core/Background2D.h
  91. 14 14
      V-Gears/include/core/Background2DAnimation.h
  92. 9 9
      V-Gears/include/core/CameraManager.h
  93. 7 7
      V-Gears/include/core/ConfigCmd.h
  94. 9 9
      V-Gears/include/core/ConfigCmdManager.h
  95. 12 12
      V-Gears/include/core/ConfigCmdManagerCommands.h
  96. 1 1
      V-Gears/include/core/ConfigFile.h
  97. 7 7
      V-Gears/include/core/ConfigVar.h
  98. 2 2
      V-Gears/include/core/ConfigVarManager.h
  99. 11 12
      V-Gears/include/core/Console.h
  100. 32 32
      V-Gears/include/core/DebugDraw.h

+ 2734 - 0
Doxyfile

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

+ 3 - 3
V-Gears-Installer/include/DataInstaller.h

@@ -48,9 +48,9 @@ class DataInstaller{
         /**
          * Installer constructor
          *
-         * @param input_dir[in] Path to the directory containing the original
+         * @param[in] input_dir Path to the directory containing the original
          * data to parse.
-         * @param output_dir[in] Path to the directory to write generated data
+         * @param[in] output_dir Path to the directory to write generated data
          * to.
          * @param write_output_line Pointer to function to write output.
          */
@@ -83,7 +83,7 @@ class DataInstaller{
         /**
          * Creates a directory in the outputh path.
          *
-         * @param dir[in] Path of the directory to create, relative to the
+         * @param[in] dir Path of the directory to create, relative to the
          * output path..
          * @throws std::runtime_error If the directory can't be created.
          */

+ 7 - 7
V-Gears-Installer/include/FieldTextWriter.h

@@ -32,16 +32,16 @@ class FieldTextWriter{
          *
          * Writes the  XML text section opening tag.
          *
-         * @param file_name[in] Path to the file to write te text to.
+         * @param[in] file_name Path to the file to write te text to.
          */
         void Begin(std::string file_name);
 
         /**
          * Writes text to the XML file.
          *
-         * @param script_section_buffer[in] The text data to write.
-         * @param field_name[in] The field of the text.
-         * @param english[in] True if the language to write is english.
+         * @param[in] script_section_buffer The text data to write.
+         * @param[in] field_name The field of the text.
+         * @param[in] english True if the language to write is english.
          */
         void Write(
           const std::vector<u8>& script_section_buffer, std::string field_name, bool english = true
@@ -59,14 +59,14 @@ class FieldTextWriter{
         /**
          * Adds text.
          *
-         * @param text[in] The text to add.
+         * @param[in] text The text to add.
          */
         void AddText(std::vector<unsigned char>& text);
 
         /**
          * Reads 16 bytes of data from the data (little endian).
          *
-         * @param offset[in] Offset at which to read.
+         * @param[in] offset Offset at which to read.
          * @return 16 bytes of data at the specified offset.
          * @throws std::out_of_range If the offset is out of the data.
          */
@@ -75,7 +75,7 @@ class FieldTextWriter{
         /**
          * Reads 8 bytes of data from the data.
          *
-         * @param offset[in] Offset at which to read.
+         * @param[in] offset Offset at which to read.
          * @return 8 bytes of data at the specified offset.
          * @throws std::out_of_range If the offset is out of the data.
          */

+ 2 - 2
V-Gears-Installer/include/MainWindow.h

@@ -33,7 +33,7 @@ class MainWindow : public QMainWindow{
         /**
          * Constructor.
          *
-         * @param parent[in] Widget to be made parent of the window.
+         * @param[in] parent Widget to be made parent of the window.
          */
         explicit MainWindow(QWidget *parent = 0);
 
@@ -119,7 +119,7 @@ class MainWindow : public QMainWindow{
         /**
          * Enables or disables the UI.
          *
-         * @param enable[in] True to enable the UI, false to disable it.
+         * @param[in] enable True to enable the UI, false to disable it.
          */
         void EnableUi(bool enable);
 

+ 3 - 3
V-Gears-Installer/include/ModelsAndAnimationsDb.h

@@ -32,7 +32,7 @@ class ModelsAndAnimationsDb{
          * Generates a normalized file name, without path, lowercase, and an
          * '.a' extension.
          *
-         * @param name[in] Current name.
+         * @param[in] name Current name.
          * @return The normalized name.
          */
         std::string NormalizeAnimationName(const std::string& name);
@@ -40,7 +40,7 @@ class ModelsAndAnimationsDb{
         /**
          * @todo Understand and document.
          *
-         * @param model[in] @todo Understand and document.
+         * @param[in] model @todo Understand and document.
          * @return @todo Understand and document.
          */
         std::set<std::string>& ModelAnimations(const std::string model);
@@ -48,7 +48,7 @@ class ModelsAndAnimationsDb{
         /**
          * Retrieves the metadata file name associated to a model.
          *
-         * @param model_name[in] The model name.
+         * @param[in] model_name The model name.
          * @return Name of the metadata file.
          */
         std::string ModelMetaDataName(const std::string& model_name);

+ 2 - 2
V-Gears-Installer/include/VGearsUtility.h

@@ -30,8 +30,8 @@ namespace VGears{
             /**
              * Constructor.
              *
-             * @param argc[in] Number of arguments passed to the application.
-             * @param argv[in] List of arguments passed to the application.
+             * @param[in] argc Number of arguments passed to the application.
+             * @param[in] argv List of arguments passed to the application.
              */
             Utility(int argc, char *argv[]);
 

+ 10 - 10
V-Gears-Installer/include/common/BinGZipFile.h

@@ -27,32 +27,32 @@ class BinGZipFile : public File{
         /**
          * Constructor.
          *
-         * @param file[in] Path to the BIN file.
+         * @param[in] file Path to the BIN file.
          */
         BinGZipFile(const Ogre::String& file);
 
         /**
          * Constructor.
          *
-         * @param file[in] The BIN file.
+         * @param[in] file The BIN file.
          */
         BinGZipFile(File* file);
 
         /**
          * Constructor.
          *
-         * @param file[in] The BIN file.
-         * @param offset[in] The offset at which to start reading the file.
-         * @param length[in] Length of the data to read.
+         * @param[in] file The BIN file.
+         * @param[in] offset The offset at which to start reading the file.
+         * @param[in] length Length of the data to read.
          */
         BinGZipFile(File* file, u32 offset, u32 length);
 
         /**
          * Constructor.
          *
-         * @param buffer[in] Buffer with the contents of the BIN file.
-         * @param offset[in] The offset at which to start reading the file.
-         * @param length[in] Length of the data to read.
+         * @param[in] buffer Buffer with the contents of the BIN file.
+         * @param[in] offset The offset at which to start reading the file.
+         * @param[in] length Length of the data to read.
          */
         BinGZipFile(u8* buffer, u32 offset, u32 length);
 
@@ -64,7 +64,7 @@ class BinGZipFile : public File{
         /**
          * Extracts a file from the compressed BIN file.
          *
-         * @param file_index[in] The index of the file to extract.
+         * @param[in] file_index The index of the file to extract.
          * @return The extracted file, or NULL if there is no file at the
          * specified index.
          */
@@ -87,7 +87,7 @@ class BinGZipFile : public File{
         /**
          * Retrieves a file offset.
          *
-         * @param file_index[in] The file which offset to calculate.
+         * @param[in] file_index The file which offset to calculate.
          * @return The offset to the specified file, or 0 if there is no such
          * file.
          */

+ 3 - 3
V-Gears-Installer/include/common/BinaryReader.h

@@ -31,7 +31,7 @@ class BinaryReader{
         /**
          * Reads a file, from start to end.
          *
-         * @oaram file_name[in] Path and name of the file to read.
+         * @param[in] file_name Path and name of the file to read.
          * @return Read bytes.
          * @throws std::runtime_error if the file can't be opened for reading.
          */
@@ -50,7 +50,7 @@ class BinaryReader{
         /**
          * Constructor.
          *
-         * @param data[in] Bytes for the reader
+         * @param[in] data Bytes for the reader
          */
         BinaryReader(std::vector<unsigned char>&& data){
             size_ = data.size();
@@ -68,7 +68,7 @@ class BinaryReader{
         /**
          * Moves the stream cursor.
          *
-         * @param position[in] Position (offset) of the cursor.
+         * @param[in] position Position (offset) of the cursor.
          * @throws DecompilerException if the position is invalid.
          */
         void Seek(unsigned int position){

+ 5 - 5
V-Gears-Installer/include/common/DrawSkeleton.h

@@ -43,17 +43,17 @@ typedef std::vector<Bone> Skeleton;
 /**
  * Draws a skeleton.
  *
- * @param skeleton[in] The skeleton to draw.
- * @param mesh[in] Parent mesh for the skeleton.
+ * @param[in] skeleton The skeleton to draw.
+ * @param[in] mesh Parent mesh for the skeleton.
  */
 void DrawSkeleton(const Skeleton& skeleton, const Ogre::MeshPtr& mesh);
 
 /**
  * Draws a bone.
  *
- * @param skeleton[in] Skeleton the bone belongs to.
- * @param parent_index[in] The parent bone ID.
- * @param colours[in] Colour for the bone.
+ * @param[in] skeleton Skeleton the bone belongs to.
+ * @param[in] parent_index The parent bone ID.
+ * @param[in] colours Colour for the bone.
  */
 void DrawBone(const Skeleton& skeleton, int parent_index, Ogre::RGBA* colours);
 

+ 7 - 7
V-Gears-Installer/include/common/FontFile.h

@@ -30,25 +30,25 @@ class FontFile : public File{
         /**
          * Constructor.
          *
-         * @param file[in] The font file.
+         * @param[in] file The font file.
          */
         explicit  FontFile(File* file);
 
         /**
          * Constructor.
          *
-         * @param file[in] The font file.
-         * @param offset[in] The offset at which to start reading the file.
-         * @param length[in] Length of the data to read.
+         * @param[in] file The font file.
+         * @param[in] offset The offset at which to start reading the file.
+         * @param[in] length Length of the data to read.
          */
         FontFile(File* file, const u32& offset, const u32& length);
 
         /**
          * Constructor.
          *
-         * @param file[in] Buffer with the contents of the font file.
-         * @param offset[in] The offset at which to start reading the file.
-         * @param length[in] Length of the data to read.
+         * @param[in] buffer Buffer with the contents of the font file.
+         * @param[in] offset The offset at which to start reading the file.
+         * @param[in] length Length of the data to read.
          */
         FontFile(u8* buffer, const u32& offset, const u32& length);
 

+ 10 - 10
V-Gears-Installer/include/common/Logger.h

@@ -21,9 +21,9 @@
 /**
  * Converts an hexadecimal value to a string.
  *
- * @param value[in] The value to convert.
- * @param width[in] Word width.
- * @param fill[in] Filling character for word alignment.
+ * @param[in] value The value to convert.
+ * @param[in] width Word width.
+ * @param[in] fill Filling character for word alignment.
  * @return String representation of the value.
  */
 Ogre::String HexToString(int value, unsigned short width, char fill);
@@ -31,7 +31,7 @@ Ogre::String HexToString(int value, unsigned short width, char fill);
 /**
  * Converts a boolean value to a string.
  *
- * @param value[in] The value to convert.
+ * @param[in] value The value to convert.
  * @return String representation of the value. 'true' if the value is true,
  * 'false' otherwise.
  */
@@ -40,7 +40,7 @@ Ogre::String BoolToString(bool value);
 /**
  * Converts an integer value to a string.
  *
- * @param value[in] The value to convert.
+ * @param[in] value The value to convert.
  * @return String representation of the value.
  */
 Ogre::String IntToString(int value);
@@ -48,7 +48,7 @@ Ogre::String IntToString(int value);
 /**
  * Converts a real value to a string.
  *
- * @param value[in] The value to convert.
+ * @param[in] value The value to convert.
  * @return String representation of the value.
  */
 Ogre::String FloatToString(float value);
@@ -63,7 +63,7 @@ class Logger{
         /**
          * Constructor.
          *
-         * @param log_file_name[in] Path to the log file.
+         * @param[in] log_file_name Path to the log file.
          */
         explicit Logger(const Ogre::String& log_file_name);
 
@@ -75,21 +75,21 @@ class Logger{
         /**
          * Logs a message.
          *
-         * @param text[in] Message to log.
+         * @param[in] text Message to log.
          */
         void Log(const Ogre::String& text);
 
         /**
          * Logs a message.
          *
-         * @param text[in] Message to log.
+         * @param[in] text Message to log.
          */
         void LogW(const Ogre::UTFString& text);
 
         /**
          * Logs messages.
          *
-         * @param text[in] Messages to log.
+         * @param[in] text Messages to log.
          */
         void Log(std::vector<unsigned char>& text);
 

+ 1 - 1
V-Gears-Installer/include/common/Lzs.h

@@ -20,7 +20,7 @@ namespace Lzs{
     /**
      * Decompresses LZS data.
      *
-     * @param compressed[in] Compressed data.
+     * @param[in] compressed Compressed data.
      * @return Decompressed data.
      */
     inline std::vector<unsigned char> Decompress(const std::vector<unsigned char>& compressed){

+ 10 - 10
V-Gears-Installer/include/common/OgreBase.h

@@ -68,7 +68,7 @@ class DisplayFrameListener :
         /**
          * Constructor.
          *
-         * @param win[in] The render window. Used to determine input context.
+         * @param[in] win The render window. Used to determine input context.
          */
         DisplayFrameListener(Ogre::RenderWindow* win):
           window_(win), input_manager_(0), keyboard_(0),
@@ -128,7 +128,7 @@ class DisplayFrameListener :
          * This event happens before any render targets have begun updating.
          * It captures input events and checks the state of entities.
          *
-         * @param evt[in] Triggering event. Unused.
+         * @param[in] evt Triggering event. Unused.
          * @return True to go ahead, false to abort rendering and drop out of
          * the rendering loop.
          */
@@ -187,7 +187,7 @@ class DisplayFrameListener :
          *
          * Parses keyboard events.
          *
-         * @param event[in] Triggering event.
+         * @param[in] e Triggering event.
          * @return Always true
          */
         bool keyPressed(const OIS::KeyEvent& e){
@@ -283,7 +283,7 @@ class DisplayFrameListener :
          *
          * It does nothing.
          *
-         * @param e[in] Triggering event.
+         * @param[in] e Triggering event.
          * @return Always true.
          */
         bool keyReleased(const OIS::KeyEvent& e){return true;}
@@ -291,7 +291,7 @@ class DisplayFrameListener :
         /**
          * Handles mouse movement events.
          *
-         * @param e[in] Triggering event.
+         * @param[in] e Triggering event.
          * @return Always true.
          */
         bool mouseMoved(const OIS::MouseEvent& e){
@@ -303,8 +303,8 @@ class DisplayFrameListener :
         /**
          * Handles mouse button-down events.
          *
-         * @param e[in] Triggering event.
-         * @param id[in] Button ID.
+         * @param[in] e Triggering event.
+         * @param[in] id Button ID.
          * @return Always true.
          */
         bool mousePressed(const OIS::MouseEvent& e, OIS::MouseButtonID id){
@@ -315,8 +315,8 @@ class DisplayFrameListener :
         /**
          * Handles mouse button-up events.
          *
-         * @param e[in] Triggering event.
-         * @param id[in] Button ID.
+         * @param[in] e Triggering event.
+         * @param[in] id Button ID.
          * @return Always true.
          */
         bool mouseReleased(const OIS::MouseEvent& e, OIS::MouseButtonID id){
@@ -390,7 +390,7 @@ class DisplayFrameListener :
 /**
  * Initializes the Ogre system.
  *
- * @param name[in] Application title.
+ * @param[in] name Application title.
  */
 void InitializeOgreBase(const Ogre::String& name);
 

+ 27 - 27
V-Gears-Installer/include/common/OgreGenUtilites.h

@@ -107,7 +107,7 @@ struct TexForGen{
      * It compares texture coordinates, palette coordinates and colour BPP
      * modes.
      *
-     * @param i[in] Texture to compare this one with
+     * @param[in] i Texture to compare this one with
      * @return True if the texture coordinates, palette coordinates and colour
      * BPP modes of both textures are equal, false otherwise.
      */
@@ -126,10 +126,10 @@ typedef std::vector< TexForGen > VectorTexForGen;
 /**
  * Creates a texture from video memory and saves it to a file.
  *
- * @param vram[in] Memory block to load the texture from.
- * @param mesh_data[in] Information about the mesh the texture is assigned to.
- * @param texture_file_name[in] Path to the texture file to save.
- * @parm textures[in] @todo It's used to get some coordinates, but for what?
+ * @param[in] vram Memory block to load the texture from.
+ * @param[in] mesh_data Information about the mesh the texture is assigned to.
+ * @param[in] texture_file_name Path to the texture file to save.
+ * @param[in] textures @todo It's used to get some coordinates, but for what?
  */
 void CreateTexture(
   Vram* vram, const MeshData& mesh_data,
@@ -137,13 +137,13 @@ void CreateTexture(
 );
 
 /**
- * Creates a material from video memory and saves it to a file.
+ * Creates a material and saves it to a file.
  *
- * @param vram[in] Memory block to load the material from.
- * @param texture_file_name[in] Path to the texture file to save.
- * @param texture_name[in] Name of the texture to assign to the material.
- * @param vertex_program[in] @todo Understand and document. Can be empty.
- * @param fragment_program[in] @todo Understand and document. Can be empty.
+ * @param[in] material_name The material name.
+ * @param[in] material_file_name Path to the material file to save.
+ * @param[in] texture_name Name of the texture to assign to the material.
+ * @param[in] vertex_program @todo Understand and document. Can be empty.
+ * @param[in] fragment_program @todo Understand and document. Can be empty.
  */
 void CreateMaterial(
   const Ogre::String& material_name, const Ogre::String& material_file_name,
@@ -154,16 +154,16 @@ void CreateMaterial(
 /**
  * Creates a material from video memory and adds it to the texture list.
  *
- * @param pixel_box[in] Texture image descriptor.
- * @param vram[in] Memory block to load the material from.
- * @param start_x[in] X coordinate for the texture.
- * @param start_y[in] Y coordinate for the texture.
- * @param clut_x[in] X coordinate for the texture CLUT.
- * @param clut_y[in] Y coordinate for the texture CLUT.
- * @param texture_x[in] X coordinate for the texture.
- * @param texture_y[in] Y coordinate for the texture.
- * @param bpp[in] BPP mode for the texture colour.
- * @param transparency[in] Indicates if the texture has transparencies.
+ * @param[in] pixel_box Texture image descriptor.
+ * @param[in] vram Memory block to load the material from.
+ * @param[in] start_x X coordinate for the texture.
+ * @param[in] start_y Y coordinate for the texture.
+ * @param[in] clut_x X coordinate for the texture CLUT.
+ * @param[in] clut_y Y coordinate for the texture CLUT.
+ * @param[in] texture_x X coordinate for the texture.
+ * @param[in] texture_y Y coordinate for the texture.
+ * @param[in] bpp BPP mode for the texture colour.
+ * @param[in] transparency Indicates if the texture has transparencies.
  * @todo What's the difference between start_x/start_y and texture_x/texture_y?
  */
 void CreateTextureFromVram(
@@ -175,10 +175,10 @@ void CreateTextureFromVram(
 /**
  * Adds a texture to the list.
  *
- * @param texture[in] Texture information/
- * @param data[in] Mesh information.
- * @param textures[in|out] The texture will be added to this list.
- * @param logger[in] Custom logger to print info about the process. It can be
+ * @param[in] texture Texture information.
+ * @param[in] data Mesh information.
+ * @param[in,out] textures The texture will be added to this list.
+ * @param[in] logger Custom logger to print info about the process. It can be
  * NULL, but then nothing will be printed.
  */
 void AddTexture(
@@ -188,8 +188,8 @@ void AddTexture(
 /**
  * Adds or removes a transparency to a colour.
  *
- * @param colour[in|out] The colour to add or remove the transparency to.
- * @param transparency[in] True to add transparency, false to remove it.
+ * @param[in,out] colour The colour to add or remove the transparency to.
+ * @param[in] transparency True to add transparency, false to remove it.
  * @param stp @todo Understand and document.
  */
 void AddTransparency(u32& colour, const bool transparency, const bool stp);

+ 14 - 14
V-Gears-Installer/include/common/Surface.h

@@ -72,8 +72,8 @@ struct Surface{
 /**
  * Creates an empty surface
  *
- * @param width[in] The width for the new surface.
- * @param height[in] The height for the new surface.
+ * @param[in] width The width for the new surface.
+ * @param[in] height The height for the new surface.
  */
 Surface* CreateSurface(const int width, const int height);
 
@@ -82,10 +82,10 @@ Surface* CreateSurface(const int width, const int height);
  *
  * It can copy just sections of surfaces, but always from the top left corner.
  *
- * @param dest[out] The target surface.
- * @param x_d[in] Number of columns to copy.
- * @param y_d[in] Number of rows to copy.
- * @param src[in] The source surface.
+ * @param[out] dest The target surface.
+ * @param[in] x_d Number of columns to copy.
+ * @param[in] y_d Number of rows to copy.
+ * @param[in] src The source surface.
  *
  */
 void CopyToSurface(Surface* dest, const int x_d, const int y_d, Surface* src);
@@ -93,11 +93,11 @@ void CopyToSurface(Surface* dest, const int x_d, const int y_d, Surface* src);
 /**
  * Creates a partial surface from a surface.
  *
- * @param x[in] Starting column to copy from the original surface.
- * @param y[in] Starting row to copy from the original surface.
- * @param width[in] Number of columns to copy.
- * @param height[in] Number of rows to copy.
- * @param surface[in] The original surface.
+ * @param[in] x Starting column to copy from the original surface.
+ * @param[in] y Starting row to copy from the original surface.
+ * @param[in] width Number of columns to copy.
+ * @param[in] height Number of rows to copy.
+ * @param[in] surface The original surface.
  * @return the resulting subsurface.
  */
 Surface* CreateSubSurface(
@@ -107,9 +107,9 @@ Surface* CreateSubSurface(
 /**
  * Creates a surface from a list of pixels.
  *
- * @param width[in] The width of the surface.
- * @param height[in] The height of the surface.
- * @param pixels[in] The list of pixels for the new surface. If there are not
+ * @param[in] width The width of the surface.
+ * @param[in] height The height of the surface.
+ * @param[in] pixels The list of pixels for the new surface. If there are not
  * enough pixels to cover the entire surface, the rest of pixels will be NULL.
  * @return The new surface.
  */

+ 3 - 2
V-Gears-Installer/include/common/TimToVram.h

@@ -22,7 +22,8 @@ class File;
 /**
  * Loads a TIM image file into an VRAM block.
  *
- * @param file[in] The TIM file to load.
- * @param vram[out] The VRAM block to load the image to.
+ * @param[in] file The TIM file to load.
+ * @param[in] tim_offset Offset of the TIM file.
+ * @param[out] vram The VRAM block to load the image to.
  */
 void LoadTimFileToVram(File* file, int tim_offset, Vram* vram);

+ 16 - 16
V-Gears-Installer/include/common/Vram.h

@@ -57,7 +57,7 @@ class Vram{
         /**
          * Saves the contents of the VRAM block to a file.
          *
-         * @param file[in] Path to the file to save.
+         * @param[in] file Path to the file to save.
          */
         void Save(const Ogre::String& file);
 
@@ -65,28 +65,28 @@ class Vram{
         /**
          * Adds an image buffer to an existing buffer.
          *
-         * @param x[in] X coordinate for the start of the image buffer.
-         * @param y[in] Y coordinate for the start of the image buffer.
-         * @param width[in] Width of the image buffer.
-         * @param height[in] Height of the image buffer.
-         * @param buffer[out] The buffer to add the image buffer to.
+         * @param[in] x X coordinate for the start of the image buffer.
+         * @param[in] y Y coordinate for the start of the image buffer.
+         * @param[in] width Width of the image buffer.
+         * @param[in] height Height of the image buffer.
+         * @param[out] buffer The buffer to add the image buffer to.
          */
         void AddImageBuffer(u16 x, u16 y, u16 width, u16 height, u8* buffer);
 
         /**
          * Writes 8 bytes to the VRAM block.
          *
-         * @param x[in] X coordinate of the block where to write.
-         * @param y[in] Y coordinate of the block where to write.
-         * @param byte[in] The data to write.
+         * @param[in] x X coordinate of the block where to write.
+         * @param[in] y Y coordinate of the block where to write.
+         * @param[in] byte The data to write.
          */
         void PutU8(u16 x, u16 y, u8 byte);
 
         /**
          * Reads 8 bytes from the VRAM block.
          *
-         * @param x[in] X coordinate of the block where to read.
-         * @param y[in] Y coordinate of the block where to read.
+         * @param[in] x X coordinate of the block where to read.
+         * @param[in] y Y coordinate of the block where to read.
          * @return The read bytes.
          */
         u8 GetU8(u16 x, u16 y) const;
@@ -94,17 +94,17 @@ class Vram{
         /**
          * Writes 16 bytes to the VRAM block.
          *
-         * @param x[in] X coordinate of the block where to write.
-         * @param y[in] Y coordinate of the block where to write.
-         * @param byte[in] The data to write.
+         * @param[in] x X coordinate of the block where to write.
+         * @param[in] y Y coordinate of the block where to write.
+         * @param[in] bytes The data to write.
          */
         void PutU16(u16 x, u16 y, u16 bytes);
 
         /**
          * Reads 16 bytes from the VRAM block.
          *
-         * @param x[in] X coordinate of the block where to read.
-         * @param y[in] Y coordinate of the block where to read.
+         * @param[in] x X coordinate of the block where to read.
+         * @param[in] y Y coordinate of the block where to read.
          * @return The read bytes.
          */
         u16 GetU16(u16 x, u16 y) const;

+ 38 - 37
V-Gears-Installer/include/decompiler/CodeGenerator.h

@@ -62,10 +62,10 @@ class CodeGenerator {
         /**
          * Constructor
          *
-         * @param engine[in] The engine used for the script.
-         * @param output[out] The stream to output the code to.
-         * @param bin_order[in] Order of arguments for binary operators.
-         * @param call_order[in] Order of arguments for function calls.
+         * @param[in] engine The engine used for the script.
+         * @param[out] output The stream to output the code to.
+         * @param[in] bin_order Order of arguments for binary operators.
+         * @param[in] call_order Order of arguments for function calls.
          */
         CodeGenerator(
           Engine *engine, std::ostream &output, ARGUMENT_ORDER bin_order, ARGUMENT_ORDER call_order
@@ -86,11 +86,11 @@ class CodeGenerator {
         /**
          * Writes a function call.
          *
-         * @param function_name[in] The name of the function.
-         * @param param_format[in] Characters indicating the parameter format.
+         * @param[in] function_name The name of the function.
+         * @param[in] param_format Characters indicating the parameter format.
          * 'b' for boolean parameters, 'n' for integers (treated as unsigned)
          * or 'f' for floats.
-         * @param params[in] The list of parameters.
+         * @param[in] params The list of parameters.
          */
         void WriteFunctionCall(
           std::string function_name, std::string param_format, const std::vector<ValuePtr>& params
@@ -99,18 +99,18 @@ class CodeGenerator {
         /**
          * Generates code from the provided graph and outputs it to stdout.
          *
-         * @param insts[in] The list of instructions.
-         * @param graph[in] The annotated graph of the script.
+         * @param[in] insts The list of instructions.
+         * @param[in] graph The annotated graph of the script.
          */
         virtual void Generate(InstVec& insts, const Graph &graph);
 
         /**
          * Adds a line of code to the current group.
          *
-         * @param line[in] The line to add.
-         * @param unindent_before[in] Whether or not to remove an indentation
+         * @param[in] line The line to add.
+         * @param[in] unindent_before Whether or not to remove an indentation
          * level before the line. Defaults to false.
-         * @param indent_after[in] Whether or not to add an indentation level
+         * @param[in] indent_after Whether or not to add an indentation level
          * after the line. Defaults to false.
          */
         virtual void AddOutputLine(
@@ -120,34 +120,33 @@ class CodeGenerator {
         /**
          * Writes a comment line indicating an unimplemented opcode.
          *
-         * @param code_gen[in|out] The code generator.
-         * @param class_name[in] The class where the instruction is. Unused.
-         * @param instruction[in] The unimplemented instruction.
+         * @param[in] class_name The class where the instruction is. Unused.
+         * @param[in] instruction The unimplemented instruction.
          */
         void WriteTodo(std::string class_name, std::string instruction);
 
         /**
          * Generate an assignment statement.
          *
-         * @param dst[in] The variable being assigned to.
-         * @param src[in] The value being assigned.
+         * @param[in] dst The variable being assigned to.
+         * @param[in] src The value being assigned.
          */
         void WriteAssignment(ValuePtr dst, ValuePtr src);
 
         /**
          * Add an argument to the argument list.
          *
-         * @param arg[in] The argument to add.
+         * @param[in] arg The argument to add.
          */
         void AddArg(ValuePtr arg);
 
         /**
          * Process a single character of metadata.
          *
-         * @param inst[in] The instruction being processed. Unused.
-         * @param c[in] The character signifying the action to be taken. The
+         * @param[in] inst The instruction being processed. Unused.
+         * @param[in] c The character signifying the action to be taken. The
          * only valid one is 'p'.
-         * @param pos[in] The position at which c occurred in the metadata.
+         * @param[in] pos The position at which c occurred in the metadata.
          * Unused.
          */
         virtual void ProcessSpecialMetadata(const InstPtr inst, char c, int pos);
@@ -174,9 +173,9 @@ class CodeGenerator {
          * handled by an implemented engine, or where the base class
          * implementation is preferable.
          *
-         * @param function[in] The function the instruction is is.
-         * @param inst[in] The instruction to process.
-         * @param insts[in] Every instruction in the function.
+         * @param[in] function The function the instruction is is.
+         * @param[in] inst The instruction to process.
+         * @param[in] insts Every instruction in the function.
          */
         void ProcessInst(Function& function, InstVec& insts, const InstPtr inst);
 
@@ -186,9 +185,9 @@ class CodeGenerator {
          * implementation for opcodes not handled by an implemented engine,
          * or where the base class implementation is preferable.
          *
-         * @param function[in] The function the instruction is is.
-         * @param inst[in] The instruction to process.
-         * @param insts[in] Every instruction in the function.
+         * @param[in] function The function the instruction is is.
+         * @param[in] inst The instruction to process.
+         * @param[in] insts Every instruction in the function.
          */
         void ProcessUncondJumpInst(Function& function, InstVec& insts, const InstPtr inst);
 
@@ -198,14 +197,14 @@ class CodeGenerator {
          * implementation for opcodes not handled by an implemented engine,
          * or where the base class implementation is preferable.
          *
-         * @param inst[in] The instruction to process.
+         * @param[in] inst The instruction to process.
          */
         void ProcessCondJumpInst(const InstPtr inst);
 
         /**
          * Indents a string according to the current indentation level.
          *
-         * @param s[in] The string to indent.
+         * @param[in] s The string to indent.
          * @result The indented string.
          */
         std::string IndentString(std::string s);
@@ -213,7 +212,7 @@ class CodeGenerator {
         /**
          * Construct the signature for a function.
          *
-         * @param function[in] Reference to the function to construct the
+         * @param[in] function Reference to the function to construct the
          * signature for.
          * @return For this base class, an empty string.
          */
@@ -225,7 +224,7 @@ class CodeGenerator {
          * Called before writing a function start. For this base class, it
          * does nothing.
          *
-         * @param function[in] The function about to start.
+         * @param[in] function The function about to start.
          */
         virtual void OnBeforeStartFunction(const Function& function);
 
@@ -235,7 +234,7 @@ class CodeGenerator {
          * Called after writing a function. For this base class, it adds a
          * closing bracer "}".
          *
-         * @param function[in] The function about to end.
+         * @param[in] function The function about to end.
          */
         virtual void OnEndFunction(const Function& function);
 
@@ -245,7 +244,7 @@ class CodeGenerator {
          * Called after writing a function start. For this base class, it
          * does nothing.
          *
-         * @param function[in] The function starting.
+         * @param[in] function The function starting.
          */
         virtual void OnStartFunction(const Function& function);
 
@@ -259,11 +258,11 @@ class CodeGenerator {
         /**
          * Generates a pass.
          *
-         * @param insts[in] The list of instructions.
-         * @param graph[in] The code graph.
+         * @param[in] insts The list of instructions.
+         * @param[in] graph The code graph.
          * @todo Understand and explain.
          */
-        void GeneratePass(InstVec& insts, const Graph& g);
+        void GeneratePass(InstVec& insts, const Graph& graph);
 
         /**
          * Indicates if a label is being processed.
@@ -310,7 +309,9 @@ class CodeGenerator {
         /**
          * Processes a GraphVertex.
          *
-         * @param vertex[in] The vertex to process.
+         * @param[in] function The function to process.
+         * @param[in] insts The list of instructions.
+         * @param[in] vertex The vertex to process.
          */
         void Process(Function& function, InstVec& insts, GraphVertex vertex);
 

+ 16 - 16
V-Gears-Installer/include/decompiler/ControlFlow.h

@@ -28,22 +28,22 @@ class ControlFlow {
         /**
          * Constructor for the control flow graph.
          *
-         * @param insts[in] The instructions to analyze control flow for.
-         * @param engine[in] Pointer to the Engine used for the script.
+         * @param[in] insts The instructions to analyze control flow for.
+         * @param[in] engine Pointer to the Engine used for the script.
          */
         ControlFlow(InstVec& insts, Engine& engine);
 
         /**
          * Copy constructor disabled.
          *
-         * @param control_flow[in] The control flow to copy.
+         * @param[in] control_flow The control flow to copy.
          */
         ControlFlow(const ControlFlow& control_flow) = delete;
 
         /**
          * Copy constructor disabled.
          *
-         * @param control_flow[in] The control flow to copy.
+         * @param[in] control_flow The control flow to copy.
          */
         ControlFlow& operator = (const ControlFlow& control_flow) = delete;
 
@@ -98,21 +98,21 @@ class ControlFlow {
         /**
          * Finds a graph vertex through an instruction.
          *
-         * @param inst[in] The instruction to find the vertex for.
+         * @param[in] inst The instruction to find the vertex for.
          */
         GraphVertex Find(const InstPtr inst);
 
         /**
          * Finds a graph vertex through an instruction iterator.
          *
-         * @param it[in] The iterator to find the vertex for.
+         * @param[in] it The iterator to find the vertex for.
          */
         GraphVertex Find(ConstInstIterator it);
 
         /**
          * Finds a graph vertex through an address.
          *
-         * @param address[in] The address to find the vertex for.
+         * @param[in] address The address to find the vertex for.
          */
         GraphVertex Find(uint32 address);
 
@@ -121,16 +121,16 @@ class ControlFlow {
          *
          * graph_2 will be merged into graph_1.
          *
-         * @param g1[in|out] The first vertex to merge.
-         * @param g2[in] The second vertex to merge.
+         * @param[in,out] graph_1 The first vertex to merge.
+         * @param[in] graph_2 The second vertex to merge.
          */
         void Merge(GraphVertex graph_1, GraphVertex graph_2);
 
         /**
          * Sets the stack level for all instructions, using depth-first search.
          *
-         * @param graph[in] The GraphVertex to search from.
-         * @param level[in] The stack level when g is reached.
+         * @param[in] graph The GraphVertex to search from.
+         * @param[in] level The stack level when g is reached.
          */
         void SetStackLevel(GraphVertex graph, int level);
 
@@ -170,8 +170,8 @@ class ControlFlow {
         /**
          * Checks if a candidate break/continue goes to the closest loop.
          *
-         * @param group[in] The group containing the candidate break/continue.
-         * @param condition_group[in] The group containing the respective loop
+         * @param[in] group The group containing the candidate break/continue.
+         * @param[in] condition_group The group containing the respective loop
          * condition.
          * @returns True if the validation succeeded, false if it did not.
          */
@@ -194,10 +194,10 @@ class ControlFlow {
         /**
          * Checks if a candidate else block will cross block boundaries.
          *
-         * @param if_group[in] The group containing the if this else candidate
+         * @param[in] if_group The group containing the if this else candidate
          * is associated with.
-         * @param start[in] The group containing the start of the else.
-         * @param end[in] The group immediately after the group ending the
+         * @param[in] start The group containing the start of the else.
+         * @param[in] end The group immediately after the group ending the
          * else.
          * @returns True if the validation succeeded, false if it did not.
          */

+ 9 - 9
V-Gears-Installer/include/decompiler/DecompilerException.h

@@ -85,7 +85,7 @@ class UnknownOpcodeParameterException : public DecompilerException{
         /**
          * Constructor.
          *
-         * @param param[in] The unknown parameter.
+         * @param[in] param The unknown parameter.
          */
         explicit UnknownOpcodeParameterException(std::string param);
 
@@ -116,8 +116,8 @@ class UnknownConditionalOperatorException : public DecompilerException{
         /**
          * Constructor.
          *
-         * @param address[in] Address at which the operator has been found.
-         * @param op[in] The unknown operator.
+         * @param[in] address Address at which the operator has been found.
+         * @param[in] op The unknown operator.
          */
         UnknownConditionalOperatorException(unsigned int address, unsigned int op);
 
@@ -148,8 +148,8 @@ class UnknownOpcodeException : public DecompilerException{
         /**
          * Constructor.
          *
-         * @param address[in] Address where the invalid opcode was found.
-         * @param opcode[in] The value of the invalid opcode.
+         * @param[in] address Address where the invalid opcode was found.
+         * @param[in] opcode The value of the invalid opcode.
          */
         UnknownOpcodeException(unsigned int address, unsigned int opcode);
 
@@ -198,8 +198,8 @@ class UnknownJumpTypeException : public DecompilerException{
         /**
          * Constructor.
          *
-         * @param address[in] Address where the jump opcode was found.
-         * @param opcode[in] The value of the jump opcode.
+         * @param[in] address Address where the jump opcode was found.
+         * @param[in] opcode The value of the jump opcode.
          */
         UnknownJumpTypeException(unsigned int address, unsigned int opcode);
 
@@ -230,8 +230,8 @@ class UnknownSubOpcodeException : public UnknownOpcodeException{
         /**
          * Constructor.
          *
-         * @param address[in] Address where the invalid subopcode was found.
-         * @param opcode[in] The value of the invalid subopcode.
+         * @param[in] address Address where the invalid subopcode was found.
+         * @param[in] opcode The value of the invalid subopcode.
          */
         UnknownSubOpcodeException(unsigned int address, unsigned int opcode);
 

+ 9 - 9
V-Gears-Installer/include/decompiler/Disassembler.h

@@ -32,7 +32,7 @@ class Disassembler{
         /**
          * Constructor for Disassembler.
          *
-         * @param insts[in] Where disassembled instructions will be placed.
+         * @param[in] insts Where disassembled instructions will be placed.
          */
         Disassembler(InstVec &insts);
 
@@ -44,7 +44,7 @@ class Disassembler{
         /**
          * Open a file for disassembly.
          *
-         * @param filename[in] The file to Disassemble.
+         * @param[in] filename The file to Disassemble.
          */
         virtual void Open(const char *filename);
 
@@ -58,7 +58,7 @@ class Disassembler{
          *
          * Disassembles code if this has not already been done.
          *
-         * @param output[out] The output stream.
+         * @param[out] output The output stream.
          */
         void DumpDisassembly(std::ostream &output);
 
@@ -75,15 +75,15 @@ class Disassembler{
         /**
          * Outputs the disassembled code.
          *
-         * @param output[out] The output stream.
+         * @param[out] output The output stream.
          */
         virtual void DoDumpDisassembly(std::ostream &output);
 
         /**
          * Read parameters and associate them with an instruction.
          *
-         * @param inst[in] The instruction to associate the parameters with.
-         * @param types[in] NUL-terminated string describing the type of each
+         * @param[in] inst The instruction to associate the parameters with.
+         * @param[in] types NUL-terminated string describing the type of each
          * parameter.
          */
         void ReadParams(InstPtr inst, const char *types);
@@ -91,11 +91,11 @@ class Disassembler{
         /**
          * Read parameters but it doesn't associate them with an instruction.
          *
-         * @param inst[in] The instruction to associate the parameters with.
+         * @param[in] inst The instruction to associate the parameters with.
          * Unused.
-         * @param types[in] NUL-terminated string describing the type of each
+         * @param[in] types NUL-terminated string describing the type of each
          * parameter.
-         * @param params[in] Unused.
+         * @param[in] params Unused.
          */
         void ReadParams(InstPtr inst, const char *types, const std::vector<std::string>& params);
 

+ 7 - 6
V-Gears-Installer/include/decompiler/Engine.h

@@ -44,7 +44,7 @@ class Engine {
         /**
          * Retrieve the disassembler for the engine.
          *
-         * @param insts[out] Vector to place the Instructions in.
+         * @param[out] insts Vector to place the Instructions in.
          * @return Pointer to a disassembler for the engine.
          */
         virtual std::unique_ptr<Disassembler> GetDisassembler(InstVec &insts) = 0;
@@ -52,7 +52,8 @@ class Engine {
         /**
          * Retrieve the code generator for the engine.
          *
-         * @param output[out] Stream to output the code to.
+         * @param[in] insts The list of instructions.
+         * @param[out] output Stream to output the code to.
          * @return Pointer to a CodeGenerator for the engine.
          */
         virtual std::unique_ptr<CodeGenerator> GetCodeGenerator(
@@ -61,8 +62,8 @@ class Engine {
 
         /**
          * Post-processing step after CFG analysis.
-         * @param insts[out] Vector to place the Instructions in.
-         * @param graph[in] Graph generated from the CFG analysis.
+         * @param[out] insts Vector to place the Instructions in.
+         * @param[in] graph Graph generated from the CFG analysis.
          */
         virtual void PostCFG(InstVec& insts, Graph graph);
 
@@ -88,9 +89,9 @@ class Engine {
          * If variants are not used by this engine, it will be empty (default
          * implementation).
          *
-         * @param variants Vector with the supported variants.
+         * @param[out] variants Vector with the supported variants.
          */
-        virtual void GetVariants(std::vector<std::string>&) const;
+        virtual void GetVariants(std::vector<std::string>& variants) const;
 
 
         /**

+ 2 - 2
V-Gears-Installer/include/decompiler/Function.h

@@ -35,8 +35,8 @@ struct Function {
         /**
          * Constructor.
          *
-         * @param start_addr[in] Address of the first instruction in the function.
-         * @param end_addr[in] Address of the last instruction in the function
+         * @param[in] start_addr Address of the first instruction in the function.
+         * @param[in] end_addr Address of the last instruction in the function
          */
         Function(uint32 start_addr, uint32 end_addr):
           start_addr(start_addr), end_addr(end_addr), num_instructions(0), ret_val(true){}

+ 21 - 21
V-Gears-Installer/include/decompiler/Graph.h

@@ -99,15 +99,15 @@ struct IsJump {
     /**
      * Constructor.
      *
-     * @param jump[is] Whether or not the edge is a jump.
+     * @param[in] jump Whether or not the edge is a jump.
      */
     IsJump(bool jump);
 
     /**
      * Output edge information as a graphviz edge property.
      *
-     * @param output[out] The stream to output to.
-     * @param is_jump[in] The IsJump to output.
+     * @param[out] output The stream to output to.
+     * @param[in] is_jump The IsJump to output.
      * @return The stream used for output.
      */
     friend std::ostream &operator<<(std::ostream &output, IsJump is_jump){
@@ -129,15 +129,15 @@ namespace boost {
             /**
              * Constructor.
              *
-             * @param name[in] The name of the attribute to use.
+             * @param[in] name The name of the attribute to use.
              */
             explicit ArrowheadWriter(Name name): name(name){}
 
             /**
              * Outputs the arrowhead edge property.
              *
-             * @param out[out] The stream to output to.
-             * @param v[in] The vertex or edge to output the attribute for.
+             * @param[out] out The stream to output to.
+             * @param[in] v The vertex or edge to output the attribute for.
              */
             template <class VertexOrEdge> void operator()(
               std::ostream& out, const VertexOrEdge& v
@@ -156,7 +156,7 @@ namespace boost {
     /**
      * Creates an arrowhead property writer.
      *
-     * @param _name The name of the attribute to use.
+     * @param[in] n The name of the attribute to use.
      */
     template <class Name> inline ArrowheadWriter<Name> MakeArrowheadWriter(Name n) {
         return ArrowheadWriter<Name>(n);
@@ -207,10 +207,10 @@ struct CodeLine {
     /**
      * Constructor for CodeLine.
      *
-     * @param line[in] The line of code.
-     * @param unindent_before[in] Whether or not to remove an indentation
+     * @param[in] line The line of code.
+     * @param[in] unindent_before Whether or not to remove an indentation
      * level before the line. Defaults to false.
-     * @param indent_after[in] Whether or not to add an indentation level
+     * @param[in] indent_after Whether or not to add an indentation level
      * after the line. Defaults to false.
      */
     CodeLine(const std::string& line, bool unindent_before, bool indent_after);
@@ -296,10 +296,10 @@ struct Group : public RefCounted {
         /**
          * Constructor.
          *
-         * @param vertex[in] The vertex the group belongs to.
-         * @param start[in] First instruction in the group.
-         * @param end[in] Last instruction in the group.
-         * @param prev[in] Pointer to the previous group, when ordered by
+         * @param[in] vertex The vertex the group belongs to.
+         * @param[in] start First instruction in the group.
+         * @param[in] end Last instruction in the group.
+         * @param[in] prev Pointer to the previous group, when ordered by
          * address.
          */
         Group(GraphVertex vertex, InstIterator start, InstIterator end, GroupPtr prev);
@@ -307,8 +307,8 @@ struct Group : public RefCounted {
         /**
          * Output a group to an stream as a graphviz label.
          *
-         * @param output[out] The stream to output to.
-         * @param group[in] The Group to output.
+         * @param[out] output The stream to output to.
+         * @param[in] group The Group to output.
          * @return The stream used for output.
          */
         friend std::ostream &operator<<(std::ostream &output, GroupPtr group){
@@ -361,23 +361,23 @@ struct GraphProperties {
         /**
          * Constructor.
          *
-         * @param engine[in] The engine with function information for the
+         * @param[in] engine The engine with function information for the
          * script.
-         * @param greaph[in] he graph for the script.
+         * @param[in] graph he graph for the script.
          */
         GraphProperties(Engine *engine, const Graph &graph);
 
         /**
          * Copy constructor.
          *
-         * @param rhs[in] Graph properties to copy.
+         * @param[in] rhs Graph properties to copy.
          */
         GraphProperties(const GraphProperties& rhs);
 
         /**
          * Copy constructor.
          *
-         * @param rhs[in] Graph properties to copy.
+         * @param[in] rhs Graph properties to copy.
          */
         GraphProperties& operator = (const GraphProperties& rhs);
 
@@ -386,7 +386,7 @@ struct GraphProperties {
          *
          * Called by write_graphviz from Boost.Graph
          *
-         * @param out[out] The stream write_graphviz is writing to.
+         * @param[out] out The stream write_graphviz is writing to.
          */
         void operator()(std::ostream& out) const;
 

+ 7 - 7
V-Gears-Installer/include/decompiler/LuaLanguage.h

@@ -81,7 +81,7 @@ class LuaLanguage{
         /**
          * A Lua "goto" instruction.
          *
-         * @param target[in] A memory address label.
+         * @param[in] target A memory address label.
          * @return "goto label_0x<target>X".
          */
         virtual std::string Goto(uint32 target);
@@ -96,7 +96,7 @@ class LuaLanguage{
         /**
          * The Lua parts of a do-loop footer
          *
-         * @param before_expr[in] True to fetch the initial part of the
+         * @param[in] before_expr True to fetch the initial part of the
          * footer, false for the ending part.
          * @return "until (" if before_expr is true, ")" if not.
          */
@@ -105,7 +105,7 @@ class LuaLanguage{
         /**
          * The Lua parts of a if control sentence
          *
-         * @param before_expr[in] True to fetch the initial part of the
+         * @param[in] before_expr True to fetch the initial part of the
          * sentence, false for the ending part.
          * @return "if (" if before_expr is true, ") then" if not.
          */
@@ -114,7 +114,7 @@ class LuaLanguage{
         /**
          * The Lua parts of a while control sentence
          *
-         * @param before_expr[in] True to fetch the initial part of the
+         * @param[in] before_expr True to fetch the initial part of the
          * sentence, false for the ending part.
          * @return "while (" if before_expr is true, ") do" if not.
          */
@@ -144,7 +144,7 @@ class LuaLanguage{
         /**
          * Generates a Lua label to use with goto.
          *
-         * @param addr[in] Target address label.
+         * @param[in] addr Target address label.
          * @return "::label_0x<target>X::"
          */
         virtual std::string Label(uint32 addr);
@@ -160,7 +160,7 @@ class LuaLanguage{
         /**
          * The Lua block starter (none).
          *
-         * @param context[in] Unused.
+         * @param[in] context Unused.
          * @return An empty string.
          */
         virtual std::string StartBlock(CONTEXT context);
@@ -168,7 +168,7 @@ class LuaLanguage{
         /**
          * A Lua block ender.
          *
-         * @param context[in] The current context.
+         * @param[in] context The current context.
          * @return "end", unles the current context is {@see TO_ELSE_BLOCK},
          * in which case it will return an empty string, because "end" is not
          * needed before an else.

+ 2 - 2
V-Gears-Installer/include/decompiler/ObjectFactory.h

@@ -33,7 +33,7 @@ template<typename KeyType, typename BaseType> class ObjectFactory{
         /**
          * Register a new entry.
          *
-         * @param key[in] The key to register the class under.
+         * @param[in] key The key to register the class under.
          */
         template<typename Type> void AddEntry(const KeyType &key) {
             registry_[key] = &CreateObject<BaseType, Type>;
@@ -42,7 +42,7 @@ template<typename KeyType, typename BaseType> class ObjectFactory{
         /**
          * Creates an instance of some registered class.
          *
-         * @param key[in] The key associated with the desired class.
+         * @param[in] key The key associated with the desired class.
          * @return NULL if the name is not registered, else an instance of the
          * associated class.
          */

+ 2 - 2
V-Gears-Installer/include/decompiler/RefCounted.h

@@ -48,14 +48,14 @@ class RefCounted{
 /**
  * Add a reference to a pointer.
  *
- * @param ptr[in] Pointer to reference.
+ * @param[in] ptr Pointer to reference.
  */
 inline void intrusive_ptr_add_ref(RefCounted *ptr){++ (ptr->ref_count_);}
 
 /**
  * Remove a reference from a pointer.
  *
- * @param ptr[in] Pointer to de-reference.
+ * @param[in] ptr Pointer to de-reference.
  */
 inline void intrusive_ptr_release(RefCounted *ptr){
     if (-- (ptr->ref_count_) == 0) delete ptr;

+ 12 - 11
V-Gears-Installer/include/decompiler/ScriptFormatter.h

@@ -30,8 +30,8 @@ class ScriptFormatter{
         /**
          * Retrieves a friendly name for a variable.
          *
-         * @param bank[in] Variable memory bank.
-         * @param address[in] Variable memory address.
+         * @param[in] bank Variable memory bank.
+         * @param[in] addr Variable memory address.
          * @return Friendly name assigned to the variable, or an empty
          * string if there is none.
          */
@@ -40,8 +40,8 @@ class ScriptFormatter{
         /**
          * Retrieves a friendly name for an entity.
          *
-         * @param entity_name[in] Name of the entity.
-         * @return Friendly name assigned to the entity, or <entity_name>
+         * @param[in] entity_name Name of the entity.
+         * @return Friendly name assigned to the entity, or entity_name
          * if there is none.
          */
         virtual std::string GetFriendlyEntityName(const std::string& entity_name);
@@ -49,7 +49,8 @@ class ScriptFormatter{
         /**
          * Retrieves a friendly name for an animation.
          *
-         * @param animation_id[in] ID of the animation.
+         * @param[in] animation_id ID of the animation.
+         * @param[in] id Unused.
          * @return Friendly name assigned to the animation. If there is
          * no one, the ID in string format.
          */
@@ -58,7 +59,7 @@ class ScriptFormatter{
         /**
          * Retrieves a friendly name for a character.
          *
-         * @param char_id[in] ID of the character.
+         * @param[in] char_id ID of the character.
          * @return Friendly name assigned to the character. If there is
          * no one, the ID in string format.
          */
@@ -67,10 +68,10 @@ class ScriptFormatter{
         /**
          * Retrieves a friendly name for a function.
          *
-         * @param entity_name[in] Name of the entity.
-         * @param function_name[in] Name of the function.
+         * @param[in] entity_name Name of the entity.
+         * @param[in] function_name Name of the function.
          * @return Friendly name assigned to the entity, or
-         * <function_name> if there is none.
+         * function_name if there is none.
          */
         virtual std::string GetFriendlyFunctionName(
           const std::string& entity_name, const std::string& function_name
@@ -79,8 +80,8 @@ class ScriptFormatter{
         /**
          * Retrieves the header comment for a function in an entity.
          *
-         * @param entity_name[in] Name of the entity.
-         * @param function_name[in] Name of the function.
+         * @param[in] entity_name Name of the entity.
+         * @param[in] function_name Name of the function.
          * @return The function comment. An empty string if the entity or
          * the function don't exist.
          */

+ 3 - 3
V-Gears-Installer/include/decompiler/Stack.h

@@ -35,7 +35,7 @@ template<typename T> class Stack {
         /**
          * Push an item onto the stack.
          *
-         * @param item[in] The item to push.
+         * @param[in] item The item to push.
          */
         void Push(const T &item){stack_.push_front(item);}
 
@@ -67,7 +67,7 @@ template<typename T> class Stack {
         /**
          * Gets item on a specified stack position without removing it.
          *
-         * @param pos[in] The number of items to skip on the stack.
+         * @param[in] pos The number of items to skip on the stack.
          * @return The desired item from the stack.
          */
         T &PeekPos(size_t pos){
@@ -78,7 +78,7 @@ template<typename T> class Stack {
         /**
          * Gets item on a specified stack position without removing it.
          *
-         * @param pos[in] The number of items to skip on the stack.
+         * @param[in] pos The number of items to skip on the stack.
          * @return The desired item from the stack.
          */
         const T &PeekPos(size_t pos) const{

+ 58 - 58
V-Gears-Installer/include/decompiler/Value.h

@@ -155,7 +155,7 @@ class Value : public RefCounted{
         /**
          * Print the value to a stream.
          *
-         * @param output[out] The stream to write to.
+         * @param[out] output The stream to write to.
          * @return The stream used for output.
          */
         virtual std::ostream& Print(std::ostream &output) const = 0;
@@ -170,7 +170,7 @@ class Value : public RefCounted{
         /**
          * Duplicates a value.
          *
-         * @param output[out] The stream to output any necessary assignment.
+         * @param[out] output The stream to output any necessary assignment.
          * @return A Value corresponding to a duplicate of this entry.
          */
         virtual ValuePtr Dup(std::ostream &output);
@@ -197,8 +197,8 @@ class Value : public RefCounted{
         /**
          * Output a value to a stream.
          *
-         * @param output[out] The  stream to output to.
-         * @param value[in] Reference counted pointer to the value to output.
+         * @param[out] output The  stream to output to.
+         * @param[in] value Reference counted pointer to the value to output.
          * @return The stream used for output.
          */
         friend std::ostream &operator<<(std::ostream &output, Value *value) {
@@ -217,30 +217,30 @@ class IntValue : public Value {
         /**
          * Copy constructor, disabled.
          *
-         * @param value[in] The value to copy.
+         * @param[in] value The value to copy.
          */
         IntValue(const IntValue& value) = delete;
 
         /**
          * Copy constructor, disabled
          *
-         * @param value[in] The value to copy.
+         * @param[in] value The value to copy.
          */
         IntValue& operator = (const IntValue& value) = delete;
 
         /**
          * Constructor for IntValue.
          *
-         * @param val The integer value to be contained.
-         * @param isSigned Whether or not the value is signed. This will affect output.
+         * @param[in] val The integer value to be contained.
+         * @param[in] is_signed Whether or not the value is signed. This will affect output.
          */
         IntValue(int32 val, bool is_signed);
 
         /**
          * Constructor for IntValue.
          *
-         * @param val The integer value to be contained.
-         * @param isSigned Whether or not the value is signed. This will affect output.
+         * @param[in] val The integer value to be contained.
+         * @param[in] is_signed Whether or not the value is signed. This will affect output.
          */
         IntValue(uint32 val, bool is_signed);
 
@@ -276,7 +276,7 @@ class IntValue : public Value {
         /**
          * Duplicates the value.
          *
-         * @param output[out] The stream to output any necessary assignment.
+         * @param[out] output The stream to output any necessary assignment.
          * @return A Value corresponding to a duplicate of the value.
          */
         ValuePtr Dup(std::ostream &output) override;
@@ -284,7 +284,7 @@ class IntValue : public Value {
         /**
          * Print the value to a stream.
          *
-         * @param output[out] The stream to write to.
+         * @param[out] output The stream to write to.
          * @return The stream used for output.
          */
         virtual std::ostream& Print(std::ostream &output) const override;
@@ -312,21 +312,21 @@ class AddressValue: public IntValue{
         /**
          * Copy constructor, disabled.
          *
-         * @param value[in] The value to copy.
+         * @param[in] value The value to copy.
          */
         AddressValue(const AddressValue& value) = delete;
 
         /**
          * Copy constructor, disabled.
          *
-         * @param value[in] The value to copy.
+         * @param[in] value The value to copy.
          */
         AddressValue& operator = (const AddressValue& value) = delete;
 
         /**
          * Constructor for AddressValue.
          *
-         * @param addr The absolute address represented by the value.
+         * @param[in] addr The absolute address represented by the value.
          */
         explicit AddressValue(uint32 addr);
 
@@ -350,7 +350,7 @@ class AddressValue: public IntValue{
         /**
          * Duplicates the value.
          *
-         * @param output[out] The stream to output any necessary assignment.
+         * @param[out] output The stream to output any necessary assignment.
          * @return A Value corresponding to a duplicate of the value.
          */
         ValuePtr Dup(std::ostream &output) override;
@@ -358,7 +358,7 @@ class AddressValue: public IntValue{
         /**
          * Print the value to a stream.
          *
-         * @param output[out] The stream to write to.
+         * @param[out] output The stream to write to.
          * @return The stream used for output.
          */
         virtual std::ostream& Print(std::ostream &output) const override;
@@ -377,22 +377,22 @@ class RelAddressValue : public IntValue{
         /**
          * Copy constructor, disabled.
          *
-         * @param value[in] The value to copy.
+         * @param[in] value The value to copy.
          */
         RelAddressValue(const RelAddressValue& value) = delete;
 
         /**
          * Copy constructor, disabled.
          *
-         * @param value[in] The value to copy.
+         * @param[in] value The value to copy.
          */
         RelAddressValue& operator = (const RelAddressValue& value) = delete;
 
         /**
          * Constructor.
          *
-         * @param base_addr[in] The base address for the offset.
-         * @param offset[in] The relative offset to the base address.
+         * @param[in] base_addr The base address for the offset.
+         * @param[in] offset The relative offset to the base address.
          */
         RelAddressValue(uint32 base_addr, int32 offset);
 
@@ -414,7 +414,7 @@ class RelAddressValue : public IntValue{
         /**
          * Duplicates the value.
          *
-         * @param output[out] The stream to output any necessary assignment.
+         * @param[out] output The stream to output any necessary assignment.
          * @return A Value corresponding to a duplicate of the value.
          */
         ValuePtr Dup(std::ostream &output) override;
@@ -422,7 +422,7 @@ class RelAddressValue : public IntValue{
         /**
          * Print the relative address to a stream.
          *
-         * @param output[out] The stream to write to.
+         * @param[out] output The stream to write to.
          * @return The stream used for output.
          */
         virtual std::ostream& Print(std::ostream &output) const override;
@@ -445,14 +445,14 @@ class DupValue : public Value {
         /**
          * Copy constructor, disabled.
          *
-         * @param value[in] The value to copy.
+         * @param[in] value The value to copy.
          */
         DupValue(const DupValue& value) = delete;
 
         /**
          * Copy constructor, disabled.
          *
-         * @param value[in] The value to copy.
+         * @param[in] value The value to copy.
          */
         DupValue& operator = (const DupValue& value) = delete;
 
@@ -466,7 +466,7 @@ class DupValue : public Value {
         /**
          * Duplicates the value.
          *
-         * @param output[out] The stream to output any necessary assignment.
+         * @param[out] output The stream to output any necessary assignment.
          * @return A Value corresponding to a duplicate of the value.
          */
         ValuePtr Dup(std::ostream &output) override;
@@ -474,7 +474,7 @@ class DupValue : public Value {
         /**
          * Print the value to a stream.
          *
-         * @param output[out] The stream to write to.
+         * @param[out] output The stream to write to.
          * @return The stream used for output.
          */
         virtual std::ostream& Print(std::ostream &output) const override;
@@ -497,28 +497,28 @@ class StringValue : public Value {
         /**
          * Copy constructor, disabled.
          *
-         * @param value[in] The value to copy.
+         * @param[in] value The value to copy.
          */
         StringValue(const StringValue& value) = delete;
 
         /**
          * Copy constructor, disabled.
          *
-         * @param value[in] The value to copy.
+         * @param[in] value The value to copy.
          */
         StringValue& operator = (const StringValue& value) = delete;
 
         /**
          * Constructor.
          *
-         * @param str[in] The string value.
+         * @param[in] str The string value.
          */
         explicit StringValue(std::string str);
 
         /**
          * Print the value to a stream.
          *
-         * @param output[out] The stream to write to.
+         * @param[out] output The stream to write to.
          * @return The stream used for output.
          */
         virtual std::ostream& Print(std::ostream &output) const override;
@@ -541,14 +541,14 @@ class UnquotedStringValue : public StringValue{
         /**
          * Constructor.
          *
-         * @param str[in] The string value.
+         * @param[in] str The string value.
          */
         explicit UnquotedStringValue(std::string str);
 
         /**
          * Prints the value to a stream.
          *
-         * @param output[out] The stream to write to.
+         * @param[out] output The stream to write to.
          * @return The stream used for output.
          */
         virtual std::ostream& Print(std::ostream &output) const override;
@@ -569,7 +569,7 @@ class VarValue : public Value {
         /**
          * Print the value to a stream.
          *
-         * @param output[out] The stream to write to.
+         * @param[out] output The stream to write to.
          * @return The stream used for output.
          */
         virtual std::ostream& Print(std::ostream &output) const override;
@@ -592,14 +592,14 @@ class ArrayValue : public VarValue {
         /**
          * Copy constructor, disabled.
          *
-         * @param value[in] The value to copy.
+         * @param[in] value The value to copy.
          */
         ArrayValue(const ArrayValue& value) = delete;
 
         /**
          * Copy constructor, disabled.
          *
-         * @param value[in] The value to copy.
+         * @param[in] value The value to copy.
          */
         ArrayValue& operator = (const ArrayValue& value) = delete;
 
@@ -617,7 +617,7 @@ class ArrayValue : public VarValue {
          *
          * Every item in the array will be printed.
          *
-         * @param output[out] The stream to write to.
+         * @param[out] output The stream to write to.
          * @return The stream used for output.
          */
         virtual std::ostream& Print(std::ostream &output) const override;
@@ -641,30 +641,30 @@ class BinaryOpValue : public Value {
         /**
          * Copy constructor, disabled.
          *
-         * @param value[in] The value to copy.
+         * @param[in] value The value to copy.
          */
         BinaryOpValue(const BinaryOpValue& value) = delete;
 
         /**
          * Copy constructor, disabled.
          *
-         * @param value[in] The value to copy.
+         * @param[in] value The value to copy.
          */
         BinaryOpValue& operator = (const BinaryOpValue& value) = delete;
 
         /**
          * Constructor.
          *
-         * @param left[in] Value representing the left side of the operator.
-         * @param right[in] Value representing the right side of the operator.
-         * @param operator[in] The operator for this value.
+         * @param[in] left Value representing the left side of the operator.
+         * @param[in] right Value representing the right side of the operator.
+         * @param[in] oper The operator for this value.
          */
         BinaryOpValue(ValuePtr left, ValuePtr right, std::string oper);
 
         /**
          * Print the value to a stream.
          *
-         * @param output[out] The stream to write to.
+         * @param[out] output The stream to write to.
          * @return The stream used for output.
          */
         virtual std::ostream& Print(std::ostream &output) const override;
@@ -717,23 +717,23 @@ class UnaryOpValue : public Value{
         /**
          * Copy constructor, disabled.
          *
-         * @param value[in] The value to copy.
+         * @param[in] value The value to copy.
          */
         UnaryOpValue(const UnaryOpValue& value) = delete;
 
         /**
          * Copy constructor, disabled.
          *
-         * @param value[in] The value to copy.
+         * @param[in] value The value to copy.
          */
         UnaryOpValue& operator = (const UnaryOpValue& value) = delete;
 
         /**
-         * Constructor..
+         * Constructor.
          *
-         * @param operand[in] Value representing the operand of the operation.
-         * @param oper[in] The operator for this value.
-         * @param postfix[in] Whether or not the operator should be postfixed
+         * @param[in] operand Value representing the operand of the operation.
+         * @param[in] oper The operator for this value.
+         * @param[in] postfix Whether or not the operator should be postfixed
          * to the operand.
          */
         UnaryOpValue(ValuePtr operand, std::string oper, bool postfix);
@@ -741,7 +741,7 @@ class UnaryOpValue : public Value{
         /**
          * Print the value to a stream.
          *
-         * @param output[out] The stream to write to.
+         * @param[out] output The stream to write to.
          * @return The stream used for output.
          */
         virtual std::ostream& Print(std::ostream &output) const override;
@@ -785,21 +785,21 @@ class NegatedValue : public UnaryOpValue{
         /**
          * Copy constructor, disabled.
          *
-         * @param value[in] The value to copy.
+         * @param[in] value The value to copy.
          */
         NegatedValue(const NegatedValue& value) = delete;
 
         /**
          * Copy constructor, disabled.
          *
-         * @param value[in] The value to copy.
+         * @param[in] value The value to copy.
          */
         NegatedValue& operator = (const NegatedValue& value) = delete;
 
         /**
          * Constructor.
          *
-         * @param val[in] The value to negate.
+         * @param[in] val The value to negate.
          */
         explicit NegatedValue(ValuePtr val);
 
@@ -821,29 +821,29 @@ class CallValue : public Value {
         /**
          * Copy constructor, disabled.
          *
-         * @param value[in] The value to copy.
+         * @param[in] value The value to copy.
          */
         CallValue(const CallValue& value) = delete;
 
         /**
          * Copy constructor, disabled.
          *
-         * @param value[in] The value to copy.
+         * @param[in] value The value to copy.
          */
         CallValue& operator = (const CallValue& value) = delete;
 
         /**
          * Constructor for CallValue.
          *
-         * @param function[in] The name of the function.
-         * @param args[in] List of values representing the arguments used.
+         * @param[in] function The name of the function.
+         * @param[in] args List of values representing the arguments used.
          */
         CallValue(std::string function, ValueList args);
 
         /**
          * Print the value to a stream.
          *
-         * @param output[out] The stream to write to.
+         * @param[out] output The stream to write to.
          * @return The stream used for output.
          */
         virtual std::ostream& Print(std::ostream &output) const override;

+ 37 - 37
V-Gears-Installer/include/decompiler/field/FieldCodeGenerator.h

@@ -40,7 +40,7 @@ class FunctionMetaData{
          * - start_entityname
          * - end_entity_name
          *
-         * @param meta_data[in] Metadata to parse.
+         * @param[in] meta_data Metadata to parse.
          */
         FunctionMetaData(std::string meta_data);
 
@@ -94,7 +94,7 @@ class FunctionMetaData{
         /**
          * Parses metadata.
          *
-         * @param meta_data[in] Metadata to parse.
+         * @param[in] meta_data Metadata to parse.
          */
         void Parse(std::string meta_data);
 
@@ -104,8 +104,8 @@ class FunctionMetaData{
          * If it finds it, marks the metadata as the first function of a
          * class. It also * calls {@see ParseEnd} with the next token.
          *
-         * @param item[in] The item to check for a start mark.
-         * @param item[in] All the metadata tokens.
+         * @param[in] item The item to check for a start mark.
+         * @param[in] strs All the metadata tokens.
          */
         void ParseStart(const std::string& item, std::deque<std::string>& strs);
 
@@ -115,8 +115,8 @@ class FunctionMetaData{
          * If it finds it, marks the metadata as the last function of a class.
          * It also calls {@see ParseCharId}.
          *
-         * @param item[in] The item to check for a start mark.
-         * @param item[in] Metadata tokens, first removed.
+         * @param[in] item The item to check for a start mark.
+         * @param[in] strs Metadata tokens, first removed.
          */
         void ParseEnd(const std::string& item, std::deque<std::string>& strs);
 
@@ -126,8 +126,8 @@ class FunctionMetaData{
          * If it finds it, sets the character ID. It also calls
          * {@see ParseEntity}.
          *
-         * @param item[in] The item to check for a start mark.
-         * @param item[in] Metadata tokens, first two removed.
+         * @param[in] item The item to check for a start mark.
+         * @param[in] strs Metadata tokens, first two removed.
          */
         void ParseCharId(const std::string& item, std::deque<std::string>& strs);
 
@@ -136,8 +136,8 @@ class FunctionMetaData{
          *
          * It sets the entity name.
          *
-         * @param item[in] The item to check for a start mark.
-         * @param item[in] Metadata tokens, first three removed.
+         * @param[in] item The item to check for a start mark.
+         * @param[in] strs Metadata tokens, first three removed.
          */
         void ParseEntity(const std::string& item, std::deque<std::string>& strs);
 
@@ -193,9 +193,9 @@ class FieldCodeGenerator : public CodeGenerator{
          * The code will actually be a comment, indicating where the function
          * call must have been.
          *
-         * @param entity[in] The entity name.
-         * @param address[in] The address of the instruction.
-         * @param opcode[in] The opcode not implemented.
+         * @param[in] entity The entity name.
+         * @param[in] address The address of the instruction.
+         * @param[in] opcode The opcode not implemented.
          */
         static const std::string FormatInstructionNotImplemented(
           const std::string& entity, uint32 address, uint32 opcode
@@ -207,9 +207,9 @@ class FieldCodeGenerator : public CodeGenerator{
          * The code will actually be a comment, indicating where the function
          * call must have been.
          *
-         * @param entity[in] The entity name.
-         * @param address[in] The address of the instruction.
-         * @param opcode[in] The unimplemented instruction.
+         * @param[in] entity The entity name.
+         * @param[in] address The address of the instruction.
+         * @param[in] instruction The unimplemented instruction.
          */
         static const std::string FormatInstructionNotImplemented(
           const std::string& entity, uint32 address, const Instruction& instruction
@@ -218,7 +218,7 @@ class FieldCodeGenerator : public CodeGenerator{
         /**
          * Formats a value as a boolean.
          *
-         * @param value[in] The value to format.
+         * @param[in] value The value to format.
          * @return "false" if the value is 0, "true" otherwise.
          */
         static const std::string FormatBool(uint32 value);
@@ -226,7 +226,7 @@ class FieldCodeGenerator : public CodeGenerator{
         /**
          * Formats a value as a boolean.
          *
-         * @param value[in] The value to format.
+         * @param[in] value The value to format.
          * @return "true" if the value is 0, "false" otherwise.
          */
         static const std::string FormatInvertedBool(uint32 value);
@@ -236,14 +236,14 @@ class FieldCodeGenerator : public CodeGenerator{
          *
          * If possible, it will look for friendly names for variables.
          *
-         * @param formatter[in] Formatter to look up variable friendly names.
-         * @param bank[in] The memory bank to use.
-         * @param value_or_address[in] The value or memory address to use.
+         * @param[in] formatter Formatter to look up variable friendly names.
+         * @param[in] bank The memory bank to use.
+         * @param[in] value_or_address The value or memory address to use.
          * When bank is 0, it will be considered as a value. When bank is non
          * 0, it will be considered an address of the bank.
-         * @param value_type[in] Data type to use. Used only when getting a
+         * @param[in] type Data type to use. Used only when getting a
          * value, not a bank address.
-         * @param scale[in] Scale to scale values to. Used only when using
+         * @param[in] scale Scale to scale values to. Used only when using
          * float values, unused when type is integer or when using a bank
          * address.
          * @return String with the friendly variable name, value, or bank
@@ -296,10 +296,10 @@ class FieldCodeGenerator : public CodeGenerator{
         /**
          * Constructor.
          *
-         * @param engine[in] The engine.
-         * @param insts[in] The list of instructions to parse.
-         * @param output[out] The generated script.
-         * @param formatter[in] The code formatter.
+         * @param[in] engine The engine.
+         * @param[in] insts The list of instructions to parse.
+         * @param[out] output The generated script.
+         * @param[in] formatter The code formatter.
          */
         FieldCodeGenerator(
           Engine *engine, const InstVec& insts, std::ostream &output,
@@ -312,18 +312,18 @@ class FieldCodeGenerator : public CodeGenerator{
         /**
          * Generates the script from the instructions.
          *
-         * @param insts[in] The list of instructions.
-         * @param graph[in] Code graph, unused.
+         * @param[in] insts The list of instructions.
+         * @param[in] graph Code graph, unused.
          */
         virtual void Generate(InstVec& insts, const Graph &graph) override;
 
         /**
          * Adds a line to the script.
          *
-         * @param line[in] The line to add.
-         * @param unindent_before[in] If true, the current script indentation
+         * @param[in] line The line to add.
+         * @param[in] unindent_before If true, the current script indentation
          * will be moved back one position before the line.
-         * @param indent_after[in] If true, the current script indentation
+         * @param[in] indent_after If true, the current script indentation
          * will be moved forward one position after the line.
          */
         virtual void AddOutputLine(
@@ -352,9 +352,9 @@ class FieldCodeGenerator : public CodeGenerator{
          * The function signature is the LUA function declaration, and it
          * looks like this:
          *
-         * <function_name> = function(self)
+         * function_name = function(self)
          *
-         * @param function[in] The function to construct the signature for.
+         * @param[in] function The function to construct the signature for.
          * @return The function signature.
          */
         virtual std::string ConstructFuncSignature(const Function &function) override;
@@ -365,7 +365,7 @@ class FieldCodeGenerator : public CodeGenerator{
          * It appends an "end" to finalize the function. If the function is
          * the last of a class, it also closes the class braces.
          *
-         * @param function[in] The function to end.
+         * @param[in] function The function to end.
          */
         virtual void OnEndFunction(const Function& function) override;
 
@@ -377,7 +377,7 @@ class FieldCodeGenerator : public CodeGenerator{
          * variable for the character. If the function has a comment
          * associated, it will also be added before the function.
          *
-         * @param function[in] The function about to start.
+         * @param[in] function The function about to start.
          */
         virtual void OnBeforeStartFunction(const Function& function) override;
 
@@ -386,7 +386,7 @@ class FieldCodeGenerator : public CodeGenerator{
          *
          * It adds a comment with the function opcodes.
          *
-         * @param function[in] The function to start.
+         * @param[in] function The function to start.
          */
         virtual void OnStartFunction(const Function& function) override;
 

+ 6 - 6
V-Gears-Installer/include/decompiler/field/FieldDecompiler.h

@@ -97,7 +97,7 @@ class FieldDecompiler: public Decompiler{
         /**
          * Retrieves the scale factor of a field.
          *
-         * @param script_bytes[in] Vector of raw byte data that makes up
+         * @param[in] script_bytes Vector of raw byte data that makes up
          * the script.
          * @return The scale fctor.
          */
@@ -106,15 +106,15 @@ class FieldDecompiler: public Decompiler{
         /**
          * Decompiles a field script.
          *
-         * @param script_name[in] Name of the script to be converted,
+         * @param[in] script_name Name of the script to be converted,
          * should match file name.
-         * @param script_bytes[in] Vector of raw byte data that makes up
+         * @param[in] script_bytes Vector of raw byte data that makes up
          * the script.
-         * @param formatter[in] Formatter used to rename variables, drop
+         * @param[in] formatter Formatter used to rename variables, drop
          * functions...
-         * @param text_after[in] Raw text that is added at to the end of
+         * @param[in] text_after Raw text that is added at to the end of
          * the decompiled output.
-         * @param text_before[in] Raw text that is added at to the start of
+         * @param[in] text_before Raw text that is added at to the start of
          * the decompiled output.
          * @return A string with the decompiled script.
          * @throws DecompilerException on failure.

+ 43 - 44
V-Gears-Installer/include/decompiler/field/FieldDisassembler.h

@@ -374,10 +374,9 @@ class FieldDisassembler : public Disassembler{
         /**
          * Finds the ID of the character a function refers to.
          *
-         * @param start_addr[in] The starting address of the function.
-         * @param start_addr[in] The starting address of the function.
-         * @param end_addr[in] The ending address of the instruction.
-         * @param insts[in] The lsit of instructions to search.
+         * @param[in] start_addr The starting address of the function.
+         * @param[in] end_addr The ending address of the instruction.
+         * @param[in] insts The list of instructions to search.
          * @return The ID of the character the function refers to, or -1 if
          * the function doesn't belong to a character.
          */
@@ -386,19 +385,19 @@ class FieldDisassembler : public Disassembler{
         /**
          * Constructor.
          *
-         * @param formatter[in] The code formatter.
-         * @param engine[in] The engine to use to disassemble.
-         * @param insts[in] The list of instructions.
+         * @param[in] formatter The code formatter.
+         * @param[in] engine The engine to use to disassemble.
+         * @param[in] insts The list of instructions.
          */
         FieldDisassembler(FieldScriptFormatter& formatter, FieldEngine* engine, InstVec& insts);
 
         /**
          * Constructor.
          *
-         * @param formatter[in] The code formatter.
-         * @param engine[in] The engine to use to disassemble.
-         * @param insts[in] The list of instructions.
-         * @param raw_script_data[in] @todo Understand and document.
+         * @param[in] formatter The code formatter.
+         * @param[in] engine The engine to use to disassemble.
+         * @param[in] insts The list of instructions.
+         * @param[in] raw_script_data @todo Understand and document.
          */
         FieldDisassembler(
           FieldScriptFormatter& formatter, FieldEngine* engine,
@@ -574,7 +573,7 @@ class FieldDisassembler : public Disassembler{
             /**
              * Reads the header.
              *
-             * @param reader[in] The reader used to read the header.
+             * @param[in] reader The reader used to read the header.
              * @throws ScriptHeaderInvalidException If the magic number for
              * the field is wrong.
              */
@@ -608,7 +607,7 @@ class FieldDisassembler : public Disassembler{
         /**
          * Open a file for disassembly.
          *
-         * @param filename[in] The file to disassemble.
+         * @param[in] filename The file to disassemble.
          * @deprecated Do not use. Load the instructions from the constructor.
          */
         virtual void Open(const char *filename) override;
@@ -616,18 +615,18 @@ class FieldDisassembler : public Disassembler{
         /**
          * Disassembles a script (function).
          *
-         * @param entity_name[in] Name of the entity the script belongs to.
-         * @param entity_index[in] Index of the entity the script belongs to.
-         * @param script_entry_point[in] Address of the first instruction of
-         * the script to disassemble.
-         * @param script index[in] Index of the script, relative to the entity
+         * @param[in] entity_name Name of the entity the script belongs to.
+         * @param[in] entity_index Index of the entity the script belongs to.
+         * @param[in] script_index Index of the script, relative to the entity
          * scripts.
-         * @param next_script_entry_point[in] Address of the first instruction
+         * @param[in] script_entry_point Address of the first instruction of
+         * the script to disassemble.
+         * @param[in] next_script_entry_point Address of the first instruction
          * of the script next to the one to disassemble (i.e. the last address
          * of the script to disassemble, plus one).
-         * @param is_start[in] Indicates if the script is the first one for
+         * @param[in] is_start Indicates if the script is the first one for
          * it's entity.
-         * @param is_end[in] Indicates if the script is the last one for it's
+         * @param[in] is_end Indicates if the script is the last one for it's
          * entity.
          * @throws DecompilerException for malformed scripts.
          */
@@ -639,16 +638,16 @@ class FieldDisassembler : public Disassembler{
         /**
          * Adds a function to the engine.
          *
-         * @param entity_name[in] Name of the entity that owns the function.
-         * @param entity_index[in] Index of the entity that owns the function.
-         * @param script_index[in] Index of the script within the entity.
-         * @param next_script_entry_point[in] Start position of the next
+         * @param[in] entity_name Name of the entity that owns the function.
+         * @param[in] entity_index Index of the entity that owns the function.
+         * @param[in] script_index Index of the script within the entity.
+         * @param[in] next_script_entry_point Start position of the next
          * script (or the ending position of this one, plus one).
-         * @param is_start[in] @todo Understand and document.
-         * @param is_end[in] @todo Understand and document.
-         * @param to_return_only[in] True to read the script only until the
+         * @param[in] is_start @todo Understand and document.
+         * @param[in] is_end @todo Understand and document.
+         * @param[in] to_return_only True to read the script only until the
          * first return.
-         * @param func_name[in] Name of the function. If the entity is a line,
+         * @param[in] func_name Name of the function. If the entity is a line,
          * the provided name will be overridden and set to the standard line
          * entity script names.
          */
@@ -665,11 +664,11 @@ class FieldDisassembler : public Disassembler{
          * whatever comes first. It also detects if one of the read opcodes
          * LINE, which means that the entity is a line
          *
-         * @param end_pos[in] The last position to read. Opcodes will be read
+         * @param[in] end_pos The last position to read. Opcodes will be read
          * until this, or until a RET is found.
-         * @param point_a[out] If a LINE opcode is found, the first point will
+         * @param[out] point_a If a LINE opcode is found, the first point will
          * be saved here.
-         * @param point_b[out] If a LINE opcode is found, the second point
+         * @param[out] point_b If a LINE opcode is found, the second point
          * will be saved here.
          * @return True if LINE opcode found, false if not.
          */
@@ -680,9 +679,9 @@ class FieldDisassembler : public Disassembler{
         /**
          * Initializes a function for an entity.
          *
-         * @param script_index[in] Index of the script.
+         * @param[in] script_index Index of the script.
          */
-        std::unique_ptr<Function> StartFunction(size_t scriptIndex);
+        std::unique_ptr<Function> StartFunction(size_t script_index);
 
         /**
          * Reads the header.
@@ -692,16 +691,16 @@ class FieldDisassembler : public Disassembler{
         /**
          * Reads the header.
          *
-         * @param reader[in] Reader to use to read.
+         * @param[in] reader Reader to use to read.
          */
         void ReadHeader(BinaryReader& reader);
 
         /**
          * Retrieves the offset of the end of a script.
          *
-         * @param cur_entry_point[in] @todo Understand and document.
-         * @param entity_index[in] Index of the entity the script belongs to.
-         * @param script_index[in] The script index.
+         * @param[in] cur_entry_point @todo Understand and document.
+         * @param[in] entity_index Index of the entity the script belongs to.
+         * @param[in] script_index The script index.
          * @return The address of the end of the script.
          */
         uint32 GetEndOfScriptOffset(
@@ -714,13 +713,13 @@ class FieldDisassembler : public Disassembler{
          * Adds properties to an instruction, and adds the instruction to the
          * list.
          *
-         * @param opcode[in] The opcode code.
-         * @param name[in] the opcode name.
-         * @param instruction[in][out] A newly created instruction of the type
-         * the opcode belongs to.
-         * @param stack_change[in] Indicates how much the instruction changes
+         * @param[in] opcode The opcode code.
+         * @param[in] name the opcode name.
+         * @param[in] instruction A newly created instruction of the type the
+         * opcode belongs to.
+         * @param[in] stack_change Indicates how much the instruction changes
          * the stack pointer by.
-         * @param argument_format[in] The opcode argument format.
+         * @param[in] argument_format The opcode argument format.
          */
         template<typename T> void ParseOpcode(
           int opcode, std::string name, T instruction, int stack_change, const char* argument_format

+ 32 - 31
V-Gears-Installer/include/decompiler/field/FieldEngine.h

@@ -53,7 +53,8 @@ class FieldEngine : public Engine{
                  *
                  * Instantiates an entity with a name.
                  *
-                 * @param name[in] Entity name.
+                 * @param[in] name Entity name.
+                 * @param[in] index Entity index.
                  */
                 Entity(const std::string& name, size_t index);
 
@@ -79,7 +80,7 @@ class FieldEngine : public Engine{
                  *
                  * Retrieves the name of a function from it's index.
                  *
-                 * @param index[in] Function index.
+                 * @param[in] index Function index.
                  * @return Function name.
                  * @throws DecompilerException if there is no function with
                  * the specified index.
@@ -91,20 +92,20 @@ class FieldEngine : public Engine{
                  *
                  * Must be added by name and index.
                  *
-                 * @param name[in] Function name. If the entity is a line, the
+                 * @param[in] name Function name. If the entity is a line, the
                  * name will be overridden.
-                 * @param index[in] Function index.
+                 * @param[in] index Function index.
                  */
                 void AddFunction(const std::string& name, size_t index);
 
                 /**
                  * Marks the entity as a line.
                  *
-                 * @param line[in] True to mark the entity as a line, false to
+                 * @param[in] line True to mark the entity as a line, false to
                  * unmark it.
-                 * @param point_a[in] First point of the line. Can be null if
+                 * @param[in] point_a First point of the line. Can be null if
                  * line is false.
-                 * @param point_b[in] Second point of the line. Can be null if
+                 * @param[in] point_b Second point of the line. Can be null if
                  * line is false.
                  */
                 void MarkAsLine(bool line, std::vector<float> point_a, std::vector<float> point_b);
@@ -180,30 +181,30 @@ class FieldEngine : public Engine{
         /**
          * Constructor.
          *
-         * @param formatter[in] The formatter to be used by the engine.
-         * @param script_name[in] The script name.
+         * @param[in] formatter The formatter to be used by the engine.
+         * @param[in] script_name The script name.
          */
         FieldEngine(FieldScriptFormatter& formatter, std::string script_name);
 
         /**
          * Copy constructor, disabled.
          *
-         * @param engine[in] The engine to copy.
+         * @param[in] engine The engine to copy.
          */
         FieldEngine(const FieldEngine& engine) = delete;
 
         /**
          * Copy constructor, disabled.
          *
-         * @param engine[in] The engine to copy.
+         * @param[in] engine The engine to copy.
          */
         FieldEngine& operator = (const FieldEngine& engine) = delete;
 
         /**
          * Retrieves the disasembler.
          *
-         * @param insts[in] List of instructions.
-         * @param raw_script_data[in] Script data, raw format.
+         * @param[in] insts List of instructions.
+         * @param[in] raw_script_data Script data, raw format.
          * @return Pointer to the disasembler.
          */
         virtual std::unique_ptr<Disassembler> GetDisassembler(
@@ -213,7 +214,7 @@ class FieldEngine : public Engine{
         /**
          * Retrieves the dissasembler.
          *
-         * @param insts[in] List of instructions.
+         * @param[in] insts List of instructions.
          * @return Pointer to the dissasembler.
          */
         virtual std::unique_ptr<Disassembler> GetDisassembler(InstVec &insts) override;
@@ -221,8 +222,8 @@ class FieldEngine : public Engine{
         /**
          * Retrieves the code generator.
          *
-         * @param insts[in] List of instructions.
-         * @param output[in] Pointer to the output (file, stream...).
+         * @param[in] insts List of instructions.
+         * @param[in] output Pointer to the output (file, stream...).
          * @return Pointer to the generator.
          */
         virtual std::unique_ptr<CodeGenerator> GetCodeGenerator(
@@ -234,8 +235,8 @@ class FieldEngine : public Engine{
          *
          * It actually does nothing. CFG stands for control flow group.
          *
-         * @param insts[in] Instruction list.
-         * @param graph[in] Code graph.
+         * @param[in] insts Instruction list.
+         * @param[in] graph Code graph.
          */
         virtual void PostCFG(InstVec &insts, Graph graph) override;
 
@@ -277,10 +278,10 @@ class FieldEngine : public Engine{
         /**
          * Adds a function to an entity.
          *
-         * @param entity_name[in] Name of the entity.
-         * @param entity_index[in] Index of the entity.
-         * @param func_name[in] Name of the function.
-         * @param func_index[in] Index of the function.
+         * @param[in] entity_name Name of the entity.
+         * @param[in] entity_index Index of the entity.
+         * @param[in] func_name Name of the function.
+         * @param[in] func_index Index of the function.
          */
         void AddEntityFunction(
           const std::string& entity_name, size_t entity_index,
@@ -291,11 +292,11 @@ class FieldEngine : public Engine{
          * Marks an entity as a line.
          *
          * @param entity_index Index of the entity.
-         * @param line[in] True to mark the entity as a line, false to unmark
+         * @param[in] line True to mark the entity as a line, false to unmark
          * it.
-         * @param point_a[in] First point of the line. Can be null if line is
+         * @param[in] point_a First point of the line. Can be null if line is
          * false.
-         * @param point_b[in] Second point of the line. Can be null if line is
+         * @param[in] point_b Second point of the line. Can be null if line is
          * false.
          */
         void MarkEntityAsLine(
@@ -305,7 +306,7 @@ class FieldEngine : public Engine{
         /**
          * Checks if an entity has been marked as a line.
          *
-         * @param entity_index[in] Index of the entity to check.
+         * @param[in] entity_index Index of the entity to check.
          * @return True if the entity is a line. False if it isn't, or if
          * there is no such entity.
          */
@@ -314,7 +315,7 @@ class FieldEngine : public Engine{
         /**
          * Retrieves an entity.
          *
-         * @param index[in] Index of the entity to retrieve.
+         * @param[in] index Index of the entity to retrieve.
          * @throws DecompilerException if there is no entity at the specified
          * index.
          */
@@ -341,9 +342,9 @@ class FieldEngine : public Engine{
          *
          * Useful for scripts that only contain one one return statement.
          *
-         * @param insts[in|out] List of instructions to process. Extraneous
+         * @param[in,out] insts List of instructions to process. Extraneous
          * return statements will be deleted from the instructions.
-         * @param graph[in] Code graph. Unused.
+         * @param[in] graph Code graph. Unused.
          */
         void RemoveExtraneousReturnStatements(InstVec& insts, Graph graph);
 
@@ -354,9 +355,9 @@ class FieldEngine : public Engine{
          * VGears this isn't required, and can cause infinite loops, so they
          * can be removed.
          *
-         * @param insts[in|out] List of instructions to proccess. Trailing
+         * @param[in,out] insts List of instructions to proccess. Trailing
          * infinite loops will be deleted from the instructions.
-         * @param g[in] Code graph.
+         * @param[in] graph Code graph.
          */
         void RemoveTrailingInfiniteLoops(InstVec& insts, Graph graph);
 

+ 13 - 13
V-Gears-Installer/include/decompiler/field/FieldScriptFormatter.h

@@ -35,14 +35,14 @@ class FieldScriptFormatter: public ScriptFormatter{
          * database. If it was already there, update the record to add the
          * origin.
          *
-         * @param map_id[in] The target map ID.
-         * @param entity[in] The entity that acts as the spawn point.
-         * @param function_name[in] The spawn function name.
-         * @param address[in] @todo Understand and document.
-         * @param x[in] X coordinate of the field at which to spawn.
-         * @param y[in] Y coordinate of the field at which to spawn.
-         * @param z[in] Z coordinate of the field at which to spawn.
-         * @param angle[in] Orientation at which to spawn.
+         * @param[in] map_id The target map ID.
+         * @param[in] entity The entity that acts as the spawn point.
+         * @param[in] function_name The spawn function name.
+         * @param[in] address @todo Understand and document.
+         * @param[in] x X coordinate of the field at which to spawn.
+         * @param[in] y Y coordinate of the field at which to spawn.
+         * @param[in] triangle_id Triangle at which to spawn.
+         * @param[in] angle Orientation at which to spawn.
          */
         virtual void AddSpawnPoint(
           unsigned int map_id, const std::string& entity, const std::string& function_name,
@@ -52,10 +52,10 @@ class FieldScriptFormatter: public ScriptFormatter{
         /**
          * Retrieves the name of a spawn point.
          *
-         * @param map_id[in] The target map ID.
-         * @param entity[in] The entity that acts as the spawn point.
-         * @param function_name[in] The spawn function name.
-         * @param address[in] @todo Understand and document.
+         * @param[in] map_id The target map ID.
+         * @param[in] entity The entity that acts as the spawn point.
+         * @param[in] function_name The spawn function name.
+         * @param[in] address @todo Understand and document.
          * @return The name of the spawn point.
          */
         virtual std::string GetSpawnPointName(
@@ -68,7 +68,7 @@ class FieldScriptFormatter: public ScriptFormatter{
          *
          * The name of a map is usually it's ID.
          *
-         * @param map_id[in] The map ID.
+         * @param[in] map_id The map ID.
          * @return The map name.
          */
         virtual std::string GetMapName(unsigned int map_id);

+ 5 - 5
V-Gears-Installer/include/decompiler/field/instruction/FieldBackgroundInstruction.h

@@ -30,13 +30,13 @@ class FieldBackgroundInstruction : public KernelCallInstruction{
         /**
          * Processes the instruction.
          *
-         * @param func[in] Function to process.
-         * @param stack[out] Function stack.
-         * @param engine[in] Engine. Unused
-         * @param codegen[in|out] Code generator to append lines.
+         * @param[in] func Function to process.
+         * @param[out] stack Function stack.
+         * @param[in] engine Engine. Unused
+         * @param[in,out] code_gen Code generator to append lines.
          */
         virtual void ProcessInst(
-          Function& func, ValueStack &stack, Engine *engine, CodeGenerator *code_gen
+          Function& func, ValueStack &stack, Engine* engine, CodeGenerator* code_gen
         ) override;
 
     private:

+ 5 - 5
V-Gears-Installer/include/decompiler/field/instruction/FieldCameraInstruction.h

@@ -30,13 +30,13 @@ class FieldCameraInstruction : public KernelCallInstruction{
         /**
          * Processes the instruction.
          *
-         * @param func[in] Function to process.
-         * @param stack[out] Function stack.
-         * @param engine[in] Engine. Unused
-         * @param codegen[in|out] Code generator to append lines.
+         * @param[in] func Function to process.
+         * @param[out] stack Function stack.
+         * @param[in] engine Engine. Unused
+         * @param[in,out] code_gen Code generator to append lines.
          */
         virtual void ProcessInst(
-          Function& func, ValueStack &stack, Engine *engine, CodeGenerator *code_gen
+          Function& func, ValueStack &stack, Engine* engine, CodeGenerator* code_gen
         ) override;
 
     private:

+ 5 - 5
V-Gears-Installer/include/decompiler/field/instruction/FieldCondJumpInstruction.h

@@ -33,14 +33,14 @@ class FieldCondJumpInstruction : public CondJumpInstruction{
          * Checks if the condition is a function or a comparison, and adds the
          * function to the stack.
          *
-         * @param function[in] Function to process. Unused.
-         * @param stack[out] Function stack. The instruction will be added
+         * @param[in] function Function to process. Unused.
+         * @param[out] stack Function stack. The instruction will be added
          * here.
-         * @param engine[in] Engine. Unused.
-         * @param codegen[in|out] Code generator to append lines.
+         * @param[in] engine Engine. Unused.
+         * @param[in,out] code_gen Code generator to append lines.
          */
         virtual void ProcessInst(
-          Function& function, ValueStack &stack, Engine *engine, CodeGenerator *code_gen
+          Function& function, ValueStack &stack, Engine* engine, CodeGenerator* code_gen
         ) override;
 
         /**

+ 13 - 13
V-Gears-Installer/include/decompiler/field/instruction/FieldControlFlowInstruction.h

@@ -38,13 +38,13 @@ class FieldControlFlowInstruction : public KernelCallInstruction{
         /**
          * Processes the instruction.
          *
-         * @param func[in] Function to process.
-         * @param stack[out] Function stack.
-         * @param engine[in] Engine.
-         * @param code_gen[in] Code generator.
+         * @param[in] func Function to process.
+         * @param[out] stack Function stack.
+         * @param[in] engine Engine.
+         * @param[in] code_gen Code generator.
          */
         virtual void ProcessInst(
-          Function& func, ValueStack &stack, Engine *engine, CodeGenerator *code_gen
+          Function& func, ValueStack& stack, Engine* engine, CodeGenerator* code_gen
         ) override;
 
     private:
@@ -72,8 +72,8 @@ class FieldControlFlowInstruction : public KernelCallInstruction{
          * finish. If the specified priority is already busy executing, the
          * request will fail silently.
          *
-         * @param codegen[in|out] Code generator to append lines.
-         * @param engine[in] The engine.
+         * @param[in,out] code_gen Code generator to append lines.
+         * @param[in] engine The engine.
          */
         void ProcessREQ(CodeGenerator* code_gen, const FieldEngine& engine);
 
@@ -101,8 +101,8 @@ class FieldControlFlowInstruction : public KernelCallInstruction{
          * only then return. The remote execution is still carried out
          * asynchronously, with no notification of completion.
          *
-         * @param codegen[in|out] Code generator to append lines.
-         * @param engine[in] The engine.
+         * @param[in,out] code_gen Code generator to append lines.
+         * @param[in] engine The engine.
          */
         void ProcessREQSW(CodeGenerator* code_gen, const FieldEngine& engine);
 
@@ -127,8 +127,8 @@ class FieldControlFlowInstruction : public KernelCallInstruction{
          * at a specified priority. The request will block until remote
          * execution has finished before returning.
          *
-         * @param codegen[in|out] Code generator to append lines.
-         * @param engine[in] The engine.
+         * @param[in,out] code_gen Code generator to append lines.
+         * @param[in] engine The engine.
          */
         void ProcessREQEW(CodeGenerator* code_gen, const FieldEngine& engine);
 
@@ -156,7 +156,7 @@ class FieldControlFlowInstruction : public KernelCallInstruction{
          * script control is passed to the script F within the current entity
          * with the priority P.
          *
-         * @param codegen[in|out] Code generator to append lines.
+         * @param[in,out] code_gen Code generator to append lines.
          */
         void ProcessRETTO(CodeGenerator* code_gen);
 
@@ -180,7 +180,7 @@ class FieldControlFlowInstruction : public KernelCallInstruction{
          * WAIT(30) in decimal) will pause script execution for 1 second,
          * WAIT(0x96) will pause for 5 seconds, and so on.
          *
-         * @param codegen[in|out] Code generator to append lines.
+         * @param[in,out] code_gen Code generator to append lines.
          */
         void ProcessWAIT(CodeGenerator* code_gen);
 };

+ 7 - 7
V-Gears-Installer/include/decompiler/field/instruction/FieldMathInstruction.h

@@ -30,13 +30,13 @@ class FieldMathInstruction : public StoreInstruction{
         /**
          * Processes the instruction.
          *
-         * @param func[in] Function to process.
-         * @param stack[out] Function stack.
-         * @param engine[in] Engine. Unused.
-         * @param code_gen[in] Code generator.
+         * @param[in] func Function to process.
+         * @param[out] stack Function stack.
+         * @param[in] engine Engine. Unused.
+         * @param[in] code_gen Code generator.
          */
         virtual void ProcessInst(
-          Function& func, ValueStack &stack, Engine *engine, CodeGenerator *code_gen
+          Function& func, ValueStack& stack, Engine* engine, CodeGenerator* code_gen
         ) override;
 
     private:
@@ -83,7 +83,7 @@ class FieldMathInstruction : public StoreInstruction{
          * taken from "Bit". If the Source Bank is an 8 bit bank, then the bit
          * is the address in that bank where the operand is.
          *
-         * @param codegen[in|out] Code generator to append lines.
+         * @param[in,out] code_gen Code generator to append lines.
          */
         void ProcessBITON(CodeGenerator* code_gen);
 
@@ -109,7 +109,7 @@ class FieldMathInstruction : public StoreInstruction{
          * taken from "Bit". If the Source Bank is an 8 bit bank, then the bit
          * is the address in that bank where the operand is.
          *
-         * @param codegen[in|out] Code generator to append lines.
+         * @param[in,out] code_gen Code generator to append lines.
          */
         void ProcessBITOFF(CodeGenerator* code_gen);
 

+ 5 - 5
V-Gears-Installer/include/decompiler/field/instruction/FieldMediaInstruction.h

@@ -30,13 +30,13 @@ class FieldMediaInstruction : public KernelCallInstruction{
         /**
          * Processes the instruction.
          *
-         * @param func[in] Function to process.
-         * @param stack[out] Function stack.
-         * @param engine[in] Engine. Unused
-         * @param codegen[in|out] Code generator to append lines.
+         * @param[in] func Function to process.
+         * @param[out] stack Function stack.
+         * @param[in] engine Engine. Unused
+         * @param[in,out] code_gen Code generator to append lines.
          */
         virtual void ProcessInst(
-          Function& func, ValueStack &stack, Engine *engine, CodeGenerator *code_gen
+          Function& func, ValueStack& stack, Engine* engine, CodeGenerator* code_gen
         ) override;
 
     private:

+ 15 - 15
V-Gears-Installer/include/decompiler/field/instruction/FieldModelInstruction.h

@@ -30,13 +30,13 @@ class FieldModelInstruction : public KernelCallInstruction{
         /**
          * Processes the instruction.
          *
-         * @param func[in] Function to process.
-         * @param stack[out] Function stack.
-         * @param engine[in] Engine.
-         * @param code_gen[in] Code generator.
+         * @param[in] func Function to process.
+         * @param[out] stack Function stack.
+         * @param[in] engine Engine.
+         * @param[in] code_gen Code generator.
          */
         virtual void ProcessInst(
-          Function& func, ValueStack &stack, Engine *engine, CodeGenerator *code_gen
+          Function& func, ValueStack &stack, Engine* engine, CodeGenerator* code_gen
         ) override;
 
     private:
@@ -70,7 +70,7 @@ class FieldModelInstruction : public KernelCallInstruction{
          * from there. This is not normally the required behaviour and should
          * be avoided.
          *
-         * @param codegen[in|out] Code generator to append lines.
+         * @param[in,out] code_gen Code generator to append lines.
          */
         void ProcessJOIN(CodeGenerator* code_gen);
 
@@ -130,7 +130,7 @@ class FieldModelInstruction : public KernelCallInstruction{
          * plays a run or walk animation. Also, all characters take the same
          * time irrespective of distance.
          *
-         * @param codegen[in|out] Code generator to append lines.
+         * @param[in,out] code_gen Code generator to append lines.
          */
         void ProcessSPLIT(CodeGenerator* code_gen);
 
@@ -222,8 +222,8 @@ class FieldModelInstruction : public KernelCallInstruction{
          * animation opcode such as DFANM, and a SOUND played, before the
          * jump.
          *
-         * @param codegen[in|out] Code generator to append lines.
-         * @param entity[in] The name of the entity.
+         * @param[in,out] code_gen Code generator to append lines.
+         * @param[in] entity The name of the entity.
          */
         void ProcessJUMP(CodeGenerator* code_gen, const std::string& entity);
 
@@ -256,7 +256,7 @@ class FieldModelInstruction : public KernelCallInstruction{
          * given that does not have a field object, this opcode will store
          * zero in each of the four address specified.
          *
-         * @param codegen[in|out] Code generator to append lines.
+         * @param[in,out] code_gen Code generator to append lines.
          */
         void ProcessAXYZI(CodeGenerator* code_gen);
 
@@ -325,8 +325,8 @@ class FieldModelInstruction : public KernelCallInstruction{
          * entity, the NPC object will automatically climb from the start to
          * the end point without need for player interaction.
          *
-         * @param codegen[in|out] Code generator to append lines.
-         * @param entity[in] The name of the entity.
+         * @param[in,out] code_gen Code generator to append lines.
+         * @param[in] entity The name of the entity.
          */
         void ProcessLADER(CodeGenerator* code_gen, const std::string& entity);
 
@@ -383,9 +383,9 @@ class FieldModelInstruction : public KernelCallInstruction{
          * halted until the gradual offset has been completed. For this, see
          * OFSTW.
          *
-         * @param codegen[in|out] Code generator to append lines.
-         * @param entity[in] The entity name.
+         * @param[in,out] code_gen Code generator to append lines.
+         * @param[in] entity The entity name.
          */
-        void ProcessOFST(CodeGenerator* codegen, const std::string& entity);
+        void ProcessOFST(CodeGenerator* code_gen, const std::string& entity);
 };
 

+ 9 - 9
V-Gears-Installer/include/decompiler/field/instruction/FieldModuleInstruction.h

@@ -31,13 +31,13 @@ class FieldModuleInstruction : public KernelCallInstruction{
         /**
          * Processes the instruction.
          *
-         * @param func[in] Function to process.
-         * @param stack[out] Function stack.
-         * @param engine[in] Engine. Unused.
-         * @param code_gen[in] Code generator.
+         * @param[in] func Function to process.
+         * @param[out] stack Function stack.
+         * @param[in] engine Engine. Unused.
+         * @param[in] code_gen Code generator.
          */
         virtual void ProcessInst(
-          Function& func, ValueStack &stack, Engine *engine, CodeGenerator *code_gen
+          Function& func, ValueStack& stack, Engine* engine, CodeGenerator* code_gen
         ) override;
 
     private:
@@ -61,7 +61,7 @@ class FieldModuleInstruction : public KernelCallInstruction{
          * in the argument, or the value retrieved from memory location N if B
          * is non-zero. Battle 1, 2, and 999 (0x03E7) are debug battles.
          *
-         * @param codegen[in|out] Code generator to append lines.
+         * @param[in,out] code_gen Code generator to append lines.
          */
         void ProcessBATTLE(CodeGenerator* code_gen);
 
@@ -83,7 +83,7 @@ class FieldModuleInstruction : public KernelCallInstruction{
          * battles will not occur regardless of the argument passed with this
          * opcode.
          *
-         * @param codegen[in|out] Code generator to append lines.
+         * @param[in,out] code_gen Code generator to append lines.
          */
         void ProcessBTLON(CodeGenerator* code_gen);
 
@@ -111,8 +111,8 @@ class FieldModuleInstruction : public KernelCallInstruction{
          * more than 12 gateways by simulating their behavior through a LINE
          * which, when crossed, executes a MAPJUMP.
          *
-         * @param codegen[in|out] Code generator to append lines.
-         * @param func[in] Function to get the spawn point from.
+         * @param[in,out] code_gen Code generator to append lines.
+         * @param[in] func Function to get the spawn point from.
          */
         void ProcessMAPJUMP(CodeGenerator* code_gen, Function& func);
 };

+ 5 - 5
V-Gears-Installer/include/decompiler/field/instruction/FieldNoOperationInstruction.h

@@ -39,12 +39,12 @@ class FieldNoOperationInstruction : public Instruction{
          *
          * It doesn't do anything.
          *
-         * @param func[in] Function to process. Unused.
-         * @param stack[out] Function stack. Unused.
-         * @param engine[in] Engine. Unused.
-         * @param codegen[in|out] Code generator to append lines.
+         * @param[in] func Function to process. Unused.
+         * @param[out] stack Function stack. Unused.
+         * @param[in] engine Engine. Unused.
+         * @param[in,out] code_gen Code generator to append lines.
          */
         virtual void ProcessInst(
-          Function& func, ValueStack &stack, Engine *engine, CodeGenerator *code_gen
+          Function& func, ValueStack& stack, Engine* engine, CodeGenerator* code_gen
         ) override;
 };

+ 5 - 5
V-Gears-Installer/include/decompiler/field/instruction/FieldPartyInstruction.h

@@ -30,13 +30,13 @@ class FieldPartyInstruction : public KernelCallInstruction{
         /**
          * Processes the instruction.
          *
-         * @param func[in] Function to process.
-         * @param stack[out] Function stack.
-         * @param engine[in] The engine. Unused
-         * @param codegen[in|out] Code generator to append lines.
+         * @param[in] func Function to process.
+         * @param[out] stack Function stack.
+         * @param[in] engine The engine. Unused
+         * @param[in,out] code_gen Code generator to append lines.
          */
         virtual void ProcessInst(
-          Function& func, ValueStack &stack, Engine *engine, CodeGenerator *code_gen
+          Function& func, ValueStack&stack, Engine* engine, CodeGenerator* code_gen
         ) override;
 
     private:

+ 5 - 5
V-Gears-Installer/include/decompiler/field/instruction/FieldUncategorizedInstruction.h

@@ -30,12 +30,12 @@ class FieldUncategorizedInstruction : public KernelCallInstruction{
         /**
          * Processes the instruction.
          *
-         * @param func[in] Function to process.
-         * @param stack[out] Function stack.
-         * @param engine[in] Engine. Unused.
-         * @param codegen[in|out] Code generator to append lines.
+         * @param[in] func Function to process.
+         * @param[out] stack Function stack.
+         * @param[in] engine Engine. Unused.
+         * @param[in,out] code_gen Code generator to append lines.
          */
         virtual void ProcessInst(
-          Function& func, ValueStack &stack, Engine *engine, CodeGenerator *code_gen
+          Function& func, ValueStack& stack, Engine* engine, CodeGenerator* code_gen
         ) override;
 };

+ 5 - 5
V-Gears-Installer/include/decompiler/field/instruction/FieldUncondJumpInstruction.h

@@ -58,13 +58,13 @@ class FieldUncondJumpInstruction : public UncondJumpInstruction{
         /**
          * Processes the instruction.
          *
-         * @param func[in] Function to process.
-         * @param stack[out] Function stack. Unused.
-         * @param engine[in] The engine. Unused
-         * @param codegen[in|out] Code generator to append lines.
+         * @param[in] func Function to process.
+         * @param[out] stack Function stack. Unused.
+         * @param[in] engine The engine. Unused
+         * @param[in,out] code_gen Code generator to append lines.
          */
         virtual void ProcessInst(
-          Function& func, ValueStack &stack, Engine *engine, CodeGenerator *code_gen
+          Function& func, ValueStack& stack, Engine* engine, CodeGenerator* code_gen
         ) override;
 
         /**

+ 7 - 7
V-Gears-Installer/include/decompiler/field/instruction/FieldWalkmeshInstruction.h

@@ -30,13 +30,13 @@ class FieldWalkmeshInstruction : public KernelCallInstruction{
         /**
          * Processes the instruction.
          *
-         * @param func[in] Function to process.
-         * @param stack[out] Function stack.
-         * @param engine[in] Engine. Unused.
-         * @param codegen[in|out] Code generator to append lines.
+         * @param[in] func Function to process.
+         * @param[out] stack Function stack.
+         * @param[in] engine Engine. Unused.
+         * @param[in,out] code_gen Code generator to append lines.
          */
         virtual void ProcessInst(
-          Function& func, ValueStack &stack, Engine *engine, CodeGenerator *code_gen
+          Function& func, ValueStack& stack, Engine* engine, CodeGenerator* code_gen
         ) override;
 
     private:
@@ -75,8 +75,8 @@ class FieldWalkmeshInstruction : public KernelCallInstruction{
          * - script index 6 -> S5 - Go 1x.
          * - script index 7 -> S6 - Go away.
          *
-         * @param codegen[in|out] Code generator to append lines.
-         * @param entity[in] The entity name.
+         * @param[in,out] code_gen Code generator to append lines.
+         * @param[in] entity The entity name.
          */
         void ProcessLINE(CodeGenerator* code_gen, const std::string& entity);
 };

+ 5 - 5
V-Gears-Installer/include/decompiler/field/instruction/FieldWindowInstruction.h

@@ -30,13 +30,13 @@ class FieldWindowInstruction : public KernelCallInstruction{
         /**
          * Processes the instruction.
          *
-         * @param func[in] Function to process.
-         * @param stack[out] Function stack. Unused.
-         * @param engine[in] Engine.
-         * @param codegen[in|out] Code generator to append lines.
+         * @param[in] func Function to process.
+         * @param[out] stack Function stack. Unused.
+         * @param[in] engine Engine.
+         * @param[in,out] code_gen Code generator to append lines.
          */
         virtual void ProcessInst(
-          Function& func, ValueStack &stack, Engine *engine, CodeGenerator *code_gen
+          Function& func, ValueStack& stack, Engine* engine, CodeGenerator* code_gen
         ) override;
 
     private:

+ 4 - 3
V-Gears-Installer/include/decompiler/instruction/BinaryOpStackInstruction.h

@@ -27,9 +27,10 @@ class BinaryOpStackInstruction: public BinaryOpInstruction{
         /**
          * Process an instruction for code generation.
          *
-         * @param stack[in] The current stack.
-         * @param engine[in] The Engine used for code generation.
-         * @param code_gen[in] The CodeGenerator used for code generation.
+         * @param[in] function The function the instruction is in.
+         * @param[in] stack The current stack.
+         * @param[in] engine The Engine used for code generation.
+         * @param[in] code_gen The CodeGenerator used for code generation.
          */
         virtual void ProcessInst(
           Function& function, ValueStack &stack, Engine *engine, CodeGenerator *code_gen

+ 4 - 3
V-Gears-Installer/include/decompiler/instruction/BoolNegateStackInstruction.h

@@ -27,9 +27,10 @@ class BoolNegateStackInstruction: public BoolNegateInstruction{
         /**
          * Process an instruction for code generation.
          *
-         * @param stack[in] The current stack.
-         * @param engine[in] The Engine used for code generation.
-         * @param code_gen[in] The CodeGenerator used for code generation.
+         * @param[in] function The function the instruction is in.
+         * @param[in] stack The current stack.
+         * @param[in] engine The Engine used for code generation.
+         * @param[in] code_gen The CodeGenerator used for code generation.
          */
         virtual void ProcessInst(
           Function& function, ValueStack &stack, Engine *engine, CodeGenerator *code_gen

+ 4 - 3
V-Gears-Installer/include/decompiler/instruction/DupStackInstruction.h

@@ -27,9 +27,10 @@ class DupStackInstruction: public DupInstruction{
         /**
          * Process an instruction for code generation.
          *
-         * @param stack[in] The current stack.
-         * @param engine[in] The Engine used for code generation.
-         * @param code_gen[in] The CodeGenerator used for code generation.
+         * @param[in] function The function the instruction is in.
+         * @param[in] stack The current stack.
+         * @param[in] engine The Engine used for code generation.
+         * @param[in] code_gen The CodeGenerator used for code generation.
          */
         virtual void ProcessInst(
           Function& function, ValueStack &stack, Engine *engine, CodeGenerator *code_gen

+ 15 - 14
V-Gears-Installer/include/decompiler/instruction/Instruction.h

@@ -32,7 +32,7 @@ class Engine;
 /**
  * Changes whether or not to output the stack effect for an instruction.
  *
- * @param value[in] True to output the effect, false not to.
+ * @param[in] value True to output the effect, false not to.
  */
 void SetOutputStackEffect(bool value);
 
@@ -120,8 +120,8 @@ class Instruction : public RefCounted {
         /**
          * Operator overload to output an Instruction to a stream.
          *
-         * @param output[out] The stream to output to.
-         * @param inst[in] The Instruction to output.
+         * @param[out] output The stream to output to.
+         * @param[in] inst The Instruction to output.
          * @return The stream used for output.
          */
         friend std::ostream& operator<<(std::ostream &output, const Instruction *inst) {
@@ -131,7 +131,7 @@ class Instruction : public RefCounted {
         /**
          * Print the instruction to a stream.
          *
-         * @param output[out] The stream to write to.
+         * @param[out] output The stream to write to.
          * @return The stream used for output.
          */
         virtual std::ostream& Print(std::ostream &output) const;
@@ -218,9 +218,10 @@ class Instruction : public RefCounted {
         /**
          * Process an instruction for code generation.
          *
-         * @param stack[in] The current stack.
-         * @param engine[in] The Engine used for code generation.
-         * @param code_gen[in] The CodeGenerator used for code generation.
+         * @param[in] function The function the instruction is in.
+         * @param[in] stack The current stack.
+         * @param[in] engine The Engine used for code generation.
+         * @param[in] code_gen The CodeGenerator used for code generation.
          */
         virtual void ProcessInst(
           Function& function, ValueStack& stack, Engine* engine, CodeGenerator* code_gen
@@ -236,7 +237,7 @@ class Instruction : public RefCounted {
         /**
          * Sets the instruction opcode.
          *
-         * @param opcode[in] The opcode.
+         * @param[in] opcode The opcode.
          */
         void SetOpcode(uint32 opcode);
 
@@ -250,7 +251,7 @@ class Instruction : public RefCounted {
         /**
          * Sets the instruction address.
          *
-         * @param address[in] The address.
+         * @param[in] address The address.
          */
         void SetAddress(uint32 address);
 
@@ -273,7 +274,7 @@ class Instruction : public RefCounted {
         /**
          * Defines how much the instruction changes the stack pointer.
          *
-         * @param stack_change[in] Bytes the instruction changes the stack
+         * @param[in] stack_change Bytes the instruction changes the stack
          * pointer by.
          */
         void SetStackChange(int16 stack_change);
@@ -288,7 +289,7 @@ class Instruction : public RefCounted {
         /**
          * Retrieves a instruction parameter.
          *
-         * @param index[in] Index of the parameter to retrieve.
+         * @param[in] index Index of the parameter to retrieve.
          * @return The parameter at the specified index, or nullptr if there
          * is not that many parameters.
          */
@@ -297,14 +298,14 @@ class Instruction : public RefCounted {
         /**
          * Sets the instructions parameters.
          *
-         * @param params[in] The list of instruction parameters.
+         * @param[in] params The list of instruction parameters.
          */
         void SetParams(std::vector<ValuePtr> params);
 
         /**
          * Adds a parameter to the instructions.
          *
-         * @param value[in] The parameter to add.
+         * @param[in] value The parameter to add.
          */
         void AddParam(ValuePtr value);
 
@@ -322,7 +323,7 @@ class Instruction : public RefCounted {
          *
          * See the extended documentation for details.
          *
-         * @params code_gen_data[in] Code generator metadata.
+         * @param[in] code_gen_data Code generator metadata.
          */
         void SetCodeGenData(std::string code_gen_data);
 

+ 5 - 4
V-Gears-Installer/include/decompiler/instruction/KernelCallStackInstruction.h

@@ -27,11 +27,12 @@ class KernelCallStackInstruction : public Instruction{
         /**
          * Process an instruction for code generation.
          *
-         * @param stack[in] The current stack.
-         * @param engine[in] The Engine used for code generation.
-         * @param code_gen[in] The CodeGenerator used for code generation.
+         * @param[in] function The function the instruction is in.
+         * @param[in] stack The current stack.
+         * @param[in] engine The Engine used for code generation.
+         * @param[in] code_gen The CodeGenerator used for code generation.
          */
         virtual void ProcessInst(
-          Function& function, ValueStack &stack, Engine *engine, CodeGenerator *code_gen
+          Function& function, ValueStack& stack, Engine* engine, CodeGenerator* code_gen
         ) override;
 };

+ 4 - 3
V-Gears-Installer/include/decompiler/instruction/ReturnInstruction.h

@@ -27,9 +27,10 @@ class ReturnInstruction: public Instruction{
         /**
          * Process an instruction for code generation.
          *
-         * @param stack[in] The current stack.
-         * @param engine[in] The Engine used for code generation.
-         * @param code_gen[in] The CodeGenerator used for code generation.
+         * @param[in] function The function the instruction is in.
+         * @param[in] stack The current stack.
+         * @param[in] engine The Engine used for code generation.
+         * @param[in] code_gen The CodeGenerator used for code generation.
          */
         virtual void ProcessInst(
           Function& function, ValueStack &stack, Engine *engine, CodeGenerator *code_gen

+ 7 - 4
V-Gears-Installer/include/decompiler/instruction/UnaryOpPostfixStackInstruction.h

@@ -18,7 +18,9 @@
 #include "UnaryOpInstruction.h"
 
 /**
- * Default implementation for stack-based instruction performing a unary operation, with a postfixed operator.
+ * Base implementation for stack-based instruction for unary operations.
+ *
+ * The operations use a postfixed operator.
  */
 class UnaryOpPostfixStackInstruction: public UnaryOpInstruction{
 
@@ -27,9 +29,10 @@ class UnaryOpPostfixStackInstruction: public UnaryOpInstruction{
         /**
          * Process an instruction for code generation.
          *
-         * @param stack[in] The current stack.
-         * @param engine[in] The Engine used for code generation.
-         * @param code_gen[in] The CodeGenerator used for code generation.
+         * @param[in] function The function the instruction is in.
+         * @param[in] stack The current stack.
+         * @param[in] engine The Engine used for code generation.
+         * @param[in] code_gen The CodeGenerator used for code generation.
          */
         virtual void ProcessInst(
           Function& function, ValueStack &stack, Engine *engine, CodeGenerator *code_gen

+ 7 - 4
V-Gears-Installer/include/decompiler/instruction/UnaryOpPrefixStackInstruction.h

@@ -18,7 +18,9 @@
 #include "UnaryOpInstruction.h"
 
 /**
- * Default implementation for stack-based instruction performing a unary operation, with a prefixed operator.
+ * Base implementation for stack-based instruction for unary operations
+ *
+ * The operations use a prefixed operator.
  */
 class UnaryOpPrefixStackInstruction: public UnaryOpInstruction{
 
@@ -27,9 +29,10 @@ class UnaryOpPrefixStackInstruction: public UnaryOpInstruction{
         /**
          * Process an instruction for code generation.
          *
-         * @param stack[in] The current stack.
-         * @param engine[in] The Engine used for code generation.
-         * @param code_gen[in] The CodeGenerator used for code generation.
+         * @param[in] function The function the instruction is in.
+         * @param[in] stack The current stack.
+         * @param[in] engine The Engine used for code generation.
+         * @param[in] code_gen The CodeGenerator used for code generation.
          */
         virtual void ProcessInst(
           Function& function, ValueStack &stack, Engine *engine, CodeGenerator *code_gen

+ 4 - 3
V-Gears-Installer/include/decompiler/instruction/UncondJumpInstruction.h

@@ -35,9 +35,10 @@ class UncondJumpInstruction: public JumpInstruction{
         /**
          * Process an instruction for code generation.
          *
-         * @param stack[in] The current stack.
-         * @param engine[in] The Engine used for code generation.
-         * @param code_gen[in] The CodeGenerator used for code generation.
+         * @param[in] function The function the instruction is in.
+         * @param[in] stack The current stack.
+         * @param[in] engine The Engine used for code generation.
+         * @param[in] code_gen The CodeGenerator used for code generation.
          */
         virtual void ProcessInst(
           Function& function, ValueStack &stack, Engine *engine, CodeGenerator *code_gen

+ 7 - 7
V-Gears-Installer/include/decompiler/world/WorldCodeGenerator.h

@@ -27,8 +27,8 @@ class WorldCodeGenerator : public CodeGenerator{
         /**
          * Constructor.
          *
-         * @param engine[in] The engine.
-         * @param output[out] The generated script.
+         * @param[in] engine The engine.
+         * @param[out] output The generated script.
          */
         WorldCodeGenerator(Engine *engine, std::ostream &output);
 
@@ -49,9 +49,9 @@ class WorldCodeGenerator : public CodeGenerator{
         /**
          * Processes special metadata in an instruction.
          *
-         * @param inst[in] The instruction to process.
-         * @param c[in]
-         * @param pos[in]
+         * @param[in] inst The instruction to process.
+         * @param[in] c
+         * @param[in] pos
          * @todo understand and document.
          */
         virtual void ProcessSpecialMetadata(const InstPtr inst, char c, int pos);
@@ -64,9 +64,9 @@ class WorldCodeGenerator : public CodeGenerator{
          * The function signature is the LUA function declaration, and it
          * looks like this:
          *
-         * <function_name> = function(self)
+         * function_name = function(self)
          *
-         * @param function[in] The function to construct the signature for.
+         * @param[in] function The function to construct the signature for.
          * @return The function signature.
          */
         std::string ConstructFuncSignature(const Function &function);

+ 8 - 8
V-Gears-Installer/include/decompiler/world/WorldDisassembler.h

@@ -26,9 +26,9 @@ class WorldDisassembler : public Disassembler{
         /**
          * CConstructor.
          *
-         * @param engine[in] The engine to use to disassemble.
-         * @param insts[in] The list of instructions.
-         * @param script_number[in] The script number to process.
+         * @param[in] engine The engine to use to disassemble.
+         * @param[in] insts The list of instructions.
+         * @param[in] script_number The script number to process.
          */
         WorldDisassembler(WorldEngine* engine, InstVec& insts, int script_number);
 
@@ -50,13 +50,13 @@ class WorldDisassembler : public Disassembler{
          * Adds properties to an instruction, and adds the instruction to the
          * list.
          *
-         * @param opcode[in] The opcode code.
-         * @param name[in] the opcode name.
-         * @param instruction[in][out] A newly created instruction of the type
+         * @param[in] opcode The opcode code.
+         * @param[in] name the opcode name.
+         * @param[in] instruction A newly created instruction of the type
          * the opcode belongs to.
-         * @param stack_change[in] Indicates how much the instruction changes
+         * @param[in] stack_change Indicates how much the instruction changes
          * the stack pointer by.
-         * @param argument_format[in] The opcode argument format.
+         * @param[in] argument_format The opcode argument format.
          */
         template<typename T> void ParseOpcode(
           int opcode, std::string name, T instruction, int stack_change, const char* argument_format

+ 7 - 7
V-Gears-Installer/include/decompiler/world/WorldEngine.h

@@ -42,7 +42,7 @@ class WorldEngine : public Engine{
                 /**
                  * Constructor.
                  *
-                 * @param name[in] Variable name.
+                 * @param[in] name Variable name.
                  */
                 BankValue(std::string name);
         };
@@ -50,14 +50,14 @@ class WorldEngine : public Engine{
         /**
          * Constructor.
          *
-         * @param script_number[in] The script number.
+         * @param[in] script_number The script number.
          */
         WorldEngine(int script_number);
 
         /**
          * Retrieves the disassembler.
          *
-         * @param insts[in] List of instructions.
+         * @param[in] insts List of instructions.
          * @return Pointer to the disassembler.
          */
         std::unique_ptr<Disassembler> GetDisassembler(InstVec &insts) override;
@@ -65,8 +65,8 @@ class WorldEngine : public Engine{
         /**
          * Retrieves the code generator.
          *
-         * @param insts[in] List of instructions. Unused.
-         * @param output[in] Pointer to the output (file, stream...).
+         * @param[in] insts List of instructions. Unused.
+         * @param[in] output Pointer to the output (file, stream...).
          * @return Pointer to the generator.
          */
         std::unique_ptr<CodeGenerator> GetCodeGenerator(
@@ -78,8 +78,8 @@ class WorldEngine : public Engine{
          *
          * It actually does nothing. CFG stands for control flow group.
          *
-         * @param insts[in] Instruction list.
-         * @param graph[in] Code graph.
+         * @param[in] insts Instruction list.
+         * @param[in] graph Code graph.
          */
         virtual void PostCFG(InstVec &insts, Graph graph) override;
 

+ 4 - 4
V-Gears-Installer/include/decompiler/world/instruction/WorldBinaryEqualStackInstruction.h

@@ -30,10 +30,10 @@ class WorldBinaryEqualStackInstruction : public BinaryOpStackInstruction{
         /**
          * Processes the instruction.
          *
-         * @param function[in] Function to process.
-         * @param stack[out] Function stack.
-         * @param engine[in] Engine.
-         * @param code_gen[in] Code generator.
+         * @param[in] function Function to process.
+         * @param[out] stack Function stack.
+         * @param[in] engine Engine.
+         * @param[in] code_gen Code generator.
          */
         virtual void ProcessInst(
           Function& function, ValueStack &stack, Engine *engine, CodeGenerator *code_gen

+ 5 - 5
V-Gears-Installer/include/decompiler/world/instruction/WorldCondJumpInstruction.h

@@ -30,10 +30,10 @@ class WorldCondJumpInstruction : public CondJumpInstruction{
         /**
          * Processes the instruction.
          *
-         * @param function[in] Function to process.
-         * @param stack[out] Function stack.
-         * @param engine[in] Engine.
-         * @param code_gen[in] Code generator.
+         * @param[in] function Function to process.
+         * @param[out] stack Function stack.
+         * @param[in] engine Engine.
+         * @param[in] code_gen Code generator.
          */
         virtual void ProcessInst(
           Function& function, ValueStack &stack, Engine *engine, CodeGenerator *code_gen
@@ -49,7 +49,7 @@ class WorldCondJumpInstruction : public CondJumpInstruction{
         /**
          * Prints the instruction.
          *
-         * @param output[in] The output to print.
+         * @param[in] output The output to print.
          * @return The same as output.
          */
         virtual std::ostream& Print(std::ostream &output) const override;

+ 4 - 4
V-Gears-Installer/include/decompiler/world/instruction/WorldKernelCallInstruction.h

@@ -30,10 +30,10 @@ class WorldKernelCallInstruction : public KernelCallInstruction{
         /**
          * Processes the instruction.
          *
-         * @param function[in] Function to process. Unused.
-         * @param stack[out] Function stack.
-         * @param engine[in] Engine. Unused.
-         * @param code_gen[in] Code generator.
+         * @param[in] function Function to process. Unused.
+         * @param[out] stack Function stack.
+         * @param[in] engine Engine. Unused.
+         * @param[in] code_gen Code generator.
          */
         virtual void ProcessInst(
           Function& function, ValueStack &stack, Engine *engine, CodeGenerator *code_gen

+ 4 - 4
V-Gears-Installer/include/decompiler/world/instruction/WorldLoadBankInstruction.h

@@ -30,10 +30,10 @@ class WorldLoadBankInstruction : public LoadInstruction{
         /**
          * Processes the instruction.
          *
-         * @param function[in] Function to process. Unused.
-         * @param stack[out] Function stack.
-         * @param engine[in] Engine. Unused.
-         * @param code_gen[in] Code generator. Unused.
+         * @param[in] function Function to process. Unused.
+         * @param[out] stack Function stack.
+         * @param[in] engine Engine. Unused.
+         * @param[in] code_gen Code generator. Unused.
          */
         virtual void ProcessInst(
           Function& function, ValueStack &stack, Engine *engine, CodeGenerator *code_gen

+ 4 - 4
V-Gears-Installer/include/decompiler/world/instruction/WorldLoadInstruction.h

@@ -30,10 +30,10 @@ class WorldLoadInstruction : public LoadInstruction{
         /**
          * Processes the instruction.
          *
-         * @param function[in] Function to process. Unused.
-         * @param stack[out] Function stack.
-         * @param engine[in] Engine. Unused.
-         * @param code_gen[in] Code generator. Unused.
+         * @param[in] function Function to process. Unused.
+         * @param[out] stack Function stack.
+         * @param[in] engine Engine. Unused.
+         * @param[in] code_gen Code generator. Unused.
          */
         virtual void ProcessInst(
           Function& function, ValueStack &stack, Engine *engine, CodeGenerator *code_gen

+ 4 - 4
V-Gears-Installer/include/decompiler/world/instruction/WorldNoOutputInstruction.h

@@ -30,10 +30,10 @@ class WorldNoOutputInstruction : public Instruction{
         /**
          * Processes the instruction.
          *
-         * @param function[in] Function to process.
-         * @param stack[out] Function stack.
-         * @param engine[in] Engine.
-         * @param code_gen[in] Code generator.
+         * @param[in] function Function to process.
+         * @param[out] stack Function stack.
+         * @param[in] engine Engine.
+         * @param[in] code_gen Code generator.
          */
         virtual void ProcessInst(
           Function& function, ValueStack &stack, Engine *engine, CodeGenerator *code_gen

+ 4 - 4
V-Gears-Installer/include/decompiler/world/instruction/WorldStackInstruction.h

@@ -30,10 +30,10 @@ class WorldStackInstruction : public StackInstruction{
         /**
          * Processes the instruction.
          *
-         * @param function[in] Function to process.
-         * @param stack[out] Function stack.
-         * @param engine[in] Engine.
-         * @param code_gen[in] Code generator.
+         * @param[in] function Function to process.
+         * @param[out] stack Function stack.
+         * @param[in] engine Engine.
+         * @param[in] code_gen Code generator.
          */
         virtual void ProcessInst(
           Function& function, ValueStack &stack, Engine *engine, CodeGenerator *code_gen

+ 4 - 4
V-Gears-Installer/include/decompiler/world/instruction/WorldStoreInstruction.h

@@ -30,10 +30,10 @@ class WorldStoreInstruction : public StoreInstruction{
         /**
          * Processes the instruction.
          *
-         * @param function[in] Function to process. Unused.
-         * @param stack[out] Function stack.
-         * @param engine[in] Engine. Unused.
-         * @param code_gen[in] Code generator.
+         * @param[in] function Function to process. Unused.
+         * @param[out] stack Function stack.
+         * @param[in] engine Engine. Unused.
+         * @param[in] code_gen Code generator.
          */
         virtual void ProcessInst(
           Function& function, ValueStack &stack, Engine *engine, CodeGenerator *code_gen

+ 4 - 4
V-Gears-Installer/include/decompiler/world/instruction/WorldSubStackInstruction.h

@@ -30,10 +30,10 @@ class WorldSubStackInstruction : public StackInstruction{
         /**
          * Processes the instruction.
          *
-         * @param func[in] Function to process. Unused.
-         * @param stack[out] Function stack.
-         * @param engine[in] Engine. Unused.
-         * @param code_gen[in] Code generator. Unused.
+         * @param[in] function Function to process. Unused.
+         * @param[out] stack Function stack.
+         * @param[in] engine Engine. Unused.
+         * @param[in] code_gen Code generator. Unused.
          */
         virtual void ProcessInst(
           Function& function, ValueStack &stack, Engine *engine, CodeGenerator *code_gen

+ 4 - 4
V-Gears-Installer/include/decompiler/world/instruction/WorldUncondJumpInstruction.h

@@ -67,10 +67,10 @@ class WorldUncondJumpInstruction : public UncondJumpInstruction{
         /**
          * Processes the instruction.
          *
-         * @param function[in] Function to process.
-         * @param stack[out] Function stack.
-         * @param engine[in] Engine.
-         * @param code_gen[in] Code generator.
+         * @param[in] function Function to process.
+         * @param[out] stack Function stack.
+         * @param[in] engine Engine.
+         * @param[in] code_gen Code generator.
          */
         virtual void ProcessInst(
           Function& function, ValueStack &stack, Engine *engine, CodeGenerator *code_gen

+ 62 - 62
V-Gears-Installer/src/DataInstaller.cpp

@@ -141,7 +141,7 @@ std::vector<std::string> materials_;
  *
  * The image is saved in data/models/ffvii/field/units/
  *
- * @param name[in] Path to the tex file to convert.
+ * @param[in] name Path to the tex file to convert.
  */
 void TexToPng(const std::string name){
     Ogre::DataStreamPtr stream(
@@ -181,8 +181,8 @@ void TexToPng(const std::string name){
  *
  * The file will have the mesh name.
  *
- * @param outdir[in] Path to the directory where the file will be saved.
- * @param mesh[in] The mesh to export.
+ * @param[in] outdir Path to the directory where the file will be saved.
+ * @param[in] mesh The mesh to export.
  */
 static void ExportMesh(const std::string outdir, const Ogre::MeshPtr &mesh){
 
@@ -284,7 +284,7 @@ static void ExportMesh(const std::string outdir, const Ogre::MeshPtr &mesh){
  *
  * It prefixes a name witg "ffvii_".
  *
- * @param name[in] The field name.
+ * @param[in] name The field name.
  * @return The normalized field name.
  */
 static std::string FieldName(const std::string& name){return "ffvii_" + name;}
@@ -312,9 +312,9 @@ class BaseFF7FieldScriptFormatter : public FieldScriptFormatter{
         /**
          * Constructor.
          *
-         * @param field_name[in] The field name.
-         * @param field_id_to_name_lookup[in] Field name lookup table to use.
-         * @param spawn_points[in] The list of spawn points.
+         * @param[in] field_name The field name.
+         * @param[in] field_id_to_name_lookup Field name lookup table to use.
+         * @param[in] spawn_points The list of spawn points.
          */
         BaseFF7FieldScriptFormatter(
           const std::string& field_name, const std::vector<std::string>& field_id_to_name_lookup,
@@ -330,10 +330,10 @@ class BaseFF7FieldScriptFormatter : public FieldScriptFormatter{
          * The name will have the format
          * {FIELD_NAME}_{ENTITY}_{FUNCTION_NAME}_addr_{ADDRESS}
          *
-         * @param map_id[in] Unused.
-         * @param entity[in] Entity name.
-         * @param function_name[in] Name of the function.
-         * @param address[in] @todo Understand and document.
+         * @param[in] map_id Unused.
+         * @param[in] entity Entity name.
+         * @param[in] function_name Name of the function.
+         * @param[in] address @todo Understand and document.
          * @return The composed spawn point name.
          */
         virtual std::string GetSpawnPointName(
@@ -347,7 +347,7 @@ class BaseFF7FieldScriptFormatter : public FieldScriptFormatter{
         /**
          * Retrieves a map name from it's ID.
          *
-         * @param[in] The map ID.
+         * @param[in] map_id The map ID.
          * @return The map name.
          */
         virtual std::string GetMapName(unsigned int map_id) override{
@@ -357,8 +357,8 @@ class BaseFF7FieldScriptFormatter : public FieldScriptFormatter{
         /**
          * Retrieves a user friendly variable name.
          *
-         * @param bank[in] Variable bank.
-         * @param address[in] Variable address.
+         * @param[in] bank Variable bank.
+         * @param[in] addr Variable address.
          * @return Friendly name for the variable, or an empty string if it
          * doesn't have one assigned.
          */
@@ -371,7 +371,7 @@ class BaseFF7FieldScriptFormatter : public FieldScriptFormatter{
         /**
          * Retrieves a user friendly entity name.
          *
-         * @param entity[in] Entity name.
+         * @param[in] entity Entity name.
          * @return Friendly name for the entity, or the current name if it
          * doesn't have one assigned.
          */
@@ -382,7 +382,7 @@ class BaseFF7FieldScriptFormatter : public FieldScriptFormatter{
         /**
          * Retrieves a user friendly character name.
          *
-         * @param char_id[in] Character ID.
+         * @param[in] char_id Character ID.
          * @return Friendly name for the entity, or an empty string if it
          * doesn't have one assigned.
          */
@@ -393,8 +393,8 @@ class BaseFF7FieldScriptFormatter : public FieldScriptFormatter{
         /**
          * Retrieves a user friendly function name.
          *
-         * @param entity[in] The name of the entity the function belongs to.
-         * @param function_name[in] Function name.
+         * @param[in] entity The name of the entity the function belongs to.
+         * @param[in] function_name Function name.
          * @return Friendly name for the function, or the current name if it
          * doesn't have one assigned.
          */
@@ -409,8 +409,8 @@ class BaseFF7FieldScriptFormatter : public FieldScriptFormatter{
         /**
          * Retrieves the header comment for a function in an entity.
          *
-         * @param entity[in] The name of the entity the function belongs to.
-         * @param function_name[in] Function name.
+         * @param[in] entity The name of the entity the function belongs to.
+         * @param[in] function_name Function name.
          * @return Friendly comment for the function, or an empty string if it
          * doesn't have one assigned.
          */
@@ -450,10 +450,10 @@ class FF7FieldScriptFormatter : public BaseFF7FieldScriptFormatter{
         /**
          * Constructor.
          *
-         * @param field_name[in] The field name.
-         * @param models[in] The list of field models.
-         * @param field_id_to_name_lookup[in] Field name lookup table to use.
-         * @param spawn_points[in] The list of spawn points.
+         * @param[in] field_name The field name.
+         * @param[in] models The list of field models.
+         * @param[in] field_id_to_name_lookup Field name lookup table to use.
+         * @param[in] spawn_points The list of spawn points.
          */
         FF7FieldScriptFormatter(
           const std::string& field_name, const VGears::ModelListFilePtr& models,
@@ -468,8 +468,8 @@ class FF7FieldScriptFormatter : public BaseFF7FieldScriptFormatter{
         /**
          * Retreieves an animation name from iths ID.
          *
-         * @param char_id[in] ID of the character the animation belogs to.
-         * @param id[in] Animation ID.
+         * @param[in] char_id ID of the character the animation belogs to.
+         * @param[in] id Animation ID.
          * @return The animation name. If there is no name assigned, or it
          * can't be found, a string with the animation ID.
          */
@@ -508,9 +508,9 @@ class FF7FieldScriptFormatter : public BaseFF7FieldScriptFormatter{
 /**
  * Creates a gateway script.
  *
- * @param gateway_entity_name[in] Name of the gateway entity.
- * @param target_map_name[in] Name of the target map.
- * @param source_spawn_point_name[in] The spawn point name.
+ * @param[in] gateway_entity_name Name of the gateway entity.
+ * @param[in] target_map_name Name of the target map.
+ * @param[in] source_spawn_point_name The spawn point name.
  * @return Gateway LUA script.
  */
 static std::string CreateGateWayScript(
@@ -545,15 +545,15 @@ static std::string CreateGateWayScript(
 }
 
 /**
- * Gateways to whis map ID are considered to be inactive.
+ * Gateways whith map ID are considered to be inactive.
  */
 const int INACTIVE_GATEWAY_ID = 32767;
 
 /**
  * Retrieves a field ID from a name.
  *
- * @param name[in] The name of the field.
- * @param field_id_to_name_lookup[in] Lookup table to use.
+ * @param[in] name The name of the field.
+ * @param[in] field_id_to_name_lookup Lookup table to use.
  * @return The field ID for the specified name.
  * @throws std::runtime_error If there is no ID for the field name.
  */
@@ -567,11 +567,11 @@ static size_t FieldId(
 }
 
 /**
- * Retrievs a field scale factor.
+ * Retrieves a field scale factor.
  *
- * @param name[in] The name of the field.
- * @param field_id_to_name_lookup[in] Lookup table to use.
- * @return The field ID for the specified name.
+ * @param[in] scale_factor_map Lookup table of map scale factors.
+ * @param[in] field_id The id (name) of the field.
+ * @return The scale factor for the map.
  * @throws std::runtime_error If there is no ID for the field name.
  */
 static float FieldScaleFactor(
@@ -586,17 +586,17 @@ static float FieldScaleFactor(
 /**
  * Converts a FFVII PC field to a V-Gears field.
  *
- * @param field_text_writter[in] The field text writer.
- * @param field[in] The field map.
- * @param out_dir[in] The path to the directory where to save the map file.
- * @param field_id_to_name_lookup[in] Lookup table used to relate map IDs and
+ * @param[in] field_text_writter The field text writer.
+ * @param[in] field The field map.
+ * @param[in] out_dir The path to the directory where to save the map file.
+ * @param[in] field_id_to_name_lookup Lookup table used to relate map IDs and
  * names
- * @param spawn_map[in] List of spawn points.
- * @param scale_factor_map[in] List of scale factors.
- * @param model_animation_db[in] Database of model animations.
- * @param maps[out] The list of maps. The converted one will be added at the
+ * @param[in] spawn_map List of spawn points.
+ * @param[in] scale_factor_map List of scale factors.
+ * @param[in] model_animation_db Database of model animations.
+ * @param[out] maps The list of maps. The converted one will be added at the
  * end.
- * @param write_output_line[in] Functon to print output to console.
+ * @param[in] write_output_line Functon to print output to console.
  */
 static void FF7PcFieldToVGearsField(
   FieldTextWriter& field_text_writter,
@@ -1019,14 +1019,14 @@ class FF7FieldScriptGatewayCollector : public BaseFF7FieldScriptFormatter{
          * database. If it was already there, update the record to add the
          * origin.
          *
-         * @param map_id[in] The target map ID.
-         * @param entity[in] The entity that acts as the spawn point.
-         * @param function_name[in] The spawn function name.
-         * @param address[in] @todo Understand and document.
-         * @param x[in] X coordinate of the field target at which to spawn.
-         * @param y[in] Y coordinate of the field target at which to spawn.
-         * @param z[in] Z coordinate of the field target at which to spawn.
-         * @param angle[in] Orientation at which to spawn.
+         * @param[in] map_id The target map ID.
+         * @param[in] entity The entity that acts as the spawn point.
+         * @param[in] function_name The spawn function name.
+         * @param[in] address @todo Understand and document.
+         * @param[in] x X coordinate of the field target at which to spawn.
+         * @param[in] y Y coordinate of the field target at which to spawn.
+         * @param[in] z Z coordinate of the field target at which to spawn.
+         * @param[in] angle Orientation at which to spawn.
          */
         virtual void AddSpawnPoint(
           unsigned int map_id, const std::string& entity, const std::string& function_name,
@@ -1081,10 +1081,10 @@ class FF7FieldScriptGatewayCollector : public BaseFF7FieldScriptFormatter{
  * If a spawn is new, a new record will be added to the spawn point database.
  * If it was already there, update the record to add the origin.
  *
- * @param field[in] The field to collect from.
- * @param field_id_to_name_lookup[in] Lookup table to relate field IDs and
+ * @param[in] field The field to collect from.
+ * @param[in] field_id_to_name_lookup Lookup table to relate field IDs and
  * names.
- * @param spawn_points[out] Spawn points will be added sequentially to the end
+ * @param[out] spawn_points Spawn points will be added sequentially to the end
  * of this map.
  */
 static void CollectSpawnPoints(
@@ -1145,7 +1145,7 @@ static void CollectSpawnPoints(
  * To verify it, it just checks that the extension is not '.tex', '.tut' or
  * '.siz' and that the name is not 'maplist'.
  *
- * @param resource_name[in] The name of the file to test.
+ * @param[in] resource_name The name of the file to test.
  * @return False if the file is surely not a field file, true otherwise.
  */
 static bool IsAFieldFile(const Ogre::String& resource_name){
@@ -1167,7 +1167,7 @@ static bool IsAFieldFile(const Ogre::String& resource_name){
  * NOTE: Even so, conversion of all models will fail with a bone index out of
  * bounds.
  *
- * @param resource_name[in] The name of the map file to test.
+ * @param[in] resource_name The name of the map file to test.
  * @return True if the map will crash, false otherwise.
  */
 static bool WillCrash(const Ogre::String& resource_name){
@@ -1190,7 +1190,7 @@ static bool WillCrash(const Ogre::String& resource_name){
  * It uses a hardcoded list of maps that are known to be test maps. Unused maps
  * are considered to be test maps.
  *
- * @param resource_name[in] The name of the map file to test.
+ * @param[in] resource_name The name of the map file to test.
  * @return True if the map is a test map, false otherwise.
  */
 static bool IsTestField(const Ogre::String& resource_name){
@@ -1218,10 +1218,10 @@ static bool IsTestField(const Ogre::String& resource_name){
 /**
  * Collects the scale factor from a map.
  *
- * @param field[in] The field to collect from.
- * @param scale_factors[out] The scale factor for the map will be set here, in
+ * @param[in] field The field to collect from.
+ * @param[out] scale_factors The scale factor for the map will be set here, in
  * the appropiate map entry.
- * @param field_id_to_name_lookup[in] Lookup table to relate field IDs and
+ * @param[in] field_id_to_name_lookup Lookup table to relate field IDs and
  * names.
  */
 static void CollectFieldScaleFactors(

+ 8 - 8
V-Gears-Installer/src/decompiler/ControlFlow.cpp

@@ -24,31 +24,31 @@
 /**
  * Adds a vertex to a group.
  *
- * @param vertex[in] Vertex to add.
- * @param group[in] Group to add the vertex to.
+ * @param[in] vertex Vertex to add.
+ * @param[in] group Group to add the vertex to.
  */
 #define PUT(vertex, group) boost::put(boost::vertex_name, graph_, vertex, group);
 
 /**
  * Adds an edge to the graph.
  *
- * @param edge[in] The edge to add.
- * @param is_jump[in] Indicates if the edge is a jump.
+ * @param[in] edge The edge to add.
+ * @param[in] is_jump Indicates if the edge is a jump.
  */
 #define PUT_EDGE(edge, is_jump) boost::put(boost::edge_attribute, graph_, edge, is_jump);
 
 /**
  * Adds a vertex to the graph.
  *
- * @param vertex[in] The vertex to add.
- * @param id[in] The vertext index.
+ * @param[in] vertex The vertex to add.
+ * @param[in] id The vertext index.
  */
 #define PUT_ID(vertex, id) boost::put(boost::vertex_index, graph_, vertex, id);
 
 /**
  * Retrieves a vertex.
  *
- * @param vertex[in] The vertex.
+ * @param[in] vertex The vertex.
  * @return The retrieved vertex.
  */
 #define GET(vertex) (boost::get(boost::vertex_name, graph_, vertex))
@@ -56,7 +56,7 @@
 /**
  * Retrieves an edge.
  *
- * @param edge[in] The edge.
+ * @param[in] edge The edge.
  * @return The retrieved edge.
  */
 #define GET_EDGE(edge) (boost::get(boost::edge_attribute, graph_, edge))

+ 2 - 2
V-Gears-Installer/src/decompiler/Disassembler.cpp

@@ -41,7 +41,7 @@ void Disassembler::DumpDisassembly(std::ostream &output){
 /**
  * NIB is probably for nibble.
  *
- * @param v[in] @todo Understand and document.
+ * @param[in] v @todo Understand and document.
  * @return @todo Understand and document.
  */
 static inline unsigned int Nib2(unsigned int v){return (v & 0xF);}
@@ -49,7 +49,7 @@ static inline unsigned int Nib2(unsigned int v){return (v & 0xF);}
 /**
  * NIB is probably for nibble.
  *
- * @param v[in] @todo Understand and document.
+ * @param[in] v @todo Understand and document.
  * @return @todo Understand and document.
  */
 static inline unsigned int Nib1(unsigned int v){return (v >> 4) & 0xF;}

+ 1 - 1
V-Gears-Installer/src/decompiler/Engine.cpp

@@ -27,6 +27,6 @@ bool Engine::SupportsCodeFlow() const{return true;}
 
 bool Engine::SupportsCodeGen() const{return true;}
 
-void Engine::GetVariants(std::vector<std::string>&) const{};
+void Engine::GetVariants(std::vector<std::string>& variants) const{};
 
 bool Engine::UsePureGrouping() const{return false;}

+ 3 - 46
V-Gears-Installer/src/decompiler/ScriptFormatter.cpp

@@ -15,65 +15,22 @@
 
 #include "decompiler/ScriptFormatter.h"
 
-/**
- * Retrieves a friendly name for a variable.
- *
- * @param bank[in] Variable memory bank.
- * @param address[in] Variable memory address.
- * @return Friendly name assigned to the variable, or an empty
- * string if there is none.
- */
 std::string ScriptFormatter::GetFriendlyVarName(unsigned int bank, unsigned int addr){return "";}
 
-/**
- * Retrieves a friendly name for an entity.
- *
- * @param entity_name[in] Name of the entity.
- * @return Friendly name assigned to the entity, or <entity_name>
- * if there is none.
- */
-std::string ScriptFormatter::GetFriendlyEntityName(const std::string& entity_name){return entity_name;}
+std::string ScriptFormatter::GetFriendlyEntityName(const std::string& entity_name){
+    return entity_name;
+}
 
-/**
- * Retrieves a friendly name for an animation.
- *
- * @param animation_id[in] ID of the animation.
- * @return Friendly name assigned to the animation. If there is
- * no one, the ID in string format.
- */
 std::string ScriptFormatter::GetFriendlyAnimationName(int animation_id, int id){
     return std::to_string(animation_id);
 }
 
-/**
- * Retrieves a friendly name for a character.
- *
- * @param char_id[in] ID of the character.
- * @return Friendly name assigned to the character. If there is
- * no one, the ID in string format.
- */
 std::string ScriptFormatter::GetFriendlyCharName(int char_id){return std::to_string(char_id);}
 
-/**
- * Retrieves a friendly name for a function.
- *
- * @param entity_name[in] Name of the entity.
- * @param function_name[in] Name of the function.
- * @return Friendly name assigned to the entity, or
- * <function_name> if there is none.
- */
 std::string ScriptFormatter::GetFriendlyFunctionName(
   const std::string& entity_name, const std::string& function_name
 ){return function_name;}
 
-/**
- * Retrieves the header comment for a function in an entity.
- *
- * @param entity_name[in] Name of the entity.
- * @param function_name[in] Name of the function.
- * @return The function comment. An empty string if the entity or
- * the function don't exist.
- */
 std::string ScriptFormatter::GetFunctionComment(
   const std::string& entity_name, const std::string& function_name
 ){return "";}

+ 0 - 17
V-Gears-Installer/src/decompiler/field/FieldScriptFormatter.cpp

@@ -20,15 +20,6 @@ void FieldScriptFormatter::AddSpawnPoint(
   unsigned int address, int x, int y, int triangle_id, int angle
 ){}
 
-/**
- * Retrieves the name of a spawn point.
- *
- * @param map_id[in] The target map ID.
- * @param entity[in] The entity that acts as the spawn point.
- * @param function_name[in] The spawn function name.
- * @param address[in] @todo Understand and document.
- * @return The name of the spawn point.
- */
 std::string FieldScriptFormatter::GetSpawnPointName(
   unsigned int map_id, const std::string& entity,
   const std::string& function_name, unsigned int address
@@ -37,12 +28,4 @@ std::string FieldScriptFormatter::GetSpawnPointName(
       + "_" + entity + "_" + function_name + "_" + std::to_string(address);
 }
 
-/**
- * Retrieves the name of a map.
- *
- * The name of a map is usually it's ID.
- *
- * @param map_id[in] The map ID.
- * @return The map name.
- */
 std::string FieldScriptFormatter::GetMapName(unsigned int map_id) { return std::to_string(map_id);}

+ 2 - 2
V-Gears-Installer/src/main.cpp

@@ -20,8 +20,8 @@
 /**
  * Installer main function.
  *
- * @param argc[in] Number of arguments passed to the application.
- * @param argv[in] List of arguments passed to the application.
+ * @param[in] argc Number of arguments passed to the application.
+ * @param[in] argv List of arguments passed to the application.
  * @return The application return code. 0 is OK.
  */
 int main(int argc, char *argv[]){

+ 1 - 1
V-Gears/include/FF7Character.h

@@ -91,7 +91,7 @@ class Character{
         /**
          * Retrieves a character ID from it's name.
          *
-         * @param name[in] Chaarcter name.
+         * @param[in] name Chaarcter name.
          * @return ID of the character with the specified name, or {@see
          * UNKNOWN} if the character doesn't exist.
          */

+ 15 - 15
V-Gears/include/common/File.h

@@ -28,32 +28,32 @@ class File{
         /**
          * Opens a file.
          *
-         * @param file[in] Path to the file.
+         * @param[in] file Path to the file.
          */
         File(const Ogre::String& file);
 
         /**
          * Opens a file.
          *
-         * @param file[in] Pointer to the file.
+         * @param[in] file Pointer to the file.
          */
         File(const File* file);
 
         /**
          * Loads a file fragment.
          *
-         * @param file[in] Pointer to the file.
-         * @param offset[in] Offset to the data to load.
-         * @param length[in] Length of the data to load.
+         * @param[in] file Pointer to the file.
+         * @param[in] offset Offset to the data to load.
+         * @param[in] length Length of the data to load.
          */
         File(const File* file, u32 offset, u32 length);
 
         /**
          * Loads a file fragment from a buffer.
          *
-         * @param buffer[in] Pointer to the buffer to load from.
-         * @param offset[in] Offset to the data to load.
-         * @param length[in] Length of the data to load.
+         * @param[in] buffer Pointer to the buffer to load from.
+         * @param[in] offset Offset to the data to load.
+         * @param[in] length Length of the data to load.
          */
         File(const u8* buffer, u32 offset, u32 length);
 
@@ -72,7 +72,7 @@ class File{
         /**
          * Retrieves the file name.
          *
-         * @The file name, without path.
+         * @return The file name, without path.
          */
         const Ogre::String& GetFileName() const;
 
@@ -86,9 +86,9 @@ class File{
         /**
          * Loads a buffer with the file data.
          *
-         * @param buffer[out] Pointer to the buffer to load.
-         * @param start[in] Offset to the data to load.
-         * @param length[in] Length of the data to load.
+         * @param[out] buffer Pointer to the buffer to load.
+         * @param[in] start Offset to the data to load.
+         * @param[in] length Length of the data to load.
          */
         void GetFileBuffer(
           u8* buffer, const u32 &start, const u32 &length
@@ -97,7 +97,7 @@ class File{
         /**
          * Retrieves a pointer to a byte address in the file.
          *
-         * @param offset[in] The offset to the requested address.
+         * @param[in] offset The offset to the requested address.
          */
         u8 GetU8(u32 offset) const;
 
@@ -106,7 +106,7 @@ class File{
          *
          * The data must b considered to be in little endian.
          *
-         * @param offset[in] The offset to the requested address.
+         * @param[in] offset The offset to the requested address.
          */
         u16 GetU16LE(u32 offset) const;
 
@@ -115,7 +115,7 @@ class File{
          *
          * The data must b considered to be in little endian.
          *
-         * @param offset[in] The offset to the requested address.
+         * @param[in] offset The offset to the requested address.
          */
         u32 GetU32LE(u32 offset) const;
 

+ 11 - 11
V-Gears/include/common/FileSystem.h

@@ -32,7 +32,7 @@ class FileSystem{
         /**
          * Retrieves a file size.
          *
-         * @param path[in] Path to the file.
+         * @param[in] path Path to the file.
          * @return File size, in bytes. 0 on error.
          */
         static unsigned int GetFileSize(const Ogre::String& path);
@@ -40,10 +40,10 @@ class FileSystem{
         /**
          * Reads a file contents and saves them to a buffer.
          *
-         * @param path[in] Path to the file to read.
-         * @param buffer[out] The buffer to populate with file data.
-         * @param start[in] Offset at which to start reading.
-         * @param lenght[in] Size of the data to read, in bytes.
+         * @param[in] path Path to the file to read.
+         * @param[out] buffer The buffer to populate with file data.
+         * @param[in] start Offset at which to start reading.
+         * @param[in] length Size of the data to read, in bytes.
          * @return True if the file was successfully read, false on error.
          */
         static bool ReadFile(
@@ -56,9 +56,9 @@ class FileSystem{
          *
          * The file must exists, and the new data will be appended at the end.
          *
-         * @param path[in] Path to the file to write.
-         * @param buffer[in] Buffer with the data.
-         * @param length[in] Size of the data to write, in bytes.
+         * @param[in] path Path to the file to write.
+         * @param[in] buffer Buffer with the data.
+         * @param[in] length Size of the data to write, in bytes.
          * @return True if the file was successfully written, false on error.
          */
         static bool WriteFile(
@@ -71,9 +71,9 @@ class FileSystem{
          *
          * If the file exists, it will be deleted before adding the new data.
          *
-         * @param path[in] Path to the file to write.
-         * @param buffer[in] Buffer with the data.
-         * @param length[in] Size of the data to write, in bytes.
+         * @param[in] path Path to the file to write.
+         * @param[in] buffer Buffer with the data.
+         * @param[in] length Size of the data to write, in bytes.
          * @return True if the file was successfully written, false on error.
          */
         static bool WriteNewFile(

+ 30 - 32
V-Gears/include/common/FinalFantasy7/FF7NameLookup.h

@@ -34,7 +34,7 @@ namespace VGears{
             /**
              * Constructor.
              *
-             * @param file[in] The XML file.
+             * @param[in] file The XML file.
              */
             FF7Metadata(Ogre::String file) : XmlFile(file){
                 TiXmlNode* node = file_.RootElement();
@@ -70,7 +70,7 @@ namespace VGears{
              * animation names. Defined names are more user friendly, more
              * readable and more descriptive.
              *
-             * @param key[in] Original game animation name.
+             * @param[in] key Original game animation name.
              * @return Friendly name associated to the animation, or the
              * original name if there is no name associated.
              */
@@ -91,7 +91,7 @@ namespace VGears{
              * model names. Defined names are more user friendly, more
              * readable and more descriptive.
              *
-             * @param key[in] Original game model name.
+             * @param[in] key Original game model name.
              * @return Friendly name associated to the model, or the
              * original name if there is no name associated.
              */
@@ -110,7 +110,7 @@ namespace VGears{
             /**
              * Reads all models from an XML node.
              *
-             * @param node[in] XML node to read.
+             * @param[in] node XML node to read.
              */
             void ReadModels(TiXmlNode* node){
                 while (node){
@@ -124,7 +124,7 @@ namespace VGears{
             /**
              * Reads all models from an XML node.
              *
-             * @param node[in] XML node to read.
+             * @param[in] node XML node to read.
              */
             void ReadAnimations(TiXmlNode* node){
                 while (node){
@@ -139,7 +139,7 @@ namespace VGears{
             /**
              * Reads all scripts from an XML node.
              *
-             * @param node[in] XML node to read.
+             * @param[in] node XML node to read.
              */
             void ReadScripts(TiXmlNode* node){
                 while (node){
@@ -148,16 +148,14 @@ namespace VGears{
                       && node->ValueStr() == "CharacterIds"
                     ){ReadCharacterIds(node->FirstChild());}
                     else if (
-                      node->Type() == TiXmlNode::TINYXML_ELEMENT
-                      && node->ValueStr() == "var_names"
+                      node->Type() == TiXmlNode::TINYXML_ELEMENT && node->ValueStr() == "var_names"
                     ){ReadVarNames(node->FirstChild());}
                     else if (
                       node->Type() == TiXmlNode::TINYXML_ELEMENT
                       && node->ValueStr() == "entity_names"
                     ){ReadEntityNames(node->FirstChild());}
                     else if (
-                      node->Type() == TiXmlNode::TINYXML_ELEMENT
-                      && node->ValueStr() == "field"
+                      node->Type() == TiXmlNode::TINYXML_ELEMENT && node->ValueStr() == "field"
                     ){
                         const auto name = GetString(node, "name");
                         ReadField(node->FirstChild(), name);
@@ -169,7 +167,8 @@ namespace VGears{
             /**
              * Reads field information from an XML node.
              *
-             * @param node[in] XML node to read.
+             * @param[in] node XML node to read.
+             * @param[in] name Unused.
              */
             void ReadField(TiXmlNode* node, const std::string& name){
                 while (node){
@@ -190,11 +189,10 @@ namespace VGears{
             /**
              * Reads a function of a field from an XML node.
              *
-             * @param node[in] XML node to read.
+             * @param[in] node XML node to read.
+             * @param[in] field_name The anme of the field.
              */
-            void ReadFunction(
-              TiXmlNode* node, const std::string& field_name
-            ){
+            void ReadFunction(TiXmlNode* node, const std::string& field_name){
                 const auto entity_name = GetString(node, "entity_name");
                 const auto old_name = GetString(node, "name");
                 const auto new_name = GetString(node, "new");
@@ -206,7 +204,7 @@ namespace VGears{
             /**
              * Reads all entity from an XML node.
              *
-             * @param node[in] XML node to read.
+             * @param[in] node XML node to read.
              */
             void ReadEntityNames(TiXmlNode* node){
                 while (node){
@@ -222,7 +220,7 @@ namespace VGears{
             /**
              * Reads all variable names from an XML node.
              *
-             * @param node[in] XML node to read.
+             * @param[in] node XML node to read.
              */
             void ReadVarNames(TiXmlNode* node){
                 while (node){
@@ -239,7 +237,7 @@ namespace VGears{
             /**
              * Reads all character identifiers from an XML node.
              *
-             * @param node[in] XML node to read.
+             * @param[in] node XML node to read.
              */
             void ReadCharacterIds(TiXmlNode* node){
                 while (node){
@@ -256,11 +254,11 @@ namespace VGears{
             /**
              * Retrieves a field script function data.
              *
-             * @param field_name[in] The name of the field from witch to
+             * @param[in] field_name The name of the field from witch to
              * get the data.
-             * @param entity_name[in] Name of the entity rom witch to
+             * @param[in] entity_name Name of the entity rom witch to
              * get the data.
-             * @param old_function_name[in] The original function name.
+             * @param[in] old_function_name The original function name.
              * @return Associated function name pair. An empty pair if the
              * field, entity or function don't exist.
              * @todo Verify documentation for old_function name and return
@@ -369,7 +367,7 @@ namespace VGears{
              * animation names. Defined names are more user friendly, more
              * readable and more descriptive.
              *
-             * @param key[in] Original game animation name.
+             * @param[in] key Original game animation name.
              * @return Friendly name associated to the animation, or the
              * original name if there is no name associated.
              */
@@ -382,7 +380,7 @@ namespace VGears{
              * names. Defined names are more user friendly, more readable and
              * more descriptive.
              *
-             * @param key[in] Original game model name.
+             * @param[in] key Original game model name.
              * @return Friendly name associated to the model, or the original
              * name if there is no name associated.
              */
@@ -394,8 +392,8 @@ namespace VGears{
              * Variables that are frequently used across the game may have an
              * associated name, more fiendly and descriptive.
              *
-             * @param bank[in] Variable bank.
-             * @param addr[in] Variable address.
+             * @param[in] bank Variable bank.
+             * @param[in] addr Variable address.
              * @return Friendly name associated to the variable, or an empty
              * string if it has no associated friendly name.
              */
@@ -418,7 +416,7 @@ namespace VGears{
              * name. Defined names are more user friendly, more readable and
              * more descriptive.
              *
-             * @param old_entity_name[in] Original game entity name.
+             * @param[in] old_entity_name Original game entity name.
              * @return Friendly name associated to the entity, or the original
              * name if there is no name associated.
              */
@@ -431,11 +429,11 @@ namespace VGears{
             /**
              * Matches function comments.
              *
-             * @param field_name[in] The name of the field from witch to
+             * @param[in] field_name The name of the field from witch to
              * get the data.
-             * @param entity_name[in] Name of the entity rom witch to
+             * @param[in] entity_name Name of the entity rom witch to
              * get the data.
-             * @param old_function_name[in] The original function name.
+             * @param[in] old_function_name The original function name.
              * @return Associated function name pair. An empty pair if the
              * field, entity or function don't exist.
              * @todo Does this maps comments, or functions with comments?
@@ -455,11 +453,11 @@ namespace VGears{
              * function name. Defined names are more user friendly, more
              * readable and more descriptive.
              *
-             * @param field_name[in] The name of the field from witch to
+             * @param[in] field_name The name of the field from witch to
              * get the data.
-             * @param entity_name[in] Name of the entity rom witch to
+             * @param[in] entity_name Name of the entity rom witch to
              * get the data.
-             * @param old_function_name[in] The original function name.
+             * @param[in] old_function_name The original function name.
              * @return Associated function name, or the original name if
              * there is no name associated.
              */

+ 11 - 11
V-Gears/include/common/LzsFile.h

@@ -22,8 +22,8 @@
 /**
  * Represents an LZS file.
  *
- * More info about lzs fromat: {@link
- * https://wiki.ffrtt.ru/index.php?title=FF7/LZSS_format}
+ * More info about lzs fromat:
+ * https://wiki.ffrtt.ru/index.php?title=FF7/LZSS_format
  */
 class LzsFile : public File{
 
@@ -32,34 +32,34 @@ class LzsFile : public File{
         /**
          * Opens a lzs file and extracts it's contents
          *
-         * @param file[in] Path to the file.
+         * @param[in] file Path to the file.
          */
         LzsFile(const Ogre::String& file);
 
         /**
          * Opens a lzs file and extracts it's contents
          *
-         * @param file[in] Pointer to the file.
+         * @param[in] file Pointer to the file.
          */
         LzsFile(File* file);
 
         /**
          * Opens a lzs file fragment and extracts it's contents
          *
-         * @param file[in] Path to the file.
-         * @param offset[in] Offset to the file contents a which to start
+         * @param[in] file Path to the file.
+         * @param[in] offset Offset to the file contents a which to start
          * reading.
-         * @param ength[in] Length of the data to read from the file, in bytes.
+         * @param[in] length Length of the data to read from the file, in bytes.
          */
         LzsFile(File* file, u32 offset, u32 length);
 
         /**
          * Opens a lzs file fragment from a buffer and extracts it's contents
          *
-         * @param file[in] Pointer to the buffer which holds the data.
-         * @param offset[in] Offset to the buffer contents a which to start
+         * @param[in] buffer Pointer to the buffer which holds the data.
+         * @param[in] offset Offset to the buffer contents a which to start
          * reading.
-         * @param ength[in] Length of the data to read, in bytes.
+         * @param[in] length Length of the data to read, in bytes.
          */
         LzsFile(const u8* buffer, u32 offset, u32 length);
 
@@ -93,7 +93,7 @@ class LzsBuffer{
         /**
          * Decompresses lzs data in a buffer.
          *
-         * @param buffer[in] Buffer with the data of the lzs file.
+         * @param[in] buffer Buffer with the data of the lzs file.
          * @return Decompressed data.
          */
         static std::vector<VGears::uint8> Decompress(

+ 10 - 11
V-Gears/include/common/VGearsApplication.h

@@ -32,13 +32,12 @@ namespace VGears{
             /**
              * Constructor.
              *
-             * @param pluginsFileName[in] Path to the plugins file.
-             * @param resourcesFile[in] Path to the resources file.
-             * @param logFileName[in] Path to the log file.
+             * @param[in] pluginsFileName Path to the plugins file.
+             * @param[in] resourcesFile Path to the resources file.
+             * @param[in] logFileName Path to the log file.
              */
             Application(
-              Ogre::String pluginsFileName,
-              Ogre::String resourcesFile, Ogre::String logFileName
+              Ogre::String pluginsFileName, Ogre::String resourcesFile, Ogre::String logFileName
             ): plugins_filename_(pluginsFileName),
                resources_filename_(resourcesFile), log_filename_(logFileName)
             {}
@@ -46,8 +45,8 @@ namespace VGears{
             /**
              * Constructor.
              *
-             * @param argc[in] Number of command line arguments.
-             * @param argv[in] List of command line arguments.
+             * @param[in] argc Number of command line arguments.
+             * @param[in] argv List of command line arguments.
              */
             Application(int argc, char *argv[]);
 
@@ -59,7 +58,7 @@ namespace VGears{
             /**
              * Initializes the Ogre rendering system.
              *
-             * @param hideWindow[in] True to not show the main window, false to
+             * @param[in] hideWindow True to not show the main window, false to
              * show it.
              * @return True if the system was succesfully initiated, false
              * if there were errors or it was already initialized.
@@ -106,8 +105,8 @@ namespace VGears{
             /**
              * Processes command line arguments.
              *
-             * @param argc[in] Number of command line arguments.
-             * @param argv[in] List of command line arguments.
+             * @param[in] argc Number of command line arguments.
+             * @param[in] argv List of command line arguments.
              * @return True if all arguments were successfully processed, false
              * on error
              */
@@ -247,7 +246,7 @@ namespace VGears{
             bool _initialized = false;
 
             /**
-             * Ogre main component..
+             * Ogre main component.
              */
             std::unique_ptr<Ogre::Root> _root;
 

+ 15 - 15
V-Gears/include/common/VGearsManualObject.h

@@ -36,7 +36,7 @@ namespace VGears{
             /**
              * Constructor.
              *
-             * @param mesh[in] The object mesh
+             * @param[in] mesh The object mesh
              */
             explicit ManualObject(Ogre::Mesh *mesh);
 
@@ -81,10 +81,10 @@ namespace VGears{
              *
              * It doesn't set position, normal or texture.
              *
-             * @param name[in] Name for the object.
-             * @param material_name[in] Name of the object's material.
-             * @param vertex_count[in] Number of vertices in the object.
-             * @param index_count[in]
+             * @param[in] name Name for the object.
+             * @param[in] material_name Name of the object's material.
+             * @param[in] vertex_count Number of vertices in the object.
+             * @param[in] index_count
              * @todo Undestand and document index_count.
              */
             virtual void begin(
@@ -95,7 +95,7 @@ namespace VGears{
             /**
              * Sets the object position.
              *
-             * @param position[in] Position vector.
+             * @param[in] position Position vector.
              * @todo It applies to the object or the current section?
              */
             virtual void position(const Ogre::Vector3 &position);
@@ -103,7 +103,7 @@ namespace VGears{
             /**
              * Sets the object normal vector.
              *
-             * @param normal[in] Normal vector.
+             * @param[in] normal Normal vector.
              * @todo It applies to the object or the current section?
              */
             virtual void normal(const Ogre::Vector3 &normal);
@@ -119,7 +119,7 @@ namespace VGears{
             /**
              * Sets the object texture coordinates.
              *
-             * @param texture_coordinate[in] Coordinate vector.
+             * @param[in] texture_coordinate Coordinate vector.
              * @todo It applies to the object or the current section?
              */
             virtual void textureCoord(const Ogre::Vector2 &texture_coordinate);
@@ -127,7 +127,7 @@ namespace VGears{
             /**
              * Sets the object index.
              *
-             * @param idx[in] Object index.
+             * @param[in] idx Object index.
              * @todo It applies to the object or the current section?
              */
             virtual void index( const uint32 idx );
@@ -135,9 +135,9 @@ namespace VGears{
             /**
              * Adds a bone to the object.
              *
-             * @param idx[in] Index of the vertex index to add the bone to.
-             * @param bone_handle[in] Index of the bone objct.
-             * @param weight[in] Bone weight. In most cases, 1 is ok.
+             * @param[in] idx Index of the vertex index to add the bone to.
+             * @param[in] bone_handle Index of the bone objct.
+             * @param[in] weight Bone weight. In most cases, 1 is ok.
              * @todo It applies to the object or the current section?
              */
             virtual void bone(
@@ -160,9 +160,9 @@ namespace VGears{
             /**
              * Creates a buffer
              *
-             * @param binding[in] Buffer binding.
-             * @param type[in] Type Buffer type.
-             * @param semantic[in] Buffer semantic.
+             * @param[in] binding Buffer binding.
+             * @param[in] type Type Buffer type.
+             * @param[in] semantic Buffer semantic.
              * @todo I'm no really sure what this function does...
              */
             template<typename BufferType>

+ 9 - 12
V-Gears/include/common/VGearsResource.h

@@ -35,21 +35,19 @@ namespace VGears{
              *
              * Initializes a resource.
              *
-             * @param creator[in] The resource manager that handles the
+             * @param[in] creator The resource manager that handles the
              * resource creation.
-             * @param name[in] A name for the resource.
-             * @param handle[in] Ogre object that will handle the resource.
-             * @param group[in] Name of the group to include the resource in.
-             * @pram manual[in] Indicates if the resource is a {@see
+             * @param[in] name A name for the resource.
+             * @param[in] handle Ogre object that will handle the resource.
+             * @param[in] group Name of the group to include the resource in.
+             * @param[in] manual Indicates if the resource is a {@see
              * VGearsManualObject}.
-             * @param loader[in] Ogre resource loader for the resource.
+             * @param[in] loader Ogre resource loader for the resource.
              */
             Resource(
-              Ogre::ResourceManager *creator, const String &name,
-              Ogre::ResourceHandle handle, const String &group,
-              bool manual, Ogre::ManualResourceLoader *loader
-            ): Ogre::Resource(creator, name, handle, group, manual, loader)
-            {}
+              Ogre::ResourceManager *creator, const String &name, Ogre::ResourceHandle handle,
+              const String &group, bool manual, Ogre::ManualResourceLoader *loader
+            ): Ogre::Resource(creator, name, handle, group, manual, loader){}
 
             /**
              * Destructor.
@@ -71,7 +69,6 @@ namespace VGears{
                 );
             }
 
-        private:
     };
 }
 

+ 6 - 6
V-Gears/include/common/VGearsStringUtil.h

@@ -32,8 +32,8 @@ namespace VGears{
              * Extracts a file path from a fully qualified file name (i.e: full
              * filepath + filename).
              *
-             * @param nameame[in] Fully qualified file name.
-             * @param path[out] Path to the file, without the file name.
+             * @param[in] name Fully qualified file name.
+             * @param[out] path Path to the file, without the file name.
              */
             static void splitPath(const String &name, String &path);
 
@@ -43,8 +43,8 @@ namespace VGears{
              * Extracts a file name, without the file extension, from a fully
              * qualified file name (i.e: full filepath + filename).
              *
-             * @param name[in] Fully qualified file name.
-             * @param basename[out] File name, without extension.
+             * @param[in] name Fully qualified file name.
+             * @param[out] basename File name, without extension.
              */
             static void splitBase(const String &name, String &basename);
 
@@ -54,8 +54,8 @@ namespace VGears{
              * Extracts a file name, without the file extension, from a full
              * file name without path.
              *
-             * @param name[in] File name.
-             * @param basename[out] File name, without extension.
+             * @param[in] name File name.
+             * @param[out] basename File name, without extension.
              */
             static void splitFull(const String &name, String &basename);
     };

+ 2 - 2
V-Gears/include/core/Assert.h

@@ -20,8 +20,8 @@
 /**
  * Assertion check.
  *
- * @param exp[in] Expression to evaluate.
- * @param text[in] Error message to be displayed when the expression is not
+ * @param[in] exp Expression to evaluate.
+ * @param[in] text Error message to be displayed when the expression is not
  * true.
  */
 #define VGEARS_ASSERT(exp, text) assert(exp && text)

+ 6 - 6
V-Gears/include/core/AudioManager.h

@@ -67,7 +67,7 @@ class AudioManager : public Ogre::Singleton<AudioManager>{
         /**
          * Plays a music track.
          *
-         * @param name[in] Name of the track to play.
+         * @param[in] name Name of the track to play.
          */
         void MusicPlay(const Ogre::String& name);
 
@@ -107,14 +107,14 @@ class AudioManager : public Ogre::Singleton<AudioManager>{
         /**
          * Adds a music track to the audio manager.
          *
-         * @param music[in] The track to add.
+         * @param[in] music The track to add.
          */
         void AddMusic(const AudioManager::Music& music);
 
         /**
          * Retrieves a muisc track by name.
          *
-         * @param name[in] The track name
+         * @param[in] name The track name
          * @return The music track, or nullptr if there is no track by that
          * name.
          */
@@ -154,7 +154,7 @@ class AudioManager : public Ogre::Singleton<AudioManager>{
                 /**
                  * Constructor.
                  *
-                 * @param mutex[in] Mutex to handle concurrent updates.
+                 * @param[in] mutex Mutex to handle concurrent updates.
                  */
                 Player(boost::recursive_mutex* mutex);
 
@@ -171,7 +171,7 @@ class AudioManager : public Ogre::Singleton<AudioManager>{
                 /**
                  * Plays an audio file.
                  *
-                 * @param file[in] Path to the file to play
+                 * @param[in] file Path to the file to play
                  */
                 void Play(const Ogre::String& file);
 
@@ -183,7 +183,7 @@ class AudioManager : public Ogre::Singleton<AudioManager>{
                 /**
                  * Sets the loop for the current track.
                  *
-                 * @param loop[in] Loop point
+                 * @param[in] loop Loop point
                  */
                 void SetLoop(const float loop);
 

+ 53 - 52
V-Gears/include/core/Background2D.h

@@ -69,7 +69,7 @@ class Background2D : public Ogre::RenderQueueListener{
 
         /**
          * @todo Understand and document.
-         * @param event[in] Event.
+         * @param[in] event Event.
          */
         void InputDebug(const VGears::Event& event);
 
@@ -115,10 +115,10 @@ class Background2D : public Ogre::RenderQueueListener{
         /**
          * Scrolls the background to a position.
          *
-         * @param x[in] X coordinate to scroll to.
-         * @param y[in] Y coordinate to scroll to.
-         * @param type[in] Scroll type.
-         * @param seconds[in] Duration of the scroll.
+         * @param[in] x X coordinate to scroll to.
+         * @param[in] y Y coordinate to scroll to.
+         * @param[in] type Scroll type.
+         * @param[in] seconds Duration of the scroll.
          */
         void ScriptScrollToPosition(
           const float x, const float y,
@@ -171,7 +171,7 @@ class Background2D : public Ogre::RenderQueueListener{
          * It represents the time the current scroll action has been going on
          * for.
          *
-         * @param seconds[in] Time taken by the current scroll action.
+         * @param[in] seconds Time taken by the current scroll action.
          */
         void SetScrollCurrentSeconds(const float seconds);
 
@@ -188,7 +188,7 @@ class Background2D : public Ogre::RenderQueueListener{
         /**
          * Scroll position in screen coordinates.
          *
-         * @param position[in] Position to set the scroll.
+         * @param[in] position Position to set the scroll.
          */
         void SetScreenScroll(const Ogre::Vector2& position);
 
@@ -202,7 +202,7 @@ class Background2D : public Ogre::RenderQueueListener{
         /**
          * Sets the scroll in game internal screen coordinates.
          *
-         * @param position[in] Position to set the scroll.
+         * @param[in] position Position to set the scroll.
          */
         void SetScroll(const Ogre::Vector2& position);
 
@@ -216,7 +216,7 @@ class Background2D : public Ogre::RenderQueueListener{
         /**
          * Sets the background image.
          *
-         * @param image[in] Image name.
+         * @param[in] image Image name.
          */
         void SetImage( const Ogre::String& image );
 
@@ -225,10 +225,10 @@ class Background2D : public Ogre::RenderQueueListener{
          *
          * The range is applied in game internal screen coordinates.
          *
-         * @param min_x[in] Min scrollabe x coordinate.
-         * @param min_y[in] Min scrollabe y coordinate.
-         * @param max_x[in] Max scrollabe x coordinate.
-         * @param max_y[in] Max scrollabe y coordinate.
+         * @param[in] min_x Min scrollabe x coordinate.
+         * @param[in] min_y Min scrollabe y coordinate.
+         * @param[in] max_x Max scrollabe x coordinate.
+         * @param[in] max_y Max scrollabe y coordinate.
          */
         void SetRange(
           const int min_x, const int min_y, const int max_x, const int max_y
@@ -239,23 +239,23 @@ class Background2D : public Ogre::RenderQueueListener{
          *
          * The range is applied in game internal screen coordinates.
          *
-         * @param range[in] Range bounds vector.
+         * @param[in] range Range bounds vector.
          */
         void SetRange(const Ogre::Vector4& range);
 
         /**
          * Adds a tile to the background
          *
-         * @param x[in] X coordinate for the tile.
-         * @param y[in] Y coordinate for the tile.
-         * @param width[in] Tile width.
-         * @param height[in] Tile height.
-         * @param depth[in] Depth of the tile.
-         * @param u1[in]
-         * @param v1[in]
-         * @param u2[in]
-         * @param v2[in]
-         * @param blending[in] Blending mode for the tile
+         * @param[in] x X coordinate for the tile.
+         * @param[in] y Y coordinate for the tile.
+         * @param[in] width Tile width.
+         * @param[in] height Tile height.
+         * @param[in] depth Depth of the tile.
+         * @param[in] u1
+         * @param[in] v1
+         * @param[in] u2
+         * @param[in] v2
+         * @param[in] blending Blending mode for the tile
          * @todo Depth is z-index??
          * @todo What are v1, v2, u1 and u2?
          */
@@ -268,12 +268,12 @@ class Background2D : public Ogre::RenderQueueListener{
         /**
          * Adds a tile to the background
          *
-         * @param destination[in] Coordinates for the tile.
-         * @param width[in] Tile width.
-         * @param height[in] Tile height.
-         * @param depth[in] Depth of the tile.
-         * @param uv[in]
-         * @param blending[in] Blending mode for the tile
+         * @param[in] destination Coordinates for the tile.
+         * @param[in] width Tile width.
+         * @param[in] height Tile height.
+         * @param[in] depth Depth of the tile.
+         * @param[in] uv
+         * @param[in] blending Blending mode for the tile
          * @todo Depth is z-index??
          * @todo What is uv?
          */
@@ -285,18 +285,18 @@ class Background2D : public Ogre::RenderQueueListener{
         /**
          * Adds a tile to the background
          *
-         * @param tile[in] The tile to add.
+         * @param[in] tile The tile to add.
          */
         void AddTile(const VGears::Tile& tile);
 
         /**
          * Updates the UV vector of a tile
          *
-         * @param tile_id[in] ID of the tile to update.
-         * @param u1[in]
-         * @param v1[in]
-         * @param u2[in]
-         * @param v2[in]
+         * @param[in] tile_id ID of the tile to update.
+         * @param[in] u1
+         * @param[in] v1
+         * @param[in] u2
+         * @param[in] v2
          * @todo What are v1, v2, u1 and u2?
          */
         void UpdateTileUV(
@@ -307,15 +307,15 @@ class Background2D : public Ogre::RenderQueueListener{
         /**
          * Adds an animation to the background.
          *
-         * @param animation[in] Animation to add.
+         * @param[in] animation Animation to add.
          */
         void AddAnimation(Background2DAnimation* animation);
 
         /**
          * Plays an animation.
          *
-         * @param animation[in] The animation to play.
-         * @param state[in] Animation state.
+         * @param[in] animation The animation to play.
+         * @param[in] state Animation state.
          */
         void PlayAnimation(
           const Ogre::String& animation, const Background2DAnimation::State state
@@ -326,7 +326,7 @@ class Background2D : public Ogre::RenderQueueListener{
          *
          * The animation is played asynchronously.
          *
-         * @param name[in] Animation name.
+         * @param[in] name Animation name.
          */
         void ScriptPlayAnimationLooped(const char* name);
 
@@ -335,7 +335,7 @@ class Background2D : public Ogre::RenderQueueListener{
          *
          * The animation is played asynchronously.
          *
-         * @param name[in] Animation name.
+         * @param[in] name Animation name.
          */
         void ScriptPlayAnimationOnce(const char* name);
 
@@ -345,16 +345,17 @@ class Background2D : public Ogre::RenderQueueListener{
          * The animation is played synchronously, and the thread is locked
          * until it ends.
          *
-         * @param name[in] Animation name.
+         * @param[in] name Animation name.
          */
         int ScriptAnimationSync(const char* name);
 
         /**
          * Ends the render queue.
          *
-         * @param queueGroupId[in] The group id of the queue to end.
-         * @param invocation[in]
-         * @param repeatThisInvocation[in]
+         * @param[in] queueGroupId The group id of the queue to end.
+         * @param[in] invocation
+         * @param[in] repeatThisInvocation Indicates if the invocation must be
+         * repeated.
          * @todo Understand and document.
          */
         void renderQueueEnded(
@@ -403,7 +404,7 @@ class Background2D : public Ogre::RenderQueueListener{
         /**
          * Loads a background.
          *
-         * @param background[in] The background to load.
+         * @param[in] background The background to load.
          */
         virtual void load(const VGears::Background2DFilePtr &background);
 
@@ -412,15 +413,15 @@ class Background2D : public Ogre::RenderQueueListener{
         /**
          * Loads a tile list to the background.
          *
-         * @param tiles[in] The list of tiles to load.
+         * @param[in] tiles The list of tiles to load.
          */
         virtual void load(const VGears::Background2DFile::TileList &tiles);
 
         /**
          * Loads an animation list to the background.
          *
-         * @param tiles_index[in]
-         * @param animations[in] List of animations to load.
+         * @param[in] tile_index The index of the tile.
+         * @param[in] animations List of animations to load.
          */
         virtual void load(
           const size_t tile_index, const VGears::AnimationMap &animations
@@ -429,7 +430,7 @@ class Background2D : public Ogre::RenderQueueListener{
         /**
          * Apply the camera position to match the current scroll.
          */
-        virtual void applyScroll(void);
+        virtual void applyScroll();
 
         /**
          * Calculates the screen scale.
@@ -437,13 +438,13 @@ class Background2D : public Ogre::RenderQueueListener{
          * The scale is calculated as the proportion between the viewport and
          * the virtual screen.
          */
-        virtual void calculateScreenScale(void);
+        virtual void calculateScreenScale();
 
 
         /**
          * Sets the virtual screen to world space.
          *
-         * @param pos[in]
+         * @param[in] pos
          * @todo Understand and document.
          */
         virtual void virtualScreenToWorldSpace(Ogre::Vector2 &pos) const;

+ 14 - 14
V-Gears/include/core/Background2DAnimation.h

@@ -32,9 +32,9 @@ class Background2DAnimation{
         /**
          * Constructor.
          *
-         * @param name[in] The animation name.
-         * @param background[in] The background to animate.
-         * @param tile_index[in] The tile the animation applies to.
+         * @param[in] name The animation name.
+         * @param[in] background The background to animate.
+         * @param[in] tile_index The tile the animation applies to.
          */
         Background2DAnimation(
           const Ogre::String& name, Background2D* background,
@@ -65,7 +65,7 @@ class Background2DAnimation{
         /**
          * Adds time, so the animation state is changed according to it.
          *
-         * @param time[in] The time passed
+         * @param[in] time The time passed
          * @todo time is in seconds?
          */
         void AddTime(const float time);
@@ -80,7 +80,7 @@ class Background2DAnimation{
         /**
          * Sets the time the animation has been running.
          *
-         * @param time[in] The time the animation has been running.
+         * @param[in] time The time the animation has been running.
          * @todo time is in seconds?
          */
         void  SetTime( const float time );
@@ -96,7 +96,7 @@ class Background2DAnimation{
         /**
          * Sets the duration of the animation.
          *
-         * @param time[in] The duration of the animation.
+         * @param[in] time The duration of the animation.
          * @todo time is in seconds?
          */
         void  SetLength(const float time);
@@ -112,15 +112,15 @@ class Background2DAnimation{
         /**
          * Adds a keyframe to the animation.
          *
-         * @param key_frame[in] The keyframe to add.
+         * @param[in] key_frame The keyframe to add.
          */
         virtual void AddUVKeyFrame(const VGears::KeyFrame key_frame);
 
         /**
          * Adds a keyframe to the animation.
          *
-         * @param time[in] Time to add the keyframe at.
-         * @param uv[in] Animation vector.
+         * @param[in] time Time to add the keyframe at.
+         * @param[in] uv Animation vector.
          * @todo time is in seconds?
          */
         virtual void AddUVKeyFrame(const float time, const Ogre::Vector4& uv);
@@ -128,11 +128,11 @@ class Background2DAnimation{
         /**
          * Adds a keyframe to the animation.
          *
-         * @param time[in] Time to add the keyframe at.
-         * @param u1[in] Animation vector component.
-         * @param v1[in] Animation vector component.
-         * @param u2[in] Animation vector component.
-         * @param v2[in] Animation vector component.
+         * @param[in] time Time to add the keyframe at.
+         * @param[in] u1 Animation vector component.
+         * @param[in] v1 Animation vector component.
+         * @param[in] u2 Animation vector component.
+         * @param[in] v2 Animation vector component.
          * @todo time is in seconds?
          */
         virtual void AddUVKeyFrame(

+ 9 - 9
V-Gears/include/core/CameraManager.h

@@ -44,8 +44,8 @@ class CameraManager : public Ogre::Singleton<CameraManager>{
          *
          * Handles the scene manager camera actions based on events.
          *
-         * @param event[in] Event that triggers the camera action.
-         * @param time_since_last_frame[in] For speed calculation.
+         * @param[in] event Event that triggers the camera action.
+         * @param[in] time_since_last_frame For speed calculation.
          */
         void Input(
           const VGears::Event& event , Ogre::Real time_since_last_frame
@@ -71,16 +71,16 @@ class CameraManager : public Ogre::Singleton<CameraManager>{
          * A free camera moves depending on player input, not according to a
          * script. For example, a camera following the PC is a free camera.
          *
-         * @param enable[in] True to enable free camera, false to disable it.
+         * @param[in] enable True to enable free camera, false to disable it.
          */
         void SetCameraFree(const bool enable);
 
         /**
          * Sets the camera properties.
          *
-         * @param position[in] Camera coordinates.
-         * @param orientation[in] Camera rotation, in quaternion format.
-         * @param fov[in] Field of view, in radians.
+         * @param[in] position Camera coordinates.
+         * @param[in] orientation Camera rotation, in quaternion format.
+         * @param[in] fov Field of view, in radians.
          */
         void Set2DCamera(
           const Ogre::Vector3 position, const Ogre::Quaternion orientation,
@@ -93,7 +93,7 @@ class CameraManager : public Ogre::Singleton<CameraManager>{
          * Moves the camera to the desired position. If the camera is in free
          * mode, it sets the position, but it won't actually move the camera.
          *
-         * @param position[in] Position to scroll the camera to.
+         * @param[in] position Position to scroll the camera to.
          */
         void Set2DScroll(const Ogre::Vector2& position);
 
@@ -109,7 +109,7 @@ class CameraManager : public Ogre::Singleton<CameraManager>{
          *
          * The calculation is done using A map position and the camera scroll.
          *
-         * @param point[in] Position of the map to be translated to screen
+         * @param[in] point Position of the map to be translated to screen
          * position.
          * @return Position of POINT in screen coordinates.
          */
@@ -134,7 +134,7 @@ class CameraManager : public Ogre::Singleton<CameraManager>{
          *
          * In wireframe mode, faces will not be rendered, only edges
          *
-         * @param enable[in] True to enable wireframe mode, false to disable.
+         * @param[in] enable True to enable wireframe mode, false to disable.
          */
         void EnableWireFrame(bool enable);
 

+ 7 - 7
V-Gears/include/core/ConfigCmd.h

@@ -39,11 +39,11 @@ class ConfigCmd{
          *
          * It should only be created only by ConfigCmdManager.
          *
-         * @param name[in] Command name.
-         * @param description[in] Command description.
-         * @param params_description[in] Command parameters description.
-         * @param handler[in] Command handler.
-         * @param completion[in] Command completion.
+         * @param[in] name Command name.
+         * @param[in] description Command description.
+         * @param[in] params_description Command parameters description.
+         * @param[in] handler Command handler.
+         * @param[in] completion Command completion.
          */
         ConfigCmd(
           const Ogre::String& name, const Ogre::String& description,
@@ -91,14 +91,14 @@ class ConfigCmd{
         /**
          * Forbidden copy constructor.
          *
-         * @param rhs[in] Command to not copy.
+         * @param[in] rhs Command to not copy.
          */
         ConfigCmd(const ConfigCmd& rhs) = delete;
 
         /**
          * Forbidden copy constructor.
          *
-         * @param rhs[in] Command to not copy.
+         * @param[in] rhs Command to not copy.
          */
         ConfigCmd& operator =(const ConfigCmd& rhs) = delete;
 

+ 9 - 9
V-Gears/include/core/ConfigCmdManager.h

@@ -40,11 +40,11 @@ class ConfigCmdManager : public Ogre::Singleton<ConfigCmdManager>{
         /**
          * Adds a command to the manager.
          *
-         * @param name[in] Command name.
-         * @param description[in] Command description.
-         * @param params_description[in] Command parameters description.
-         * @param handler[in] Command handler.
-         * @param completion[in] Command completion.
+         * @param[in] name Command name.
+         * @param[in] description Command description.
+         * @param[in] params_description Command parameters description.
+         * @param[in] handler Command handler.
+         * @param[in] completion Command completion.
          */
         void AddCommand(
           const Ogre::String& name, const Ogre::String& description,
@@ -55,14 +55,14 @@ class ConfigCmdManager : public Ogre::Singleton<ConfigCmdManager>{
         /**
          * Executes a command.
          *
-         * @param cmd_string[in] The command, in string format.
+         * @param[in] cmd_string The command, in string format.
          */
         void ExecuteString( const Ogre::String& cmd_string );
 
         /**
          * Finds a command by name.
          *
-         * @param name[in] Name of the command.
+         * @param[in] name Name of the command.
          * @return The command by the name, or nullptr if there is none.
          */
         ConfigCmd* Find(const Ogre::String& name) const;
@@ -87,14 +87,14 @@ class ConfigCmdManager : public Ogre::Singleton<ConfigCmdManager>{
         /**
          * Forbidden copy constructor.
          *
-         * @param rhs[in] Manager to not copy.
+         * @param[in] rhs Manager to not copy.
          */
         ConfigCmdManager(const ConfigCmdManager& rhs) = delete;
 
         /**
          * Forbidden copy constructor.
          *
-         * @param rhs[in] Manager to not copy.
+         * @param[in] rhs Manager to not copy.
          */
         ConfigCmdManager operator =(const ConfigCmdManager& rhs) = delete;
 

+ 12 - 12
V-Gears/include/core/ConfigCmdManagerCommands.h

@@ -31,7 +31,7 @@
 /**
  * Command to quit the application.
  *
- * @param params[in] Command parameters. Ignored.
+ * @param[in] params Command parameters. Ignored.
  */
 void CmdQuit(const Ogre::StringVector& params){
     VGears::g_ApplicationState = VGears::G_EXIT;
@@ -40,7 +40,7 @@ void CmdQuit(const Ogre::StringVector& params){
 /**
  * Command to print to console.
  *
- * @param params[in] Command parameters. All of them will be concatenated and
+ * @param[in] params Command parameters. All of them will be concatenated and
  * printed. If none are supplied, a command usage text will be printed instead.
  */
 void CmdEcho(const Ogre::StringVector& params){
@@ -61,7 +61,7 @@ void CmdEcho(const Ogre::StringVector& params){
 /**
  * Searches variables in the variable list and prints them.
  *
- * @param params[in] Command parameters. The first one is the command name. If
+ * @param[in] params Command parameters. The first one is the command name. If
  * no more are passed, all variables will be printed. If another parameter is
  * passed, the variables with that name (if any) will be printed. If more than
  * two parameter are passed, a command usage string will be printed instead.
@@ -104,7 +104,7 @@ void CmdConfigVarList(const Ogre::StringVector& params){
 /**
  * Searches the command list and prints the comands.
  *
- * @param params[in] Command parameters. The first one is the command name. If
+ * @param[in] params Command parameters. The first one is the command name. If
  * no more is passed, all commands will be printed. If another parameter is
  * passed, the command with that name (if any) will be printed. If more than
  * two parameter are passed, a command usage string will be printed instead.
@@ -141,7 +141,7 @@ void CmdConfigCmdList(const Ogre::StringVector& params){
 /**
  * Sets the value of a configuration value.
  *
- * @param params[in] Command parameters. The first one is the command name. The
+ * @param[in] params Command parameters. The first one is the command name. The
  * second one is a variable name. The third one is optional and is a value for
  * the variable. If a value is supplied, the variable will be given that value.
  * If not, the variable will be reset to it's default value. If there is no
@@ -182,7 +182,7 @@ void CmdSetConfigVar(const Ogre::StringVector& params)
 /**
  * Changes the value of a configuration value conditionally.
  *
- * @param params[in] Command parameters. The first one is the command name. The
+ * @param[in] params Command parameters. The first one is the command name. The
  * next ones are possible values for the variables. If the value of the
  * variable is the current one, the next one will be assigned. Once the value
  * is changed once, no more steps will be taken and the function will return.
@@ -219,7 +219,7 @@ void CmdToggleConfigVar(const Ogre::StringVector& params){
 /**
  * Increments the value of a configuration variable.
  *
- * @param params[in] Command parameters. Exactly five must be provided. The
+ * @param[in] params Command parameters. Exactly five must be provided. The
  * first one is the command name. The second one is the variable to increment.
  * The third one is the minimum value the variable will take. The fourth one is
  * the maximum value the variable will take. The fifth value is the increment
@@ -254,7 +254,7 @@ void CmdIncrementConfigVar(const Ogre::StringVector& params){
 /**
  * Configures the log level.
  *
- * @param params[in] Command parameters. Exactly two must be provided. The
+ * @param[in] params Command parameters. Exactly two must be provided. The
  * first one is the command name. The second one is the log level. Accepted
  * values are 1 (only errors), 2 (errors and warnings) and 3 (all). If there
  * are more or less than five parameters, a usage text will be printed and
@@ -303,7 +303,7 @@ void CmdSetLogLevel(const Ogre::StringVector& params){
 /**
  * Changes the game map.
  *
- * @param params[in] Command parameters. Exactly two must be provided. The
+ * @param[in] params Command parameters. Exactly two must be provided. The
  * first one is the command name. The second one is the map ID. If there
  * are more or less than five parameters, a usage text will be printed and
  * nothing will be done.
@@ -323,7 +323,7 @@ void CmdMap(const Ogre::StringVector& params){
 /**
  * Loads a list of map names.
  *
- * @param complete_params[in] The map names will be loaded here.
+ * @param[in] complete_params The map names will be loaded here.
  */
 void CmdMapCompletion(Ogre::StringVector& complete_params){
     XmlMapsFile xml("./data/maps.xml");
@@ -333,7 +333,7 @@ void CmdMapCompletion(Ogre::StringVector& complete_params){
 /**
  * Sets the resolution and full screen mode.
  *
- * @param params[in] Command parameters. Three or four must be provided. The
+ * @param[in] params Command parameters. Three or four must be provided. The
  * first one is the command name. The second one is the resolution width. The
  * third one is the resolution height. The fourth one is optional and can be
  * used to toggle the full screen. "true", "yes" or 1 will set the game in full
@@ -371,7 +371,7 @@ void CmdResolution(const Ogre::StringVector& params){
  * in pixels and [f] is the full screen state (0 for windowed mode, 1 for full
  * screen)
  *
- * @param complete_params[in] The resolution modes will be loaded here.
+ * @param[in] complete_params The resolution modes will be loaded here.
  */
 void CmdResolutionCompletition(Ogre::StringVector& complete_params){
     complete_params.push_back("640 480 0");

+ 1 - 1
V-Gears/include/core/ConfigFile.h

@@ -32,7 +32,7 @@ class ConfigFile{
          *
          * Executing a file will sequentially execute all the commands in it.
          *
-         * @param name[in] Configuration file path.
+         * @param[in] name Configuration file path.
          */
         void Execute(const Ogre::String& name);
 };

+ 7 - 7
V-Gears/include/core/ConfigVar.h

@@ -30,10 +30,10 @@ class ConfigVar{
         /**
          * Constructor.
          *
-         * @param name[in] The variable name.
-         * @param description[in] A human-friendly description for the
+         * @param[in] name The variable name.
+         * @param[in] description A human-friendly description for the
          * variable.
-         * @param default_value[in] The default value for the variable.
+         * @param[in] default_value The default value for the variable.
          */
         ConfigVar(
           const Ogre::String& name, const Ogre::String& description,
@@ -71,28 +71,28 @@ class ConfigVar{
         /**
          * Sets the integer value of the variable.
          *
-         * @param value[in] The variable value.
+         * @param[in] value The variable value.
          */
         void SetI(int value);
 
         /**
          * Sets the float value of the variable.
          *
-         * @param value[in] The variable value.
+         * @param[in] value The variable value.
          */
         void SetF(float value);
 
         /**
          * Sets the boolean value of the variable.
          *
-         * @param value[in] The variable value.
+         * @param[in] value The variable value.
          */
         void SetB(bool value);
 
         /**
          * Sets the string value of the variable.
          *
-         * @param value[in] The variable value.
+         * @param[in] value The variable value.
          */
         void SetS(const Ogre::String& value);
 

+ 2 - 2
V-Gears/include/core/ConfigVarManager.h

@@ -34,7 +34,7 @@ class ConfigVarManager : public Ogre::Singleton<ConfigVarManager>{
         /**
          * Finds a variable by name.
          *
-         * @param name[in] Name of the variable to retrieve.
+         * @param[in] name Name of the variable to retrieve.
          * @return The variable by the specified name, nullptr if there is no
          * one by that name.
          */
@@ -50,7 +50,7 @@ class ConfigVarManager : public Ogre::Singleton<ConfigVarManager>{
         /**
          * Retrieves a configuration variable by index.
          *
-         * @param i[in] Index of the configuration variable.
+         * @param[in] i Index of the configuration variable.
          * @return Variable at the specified index.
          */
         ConfigVar* GetConfigVar(const unsigned int i) const;

+ 11 - 12
V-Gears/include/core/Console.h

@@ -44,7 +44,7 @@ class Console : public Ogre::Singleton<Console>, public Ogre::LogListener{
         /**
          * Processes an input event.
          *
-         * @param event[in] Event to process.
+         * @param[in] event Event to process.
          */
         void Input(const VGears::Event& event);
 
@@ -88,18 +88,17 @@ class Console : public Ogre::Singleton<Console>, public Ogre::LogListener{
         /**
          * Writes text to the console.
          *
-         * @param text[in] Text to write.
-         * @param color[in] Color for the text. Default is white.
+         * @param[in] text Text to write.
+         * @param[in] colour Color for the text. Default is white.
          */
         void AddTextToOutput(
-          const Ogre::String& text,
-          const Ogre::ColourValue& colour = Ogre::ColourValue::White
-       );
+          const Ogre::String& text, const Ogre::ColourValue& colour = Ogre::ColourValue::White
+        );
 
         /**
          * Executes a command in the console
          *
-         * @param command[in] Command to execute.
+         * @param[in] command Command to execute.
          */
         void ExecuteCommand(const Ogre::String& command);
 
@@ -131,12 +130,12 @@ class Console : public Ogre::Singleton<Console>, public Ogre::LogListener{
         /**
          * Logs a message to the console.
          *
-         * @param message[in] The message to log.
-         * @param lml[in] Log level for the message.
+         * @param[in] message The message to log.
+         * @param[in] lml Log level for the message.
          * @param maskDebug Indicates if the mesage is beinng printed to the
          * console or not.
-         * @param logName[in] Name of the log.
-         * @param skipThisMessage[in] If true, the message will not be logged.
+         * @param[in] logName Name of the log.
+         * @param[in] skipThisMessage If true, the message will not be logged.
          */
         virtual void messageLogged(
           const Ogre::String& message, Ogre::LogMessageLevel lml,
@@ -163,7 +162,7 @@ class Console : public Ogre::Singleton<Console>, public Ogre::LogListener{
         /**
          * Translates numpad key events to regular number events.
          *
-         * @param event[in] Event to translate.
+         * @param[in] event Event to translate.
          */
         char TranslateNumpad(const VGears::Event& event);
 

+ 32 - 32
V-Gears/include/core/DebugDraw.h

@@ -39,14 +39,14 @@ class DebugDraw :
         /**
          * Sets the colour of the element to draw.
          *
-         * @param colour[in] The color to apply.
+         * @param[in] colour The color to apply.
          */
         void SetColour(const Ogre::ColourValue& colour);
 
         /**
          * Sets the screen space.
          *
-         * @param screen_space[in] The screen space.
+         * @param[in] screen_space The screen space.
          * @todo Understand and document properly.
          */
         void SetScreenSpace(const bool screen_space);
@@ -54,15 +54,15 @@ class DebugDraw :
         /**
          * Set the Z coordinate.
          *
-         * @param z[in] The Z coordinate.
+         * @param[in] z The Z coordinate.
          */
         void SetZ(const float z);
 
         /**
          * Sets the fade distance for text.
          *
-         * @param fade_s[in] The text starts fading at this distance.
-         * @param fade_e[in] The text has faded completely at this distance.
+         * @param[in] fade_s The text starts fading at this distance.
+         * @param[in] fade_e The text has faded completely at this distance.
          */
         void SetFadeDistance(const float fade_s, const float fade_e);
 
@@ -95,10 +95,10 @@ class DebugDraw :
          * exceeded by drawing the line, a warning message will be printed and
          * nothing will be done.
          *
-         * @param x1[in] X coordinate of the starting point.
-         * @param y1[in] Y coordinate of the starting point.
-         * @param x2[in] X coordinate of the ending point.
-         * @param y2[in] Y coordinate of the ending point.
+         * @param[in] x1 X coordinate of the starting point.
+         * @param[in] y1 Y coordinate of the starting point.
+         * @param[in] x2 X coordinate of the ending point.
+         * @param[in] y2 Y coordinate of the ending point.
          */
         void Line(
           const float x1, const float y1, const float x2, const float y2
@@ -111,8 +111,8 @@ class DebugDraw :
          * exceeded by drawing the line, a warning message will be printed and
          * nothing will be done.
          *
-         * @param point1[in] Starting point.
-         * @param point2[in] Ending point.
+         * @param[in] point1 Starting point.
+         * @param[in] point2 Ending point.
          */
         void Line3d(const Ogre::Vector3& point1, const Ogre::Vector3& point2);
 
@@ -123,9 +123,9 @@ class DebugDraw :
          * exceeded by drawing the triangle, a warning message will be printed
          * and nothing will be done.
          *
-         * @param point1[in] A triangle vertex point.
-         * @param point2[in] A triangle vertex point.
-         * @param point3[in] A triangle vertex point.
+         * @param[in] point1 A triangle vertex point.
+         * @param[in] point2 A triangle vertex point.
+         * @param[in] point3 A triangle vertex point.
          */
         void Triangle3d(
           const Ogre::Vector3& point1, const Ogre::Vector3& point2,
@@ -139,14 +139,14 @@ class DebugDraw :
          * exceeded by drawing the quad, a warning message will be printed and
          * nothing will be done.
          *
-         * @param x1[in] X coordinate of the first point.
-         * @param y1[in] Y coordinate of the first point.
-         * @param x2[in] X coordinate of the second point.
-         * @param y2[in] Y coordinate of the second point.
-         * @param x3[in] X coordinate of the third point.
-         * @param y3[in] Y coordinate of the third point.
-         * @param x4[in] X coordinate of the fourth point.
-         * @param y4[in] Y coordinate of the fourth point.
+         * @param[in] x1 X coordinate of the first point.
+         * @param[in] y1 Y coordinate of the first point.
+         * @param[in] x2 X coordinate of the second point.
+         * @param[in] y2 Y coordinate of the second point.
+         * @param[in] x3 X coordinate of the third point.
+         * @param[in] y3 Y coordinate of the third point.
+         * @param[in] x4 X coordinate of the fourth point.
+         * @param[in] y4 Y coordinate of the fourth point.
          */
         void Quad(
           const float x1, const float y1, const float x2, const float y2,
@@ -161,9 +161,9 @@ class DebugDraw :
          * writing, a warning message will be printed to console and nothing
          * will be done.
          *
-         * @param x[in] Left position of the text in the screen.
-         * @param y[in] Left position of the text in the screen.
-         * @param text[in] The text to write.
+         * @param[in] x Left position of the text in the screen.
+         * @param[in] y Left position of the text in the screen.
+         * @param[in] text The text to write.
          */
         void Text(const float x, const float y, const Ogre::String& text);
 
@@ -175,11 +175,11 @@ class DebugDraw :
          * writing, a warning message will be printed to console and nothing
          * will be done.
          *
-         * @param point[in] Top left point of the screen where the text will be
+         * @param[in] point Top left point of the screen where the text will be
          * written.
-         * @param x[in] Text width.
-         * @param y[in] Text height.
-         * @param text[in] The text to write.
+         * @param[in] x Text width.
+         * @param[in] y Text height.
+         * @param[in] text The text to write.
          */
         void Text(
           const Ogre::Vector3& point, const float x, const float y,
@@ -189,9 +189,9 @@ class DebugDraw :
         /**
          * Ends the render queue.
          *
-         * @param queueGroupId[in] The group id of the queue to end.
-         * @param invocation[in]
-         * @param repeatThisInvocation[in]
+         * @param[in] queueGroupId The group id of the queue to end.
+         * @param[in] invocation
+         * @param[in] repeatThisInvocation
          * @todo Understand and document.
          */
         void renderQueueEnded(

이 변경점에서 너무 많은 파일들이 변경되어 몇몇 파일들은 표시되지 않았습니다.