FlightControl-Master/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-10-29 16:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation fixes. (#1803)

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

2
Moose Development/Moose/Wrapper/Airbase.lua
View File

@@ -1,4 +1,4 @@
--- **Wrapper** -- AIRBASE is a wrapper class to handle the DCS Airbase objects.
--- **Wrapper** - AIRBASE is a wrapper class to handle the DCS Airbase objects.
--
-- ===
--

4
Moose Development/Moose/Wrapper/Client.lua
View File

@@ -1,4 +1,4 @@
--- **Wrapper** -- CLIENT wraps DCS Unit objects acting as a __Client__ or __Player__ within a mission.
--- **Wrapper** - CLIENT wraps DCS Unit objects acting as a __Client__ or __Player__ within a mission.
--
-- ===
--
@@ -58,7 +58,7 @@
-- * @{#CLIENT.Find}(): Find a CLIENT instance from the _DATABASE object using a DCS Unit object.
-- * @{#CLIENT.FindByName}(): Find a CLIENT instance from the _DATABASE object using a DCS Unit name.
--
-- **IMPORTANT: ONE SHOULD NEVER SANATIZE these CLIENT OBJECT REFERENCES! (make the CLIENT object references nil).**
-- **IMPORTANT: ONE SHOULD NEVER SANITIZE these CLIENT OBJECT REFERENCES! (make the CLIENT object references nil).**
--
-- @field #CLIENT
CLIENT = {

2
Moose Development/Moose/Wrapper/Controllable.lua
View File

@@ -1,4 +1,4 @@
--- **Wrapper** -- CONTROLLABLE is an intermediate class wrapping Group and Unit classes "controllers".
--- **Wrapper** - CONTROLLABLE is an intermediate class wrapping Group and Unit classes "controllers".
--
-- ===
--

4
Moose Development/Moose/Wrapper/Group.lua
View File

@@ -1,4 +1,4 @@
--- **Wrapper** -- GROUP wraps the DCS Class Group objects.
--- **Wrapper** - GROUP wraps the DCS Class Group objects.
--
-- ===
--
@@ -11,7 +11,7 @@
-- * Handle local Group Controller.
-- * Manage the "state" of the DCS Group.
--
-- **IMPORTANT: ONE SHOULD NEVER SANATIZE these GROUP OBJECT REFERENCES! (make the GROUP object references nil).**
-- **IMPORTANT: ONE SHOULD NEVER SANITIZE these GROUP OBJECT REFERENCES! (make the GROUP object references nil).**
--
-- ===
--

2
Moose Development/Moose/Wrapper/Identifiable.lua
View File

@@ -1,4 +1,4 @@
--- **Wrapper** -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.
--- **Wrapper** - IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.
--
-- ===
--

2
Moose Development/Moose/Wrapper/Object.lua
View File

@@ -1,4 +1,4 @@
--- **Wrapper** -- OBJECT wraps the DCS Object derived objects.
--- **Wrapper** - OBJECT wraps the DCS Object derived objects.
--
-- ===
--

2
Moose Development/Moose/Wrapper/Positionable.lua
View File

@@ -1,4 +1,4 @@
--- **Wrapper** -- POSITIONABLE wraps DCS classes that are "positionable".
--- **Wrapper** - POSITIONABLE wraps DCS classes that are "positionable".
--
-- ===
--

2
Moose Development/Moose/Wrapper/Scenery.lua
View File

@@ -1,4 +1,4 @@
--- **Wrapper** -- SCENERY models scenery within the DCS simulator.
--- **Wrapper** - SCENERY models scenery within the DCS simulator.
--
-- ===
--

4
Moose Development/Moose/Wrapper/Static.lua
View File

@@ -1,4 +1,4 @@
--- **Wrapper** -- STATIC wraps the DCS StaticObject class.
--- **Wrapper** - STATIC wraps the DCS StaticObject class.
--
-- ===
--
@@ -40,7 +40,7 @@
--
-- * @{#STATIC.FindByName}(): Find a STATIC instance from the _DATABASE object using a DCS Static name.
--
-- IMPORTANT: ONE SHOULD NEVER SANATIZE these STATIC OBJECT REFERENCES! (make the STATIC object references nil).
-- IMPORTANT: ONE SHOULD NEVER SANITIZE these STATIC OBJECT REFERENCES! (make the STATIC object references nil).
--
-- @field #STATIC
STATIC = {

2
Moose Development/Moose/Wrapper/Unit.lua
View File

@@ -42,7 +42,7 @@
-- * @{#UNIT.Find}(): Find a UNIT instance from the _DATABASE object using a DCS Unit object.
-- * @{#UNIT.FindByName}(): Find a UNIT instance from the _DATABASE object using a DCS Unit name.
--
-- IMPORTANT: ONE SHOULD NEVER SANATIZE these UNIT OBJECT REFERENCES! (make the UNIT object references nil).
-- IMPORTANT: ONE SHOULD NEVER SANITIZE these UNIT OBJECT REFERENCES! (make the UNIT object references nil).
--
-- ## DCS UNIT APIs
--