Documentation Improvements

2025-10-29 16:58:06 +00:00 · 2018-05-27 08:57:44 +02:00
parent 11516228fa
commit 073bfbf9c9
43 changed files with 151 additions and 276 deletions
--- a/Development/Moose/AI/AI_A2A.lua
+++ b/Development/Moose/AI/AI_A2A.lua
@@ -7,7 +7,7 @@
 -- ===
 -- 
 -- @module AI.AI_A2A
-- @image Air_To_Air_Dispatching.JPG
+-- @image AI_Air_To_Air_Dispatching.JPG

 --BASE:TraceClass("AI_A2A")

--- a/Development/Moose/AI/AI_A2A_Cap.lua
+++ b/Development/Moose/AI/AI_A2A_Cap.lua
@@ -7,7 +7,7 @@
 -- ===       
 --
 -- @module AI.AI_A2A_Cap
-- @image Combat_Air_Patrol.JPG
+-- @image AI_Combat_Air_Patrol.JPG

 --- @type AI_A2A_CAP
 -- @extends AI.AI_A2A_Patrol#AI_A2A_PATROL
--- a/Development/Moose/AI/AI_A2A_Dispatcher.lua
+++ b/Development/Moose/AI/AI_A2A_Dispatcher.lua
@@ -150,7 +150,7 @@
 -- ### Authors: **Stonehouse**, **SNAFU** in terms of the advice, documentation, and the original GCICAP script.
 -- 
 -- @module AI.AI_A2A_Dispatcher
-- @image Air_To_Air_Dispatching.JPG
+-- @image AI_Air_To_Air_Dispatching.JPG



--- a/Development/Moose/AI/AI_A2A_Gci.lua
+++ b/Development/Moose/AI/AI_A2A_Gci.lua
@@ -9,6 +9,7 @@
 -- ===       
 --
 -- @module AI.AI_A2A_GCI
+-- @image AI_AI_Ground_Control_Intercept.JPG



--- a/Development/Moose/AI/AI_A2A_Patrol.lua
+++ b/Development/Moose/AI/AI_A2A_Patrol.lua
@@ -7,7 +7,7 @@
 -- ===
 -- 
 -- @module AI.AI_A2A_Patrol
-- @image Air_Patrolling.JPG
+-- @image AI_Air_Patrolling.JPG


 --- @type AI_A2A_PATROL
--- a/Development/Moose/AI/AI_BAI.lua
+++ b/Development/Moose/AI/AI_BAI.lua
@@ -18,7 +18,7 @@
 -- ===
 --
 -- @module AI.AI_Bai
-- @image Battlefield_Air_Interdiction.JPG
+-- @image AI_Battlefield_Air_Interdiction.JPG


 --- AI_BAI_ZONE class
--- a/Development/Moose/AI/AI_CAP.lua
+++ b/Development/Moose/AI/AI_CAP.lua
@@ -22,7 +22,7 @@
 -- ===       
 --
 -- @module AI.AI_Cap
-- @image Combat_Air_Patrol.JPG
+-- @image AI_Combat_Air_Patrol.JPG


 --- @type AI_CAP_ZONE
--- a/Development/Moose/AI/AI_CAS.lua
+++ b/Development/Moose/AI/AI_CAS.lua
@@ -1,10 +1,6 @@
 --- **AI** -- (R2.1) - Manages the independent process of Close Air Support for airplanes.
 --
 -- ===
--
-- ![Banner Image](..\Presentations\AI_CAS\Dia1.JPG)
-- 
-- ===
 -- 
 -- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/CAS%20-%20Close%20Air%20Support)
 -- 
@@ -24,7 +20,7 @@
 -- ===
 --
 -- @module AI.AI_Cas
-
+-- @image AI_Close_Air_Support.JPG

 --- AI_CAS_ZONE class
 -- @type AI_CAS_ZONE
--- a/Development/Moose/AI/AI_Cargo_APC.lua
+++ b/Development/Moose/AI/AI_Cargo_APC.lua
@@ -7,6 +7,7 @@
 -- ===       
 --
 -- @module AI.AI_Cargo_APC
+-- @image AI_Cargo_Dispatching_For_APC.JPG

 --- @type AI_CARGO_APC
 -- @extends Core.Fsm#FSM_CONTROLLABLE
--- a/Development/Moose/AI/AI_Cargo_Airplane.lua
+++ b/Development/Moose/AI/AI_Cargo_Airplane.lua
@@ -7,6 +7,7 @@
 -- ===       
 --
 -- @module AI.AI_Cargo_Airplane
