Merge branch 'restructuring'

2025-10-29 16:58:06 +00:00 · 2024-01-01 15:53:05 +01:00 · 2024-01-01 15:53:05 +01:00 · d4f4465b0a
commit d4f4465b0a
parent d640acc7cc 5fe77956cb
10 changed files with 42 additions and 36 deletions
--- a/Development/Moose/AI/AI_A2A_Dispatcher.lua
+++ b/Development/Moose/AI/AI_A2A_Dispatcher.lua
@ -23,7 +23,7 @@
 --
 -- ## Missions:
 --
-- [AID-A2A - AI A2A Dispatching](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2A%20-%20AI%20A2A%20Dispatching)
+-- [AID-A2A - AI A2A Dispatching](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_A2A_Dispatcher)
 --
 -- ===
 --
@ -310,7 +310,7 @@ do -- AI_A2A_DISPATCHER
  -- Use the method @{#AI_A2A_DISPATCHER.SetEngageRadius}() to set a specific Engage Radius.
  -- **The Engage Radius is defined for ALL squadrons which are operational.**
  --
-  -- Demonstration Mission: [AID-019 - AI_A2A - Engage Range Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2A%20-%20AI%20A2A%20Dispatching/AID-A2A-019%20-%20Engage%20Range%20Test)
+  -- Demonstration Mission: [AID-019 - AI_A2A - Engage Range Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_A2A_Dispatcher/AID-A2A-019%20-%20Engage%20Range%20Test)
  --
  -- In this example an Engage Radius is set to various values.
  --
@ -333,7 +333,7 @@ do -- AI_A2A_DISPATCHER
  -- Use the method @{#AI_A2A_DISPATCHER.SetGciRadius}() to set a specific controlled ground intercept radius.
  -- **The Ground Controlled Intercept radius is defined for ALL squadrons which are operational.**
  --
-  -- Demonstration Mission: [AID-013 - AI_A2A - Intercept Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2A%20-%20AI%20A2A%20Dispatching/AID-A2A-013%20-%20Intercept%20Test)
+  -- Demonstration Mission: [AID-013 - AI_A2A - Intercept Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_A2A_Dispatcher/AID-A2A-013%20-%20Intercept%20Test)
  --
  -- In these examples, the Gci Radius is set to various values:
  --
@ -366,7 +366,7 @@ do -- AI_A2A_DISPATCHER
  -- it makes it easier sometimes for the mission maker to envisage where the red and blue territories roughly are.
  -- In a hot war the borders are effectively defined by the ground based radar coverage of a coalition.
  --
-  -- Demonstration Mission: [AID-009 - AI_A2A - Border Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2A%20-%20AI%20A2A%20Dispatching/AID-A2A-009%20-%20Border%20Test)
+  -- Demonstration Mission: [AID-009 - AI_A2A - Border Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_A2A_Dispatcher/AID-A2A-009%20-%20Border%20Test)
  --
  -- In this example a border is set for the CCCP A2A dispatcher:
  --
@ -3257,7 +3257,8 @@ do -- AI_A2A_DISPATCHER
            end
          end

-          --- @param #AI_A2A_DISPATCHER self
+          --- AI_A2A_Fsm:onafterHome
+          -- @param #AI_A2A_DISPATCHER self
          function AI_A2A_Fsm:onafterHome( Defender, From, Event, To, Action )
            if Defender and Defender:IsAlive() then
              self:F( { "CAP Home", Defender:GetName() } )
@ -3505,7 +3506,8 @@ do -- AI_A2A_DISPATCHER
                    Dispatcher:ClearDefenderTaskTarget( DefenderGroup )
                  end

-                  --- @param #AI_A2A_DISPATCHER self
+                  --- function Fsm:onafterLostControl
+                  -- @param #AI_A2A_DISPATCHER self
                  function Fsm:onafterLostControl( Defender, From, Event, To )
                    self:F( { "GCI LostControl", Defender:GetName() } )
                    self:GetParent( self ).onafterHome( self, Defender, From, Event, To )
@ -3518,7 +3520,8 @@ do -- AI_A2A_DISPATCHER
                    end
                  end

-                  --- @param #AI_A2A_DISPATCHER self
+                  --- function Fsm:onafterHome
+                  -- @param #AI_A2A_DISPATCHER self
                  function Fsm:onafterHome( DefenderGroup, From, Event, To, Action )
                    self:F( { "GCI Home", DefenderGroup:GetName() } )
                    self:GetParent( self ).onafterHome( self, DefenderGroup, From, Event, To )
--- a/Development/Moose/AI/AI_A2G_Dispatcher.lua
+++ b/Development/Moose/AI/AI_A2G_Dispatcher.lua
@ -24,7 +24,7 @@
 -- 
 -- ## Missions:
 -- 
-- [AID-A2G - AI A2G Dispatching](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2G%20-%20AI%20A2G%20Dispatching)
+-- [AID-A2G - AI A2G Dispatching](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_A2G_Dispatcher)
 -- 
 -- ===
 -- 
--- a/Development/Moose/AI/AI_Air_Dispatcher.lua
+++ b/Development/Moose/AI/AI_Air_Dispatcher.lua
@ -24,7 +24,7 @@
 -- 
 -- ## Missions:
 -- 
-- [AID-AIR - AI AIR Dispatching](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching)
+-- [AI_A2A_Dispatcher](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_A2A_Dispatcher)
 -- 
 -- ===
 -- 
--- a/Development/Moose/AI/AI_Balancer.lua
+++ b/Development/Moose/AI/AI_Balancer.lua
@ -9,7 +9,7 @@
 -- 
 -- ===
 -- 
-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AIB%20-%20AI%20Balancing)
+-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_Balancer)
 -- 
 -- ===
 -- 
