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

@@ -1,6 +1,6 @@
--- **AI** -- (R2.2) - Models the process of Ground Controlled Interception (GCI) for airplanes.
--- **AI** - (R2.2) - Models the process of Ground Controlled Interception (GCI) for airplanes.
--
-- This is a class used in the @{AI_A2A_Dispatcher}.
-- This is a class used in the @{AI.AI_A2A_Dispatcher}.
--
-- ===
--
@@ -8,7 +8,7 @@
--
-- ===
--
-- @module AI.AI_A2A_GCI
-- @module AI.AI_A2A_Gci
-- @image AI_Ground_Control_Intercept.JPG
@@ -91,7 +91,7 @@
--
-- An optional @{Zone} can be set,
-- that will define when the AI will engage with the detected airborne enemy targets.
-- Use the method @{AI.AI_Cap#AI_A2A_GCI.SetEngageZone}() to define that Zone.
-- Use the method @{AI.AI_CAP#AI_CAP_ZONE.SetEngageZone}() to define that Zone.
--
-- ===
--