+-- @image AI_Cargo_Dispatching_For_Airplanes.JPG

 --- @type AI_CARGO_AIRPLANE
 -- @extends Core.Fsm#FSM_CONTROLLABLE
--- a/Development/Moose/AI/AI_Cargo_Dispatcher.lua
+++ b/Development/Moose/AI/AI_Cargo_Dispatcher.lua
@@ -7,6 +7,7 @@
 -- ===       
 --
 -- @module AI.AI_Cargo_Dispatcher
+-- @image AI_Cargo_Dispatching_For_Helicopters.JPG

 --- @type AI_CARGO_DISPATCHER
 -- @extends Core.Fsm#FSM
--- a/Development/Moose/AI/AI_Cargo_Dispatcher_APC.lua
+++ b/Development/Moose/AI/AI_Cargo_Dispatcher_APC.lua
@@ -7,7 +7,7 @@
 -- ===       
 --
 -- @module AI.AI_Cargo_Dispatcher_APC
-- @image Cargo_Dispatching_For_APC.JPG
+-- @image AI_Cargo_Dispatching_For_APC.JPG

 --- @type AI_CARGO_DISPATCHER_APC
 -- @extends AI.AI_Cargo_Dispatcher#AI_CARGO_DISPATCHER
--- a/Development/Moose/AI/AI_Cargo_Dispatcher_Airplane.lua
+++ b/Development/Moose/AI/AI_Cargo_Dispatcher_Airplane.lua
@@ -7,7 +7,8 @@
 -- ===       
 --
 -- @module AI.AI_Cargo_Dispatcher_Airplane
-
+-- @image AI_Cargo_Dispatching_For_Airplanes.JPG
+-- 
 --- @type AI_CARGO_DISPATCHER_AIRPLANE
 -- @extends AI.AI_Cargo_Dispatcher#AI_CARGO_DISPATCHER

--- a/Development/Moose/AI/AI_Cargo_Dispatcher_Helicopter.lua
+++ b/Development/Moose/AI/AI_Cargo_Dispatcher_Helicopter.lua
@@ -9,6 +9,7 @@
 -- ===       
 --
 -- @module AI.AI_Cargo_Dispatcher_Helicopter
+-- @image AI_Cargo_Dispatching_For_Helicopters.JPG

 --- @type AI_CARGO_DISPATCHER_HELICOPTER
 -- @extends AI.AI_Cargo_Dispatcher#AI_CARGO_DISPATCHER
--- a/Development/Moose/AI/AI_Cargo_Helicopter.lua
+++ b/Development/Moose/AI/AI_Cargo_Helicopter.lua
@@ -7,6 +7,7 @@
 -- ===       
 --
 -- @module AI.AI_Cargo_Helicopter
+-- @image AI_Cargo_Dispatching_For_Helicopters.JPG

 --- @type AI_CARGO_HELICOPTER
 -- @extends Core.Fsm#FSM_CONTROLLABLE
--- a/Development/Moose/AI/AI_Formation.lua
+++ b/Development/Moose/AI/AI_Formation.lua
@@ -2,10 +2,6 @@
 -- 
 -- ===
 -- 
-- ![Banner Image](..\Presentations\AI_FORMATION\Dia1.JPG)
-- 
-- ===
-- 
 -- AI_FORMATION makes AI @{Wrapper.Group}s fly in formation of various compositions.
 -- The AI_FORMATION class models formations in a different manner than the internal DCS formation logic!!!
 -- The purpose of the class is to:
@@ -46,6 +42,7 @@
 -- ===
 --   
 -- @module AI.AI_Formation
+-- @image AI_Large_Formations.JPG

 --- AI_FORMATION class
 -- @type AI_FORMATION
--- a/Development/Moose/AI/AI_Patrol.lua
+++ b/Development/Moose/AI/AI_Patrol.lua
@@ -2,10 +2,6 @@
 -- 
 -- ===
 -- 
-- ![Banner Image](..\Presentations\AI_PATROL\Dia1.JPG)
-- 
-- ===
-- 
 -- AI PATROL classes makes AI Controllables execute an Patrol.
 -- 
 -- There are the following types of PATROL classes defined:
@@ -31,7 +27,7 @@
 -- ===
 -- 
 -- @module AI.AI_Patrol
-
+-- @image AI_Air_Patrolling.JPG

 --- AI_PATROL_ZONE class
 -- @type AI_PATROL_ZONE