@ -168,7 +168,8 @@ function AI_BALANCER:ReturnToHomeAirbase( ReturnThresholdRange )
  self.ReturnThresholdRange = ReturnThresholdRange
 end

--- @param #AI_BALANCER self
+--- AI_BALANCER:onenterSpawning
+-- @param #AI_BALANCER self
 -- @param Core.Set#SET_GROUP SetGroup
 -- @param #string ClientName
 -- @param Wrapper.Group#GROUP AIGroup
@ -190,7 +191,8 @@ function AI_BALANCER:onenterSpawning( SetGroup, From, Event, To, ClientName )
  end
 end

--- @param #AI_BALANCER self
+--- AI_BALANCER:onenterDestroying
+-- @param #AI_BALANCER self
 -- @param Core.Set#SET_GROUP SetGroup
 -- @param Wrapper.Group#GROUP AIGroup
 function AI_BALANCER:onenterDestroying( SetGroup, From, Event, To, ClientName, AIGroup )
@ -233,15 +235,16 @@ function AI_BALANCER:onenterReturning( SetGroup, From, Event, To, AIGroup )

 end

-
--- @param #AI_BALANCER self
+--- AI_BALANCER:onenterMonitoring
+-- @param #AI_BALANCER self
 function AI_BALANCER:onenterMonitoring( SetGroup )

  self:T2( { self.SetClient:Count() } )
  --self.SetClient:Flush()

  self.SetClient:ForEachClient(
-    --- @param Wrapper.Client#CLIENT Client
+    --- SetClient:ForEachClient
+    -- @param Wrapper.Client#CLIENT Client
    function( Client )
      self:T3(Client.ClientName)

@ -264,7 +267,8 @@ function AI_BALANCER:onenterMonitoring( SetGroup )
            self:T2( RangeZone )
            
            _DATABASE:ForEachPlayerUnit(
-              --- @param Wrapper.Unit#UNIT RangeTestUnit
+              --- Nameless function
+              -- @param Wrapper.Unit#UNIT RangeTestUnit
              function( RangeTestUnit, RangeZone, AIGroup, PlayerInRange )
                self:T2( { PlayerInRange, RangeTestUnit.UnitName, RangeZone.ZoneName } )
                if RangeTestUnit:IsInZone( RangeZone ) == true then
@ -276,7 +280,8 @@ function AI_BALANCER:onenterMonitoring( SetGroup )
                end
              end,
              
-              --- @param Core.Zone#ZONE_RADIUS RangeZone
+              --- Nameless function
+              -- @param Core.Zone#ZONE_RADIUS RangeZone
              -- @param Wrapper.Group#GROUP AIGroup
              function( RangeZone, AIGroup, PlayerInRange )
                if PlayerInRange.Value == false then
@ -307,6 +312,3 @@ function AI_BALANCER:onenterMonitoring( SetGroup )
  
  self:__Monitor( 10 )
 end
-
-
-
--- a/Development/Moose/AI/AI_Cargo_Dispatcher.lua
+++ b/Development/Moose/AI/AI_Cargo_Dispatcher.lua
@ -18,7 +18,7 @@
 -- 
 -- Test missions can be located on the main GITHUB site.
 -- 
-- [FlightControl-Master/MOOSE_MISSIONS/AID - AI Dispatching/AID-CGO - AI Cargo Dispatching/](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/AID%20-%20AI%20Dispatching/AID-CGO%20-%20AI%20Cargo%20Dispatching)
+-- [FlightControl-Master/MOOSE_MISSIONS/AID - AI Dispatching/AID-CGO - AI Cargo Dispatching/](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_Cargo_Dispatcher)
 -- 
 -- ===
 -- 
@ -572,7 +572,7 @@
 -- A home zone can be specified to where the Carriers will move when there isn't any cargo left for pickup.
 -- Use @{#AI_CARGO_DISPATCHER.SetHomeZone}() to specify the home zone.
 -- 
-- If no home zone is specified, the carriers will wait near the deploy zone for a new pickup command.   
+-- If no home zone is specified, the carriers will wait near the deploy zone for a new pickup command.
 -- 
 -- ===
 --   
@ -583,10 +583,12 @@ AI_CARGO_DISPATCHER = {
  PickupCargo = {}
 }

--- @field #list 
+--- List of AI_Cargo
+-- @field #list
 AI_CARGO_DISPATCHER.AI_Cargo = {}

--- @field #list
+--- List of PickupCargo
+-- @field #list
 AI_CARGO_DISPATCHER.PickupCargo = {}


--- a/Development/Moose/Functional/ATC_Ground.lua
+++ b/Development/Moose/Functional/ATC_Ground.lua
@ -10,9 +10,7 @@
 -- 
 -- ===
 -- 
-- ## Missions:
-- 
-- [ABP - Airbase Police](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/ABP%20-%20Airbase%20Police)
+-- ## Missions: None
 --
 -- ===
 --
@ -699,7 +697,8 @@ end
 function ATC_GROUND_UNIVERSAL:_AirbaseMonitor()
  self:I("_AirbaseMonitor")
  self.SetClient:ForEachClient(
-    --- @param Wrapper.Client#CLIENT Client
+    --- Nameless function
+    -- @param Wrapper.Client#CLIENT Client
    function( Client )

      if Client:IsAlive() then
--- a/Development/Moose/Functional/Detection.lua
+++ b/Development/Moose/Functional/Detection.lua
@ -95,7 +95,7 @@ do -- DETECTION_BASE
  -- 
  -- ## Radar Blur - use to make the radar less exact, e.g. for WWII scenarios
  -- 
-  --  * @{DETECTION_BASE.SetRadarBlur}(): Set the radar blur to be used.
+  --  * @{#DETECTION_BASE.SetRadarBlur}(): Set the radar blur to be used.
  --  
  -- ## **DETECTION_ derived classes** group the detected units into a **DetectedItems[]** list
  --
--- a/Development/Moose/Sound/SRS.lua
+++ b/Development/Moose/Sound/SRS.lua
@ -146,7 +146,7 @@
 -- 
 -- ### Google
 -- 
-- In order to use Google Cloud for TTS you need to use @{#MSRS.SetProvider} and @{MSRS.SetProviderOptionsGoogle} functions:
+-- In order to use Google Cloud for TTS you need to use @{#MSRS.SetProvider} and @{#MSRS.SetProviderOptionsGoogle} functions:
 -- 
 --     msrs:SetProvider(MSRS.Provider.GOOGLE)
 --     msrs:SetProviderOptionsGoogle(CredentialsFile, AccessKey)
@ -162,7 +162,7 @@
 -- 
 -- ### Amazon Web Service [Only DCS-gRPC backend]
 -- 
-- In order to use Amazon Web Service (AWS) for TTS you need to use @{#MSRS.SetProvider} and @{MSRS.SetProviderOptionsAmazon} functions:
+-- In order to use Amazon Web Service (AWS) for TTS you need to use @{#MSRS.SetProvider} and @{#MSRS.SetProviderOptionsAmazon} functions:
 -- 
 --     msrs:SetProvider(MSRS.Provider.AMAZON)
 --     msrs:SetProviderOptionsAmazon(AccessKey, SecretKey, Region)
@ -173,7 +173,7 @@
 -- 
 -- ### Microsoft Azure [Only DCS-gRPC backend]
 -- 
-- In order to use Microsoft Azure for TTS you need to use @{#MSRS.SetProvider} and @{MSRS.SetProviderOptionsAzure} functions:
+-- In order to use Microsoft Azure for TTS you need to use @{#MSRS.SetProvider} and @{#MSRS.SetProviderOptionsAzure} functions:
 -- 
 --     msrs:SetProvider(MSRS.Provider.AZURE)
 --     msrs:SetProviderOptionsAmazon(AccessKey, Region)
--- a/Development/Moose/Wrapper/Group.lua
+++ b/Development/Moose/Wrapper/Group.lua
@ -302,7 +302,7 @@ end

 --- Find the first(!) GROUP matching using patterns. Note that this is **a lot** slower than `:FindByName()`!
 -- @param #GROUP self
-- @param #string Pattern The pattern to look for. Refer to [LUA patterns](http://www.easyuo.com/openeuo/wiki/index.php/Lua_Patterns_and_Captures_(Regular_Expressions)) for regular expressions in LUA.
+-- @param #string Pattern The pattern to look for. Refer to [LUA patterns](http://www.easyuo.com/openeuo/wiki/index.php/Lua_Patterns_and_Captures_\(Regular_Expressions\)) for regular expressions in LUA.
 -- @return #GROUP The GROUP.
 -- @usage
 --          -- Find a group with a partial group name
@ -327,7 +327,7 @@ end

 --- Find all GROUP objects matching using patterns. Note that this is **a lot** slower than `:FindByName()`!
 -- @param #GROUP self
-- @param #string Pattern The pattern to look for. Refer to [LUA patterns](http://www.easyuo.com/openeuo/wiki/index.php/Lua_Patterns_and_Captures_(Regular_Expressions)) for regular expressions in LUA.
+-- @param #string Pattern The pattern to look for. Refer to [LUA patterns](http://www.easyuo.com/openeuo/wiki/index.php/Lua_Patterns_and_Captures_\(Regular_Expressions\)) for regular expressions in LUA.
 -- @return #table Groups Table of matching #GROUP objects found
 -- @usage
 --          -- Find all group with a partial group name
--- a/Development/Moose/Wrapper/Unit.lua
+++ b/Development/Moose/Wrapper/Unit.lua
@ -164,7 +164,7 @@ end

 --- Find the first(!) UNIT matching using patterns. Note that this is **a lot** slower than `:FindByName()`!
 -- @param #UNIT self
-- @param #string Pattern The pattern to look for. Refer to [LUA patterns](http://www.easyuo.com/openeuo/wiki/index.php/Lua_Patterns_and_Captures_(Regular_Expressions)) for regular expressions in LUA.
+-- @param #string Pattern The pattern to look for. Refer to [LUA patterns](http://www.easyuo.com/openeuo/wiki/index.php/Lua_Patterns_and_Captures_\(Regular_Expressions\)) for regular expressions in LUA.
 -- @return #UNIT The UNIT.
 -- @usage
 --          -- Find a group with a partial group name
@ -189,7 +189,7 @@ end

 --- Find all UNIT objects matching using patterns. Note that this is **a lot** slower than `:FindByName()`!
 -- @param #UNIT self
-- @param #string Pattern The pattern to look for. Refer to [LUA patterns](http://www.easyuo.com/openeuo/wiki/index.php/Lua_Patterns_and_Captures_(Regular_Expressions)) for regular expressions in LUA.
+-- @param #string Pattern The pattern to look for. Refer to [LUA patterns](http://www.easyuo.com/openeuo/wiki/index.php/Lua_Patterns_and_Captures_\(Regular_Expressions\)) for regular expressions in LUA.
 -- @return #table Units Table of matching #UNIT objects found
 -- @usage
 --          -- Find all group with a partial group name