Documentation fixes. (#1803)

Improve the consistency of the module intros to the most commonly used version (single dash).

Add missing module information (abbreviated where none existed previously).

Fix broken documentation links

Make module names correspond to filenames (and fix links).

Fix typos.
This commit is contained in:
TommyC81
2022-10-19 14:20:39 +04:00
committed by GitHub
parent 89f0909a8f
commit 0441acf101
80 changed files with 191 additions and 209 deletions

View File

@@ -13,7 +13,7 @@
--
-- Other Moose classes also have enumerators. For example, the AIRBASE class has enumerators for airbase names.
--
-- @module ENUMS
-- @module Utilities.Enums
-- @image MOOSE.JPG
--- [DCS Enum world](https://wiki.hoggitworld.com/view/DCS_enum_world)

View File

@@ -10,7 +10,7 @@
-- ===
--
-- ### Author: **applevangelist**
-- @module Utils.FiFo
-- @module Utilities.FiFo
-- @image MOOSE.JPG
-- Date: April 2022

View File

@@ -6,7 +6,7 @@
--
-- ### Author: **TAW CougarNL**, *funkyfranky*
--
-- @module Utilities.PROFILER
-- @module Utilities.Profiler
-- @image Utils_Profiler.jpg
--- PROFILER class.

View File

@@ -1,5 +1,5 @@
--- Various routines
-- @module routines
-- @module Utilities.Routines
-- @image MOOSE.JPG
env.setErrorMessageBoxEnabled( false )

View File

@@ -1,7 +1,7 @@
--- **Utilities** DCS Simple Text-To-Speech (STTS).
--
--
-- @module Utils.STTS
-- @module Utilities.STTS
-- @image MOOSE.JPG
--- [DCS Enum world](https://wiki.hoggitworld.com/view/DCS_enum_world)

View File

@@ -9,7 +9,7 @@
-- * FlightControl : Rework to OO framework.
-- * And many more
--
-- @module Utils
-- @module Utilities.Utils
-- @image MOOSE.JPG