Documentation cleanup

Moose Development/Moose/Wrapper/Airbase.lua

@@ -15,7 +15,7 @@
 --- @type AIRBASE
 -- @extends Wrapper.Positionable#POSITIONABLE
 
---- AIRBASE is a wrapper class to handle the DCS Airbase objects:
+--- Wrapper class to handle the DCS Airbase objects:
 -- 
 --  * Support all DCS Airbase APIs.
 --  * Enhance with Airbase specific APIs not in the DCS Airbase API set.

Moose Development/Moose/Wrapper/Client.lua

@@ -17,7 +17,8 @@
 -- @extends Wrapper.Unit#UNIT
 
 
---- Clients are those **Units** defined within the Mission Editor that have the skillset defined as __Client__ or __Player__.
+--- Wrapper class of those **Units** defined within the Mission Editor that have the skillset defined as __Client__ or __Player__.
+-- 
 -- Note that clients are NOT the same as Units, they are NOT necessarily alive.
 -- The CLIENT class is a wrapper class to handle the DCS Unit objects that have the skillset defined as __Client__ or __Player__:
 -- 

Moose Development/Moose/Wrapper/Controllable.lua

@@ -19,7 +19,7 @@
 
 
 
---- CONTROLLABLE is a wrapper class to handle the "DCS Controllable objects", which are Groups and Units:
+--- Wrapper class to handle the "DCS Controllable objects", which are Groups and Units:
 --
 --  * Support all DCS Controllable APIs.
 --  * Enhance with Controllable specific APIs not in the DCS Controllable API set.
@@ -421,7 +421,7 @@ end
 --- Return a Controlled Task taking a Task and a TaskCondition.
 -- @param #CONTROLLABLE self
 -- @param DCS#Task DCSTask
--- @param #DCSStopCondition DCSStopCondition
+-- @param DCS#DCSStopCondition DCSStopCondition
 -- @return DCS#Task
 function CONTROLLABLE:TaskControlled( DCSTask, DCSStopCondition )
   self:F2( { DCSTask, DCSStopCondition } )
@@ -2096,7 +2096,7 @@ do -- Route methods
   -- A speed can be given in km/h.
   -- A given formation can be given.
   -- @param #CONTROLLABLE self
-  -- @param #Vec2 Vec2 The Vec2 where to route to.
+  -- @param DCS#Vec2 Vec2 The Vec2 where to route to.
   -- @param #number Speed The speed in m/s. Default is 5.555 m/s = 20 km/h.
   -- @param Base#FORMATION Formation The formation string.
   function CONTROLLABLE:TaskRouteToVec2( Vec2, Speed, Formation )
@@ -2152,7 +2152,7 @@ end -- Route methods
 --- Do Script command
 -- @param #CONTROLLABLE self
 -- @param #string DoScript
--- @return #DCSCommand
+-- @return DCS#DCSCommand
 function CONTROLLABLE:CommandDoScript( DoScript )
 
   local DCSDoScript = {

Moose Development/Moose/Wrapper/Group.lua

@@ -32,7 +32,9 @@
 -- @field #string GroupName The name of the group.
 
 
---- For each DCS Group object alive within a running mission, a GROUP wrapper object (instance) will be created within the _@{DATABASE} object.
+--- Wrapper class of the DCS world Group object.
+-- 
+-- For each DCS Group object alive within a running mission, a GROUP wrapper object (instance) will be created within the _@{DATABASE} object.
 -- This is done at the beginning of the mission (when the mission starts), and dynamically when new DCS Group objects are spawned (using the @{SPAWN} class).
 --
 -- The GROUP class does not contain a :New() method, rather it provides :Find() methods to retrieve the object reference

Moose Development/Moose/Wrapper/Identifiable.lua

@@ -15,7 +15,7 @@
 -- @extends Wrapper.Object#OBJECT
 -- @field #string IdentifiableName The name of the identifiable.
 
---- The IDENTIFIABLE class is a wrapper class to handle the DCS Identifiable objects:
+--- Wrapper class to handle the DCS Identifiable objects.
 --
 --  * Support all DCS Identifiable APIs.
 --  * Enhance with Identifiable specific APIs not in the DCS Identifiable API set.

Moose Development/Moose/Wrapper/Object.lua

@@ -17,7 +17,7 @@
 -- @field #string ObjectName The name of the Object.
 
 
---- OBJECT handles the DCS Object objects:
+--- Wrapper class to hendle the DCS Object objects.
 --
 --  * Support all DCS Object APIs.
 --  * Enhance with Object specific APIs not in the DCS Object API set.

Moose Development/Moose/Wrapper/Positionable.lua

@@ -18,7 +18,7 @@
 -- @extends Wrapper.Identifiable#IDENTIFIABLE
 
 
---- The POSITIONABLE class is a wrapper class to handle the POSITIONABLE objects:
+--- Wrapper class to handle the POSITIONABLE objects.
 --
 --  * Support all DCS APIs.
 --  * Enhance with POSITIONABLE specific APIs not in the DCS API set.
@@ -716,7 +716,7 @@ end
 --- Create a @{Radio#RADIO}, to allow radio transmission for this POSITIONABLE. 
 -- Set parameters with the methods provided, then use RADIO:Broadcast() to actually broadcast the message
 -- @param #POSITIONABLE self
--- @return #RADIO Radio
+-- @return Core.Radio#RADIO Radio
 function POSITIONABLE:GetRadio() --R2.1
   self:F2(self)
   return RADIO:New(self) 
@@ -724,7 +724,7 @@ end
 
 --- Create a @{Radio#BEACON}, to allow this POSITIONABLE to broadcast beacon signals
 -- @param #POSITIONABLE self
--- @return #RADIO Radio
+-- @return Core.Radio#RADIO Radio
 function POSITIONABLE:GetBeacon() --R2.1
   self:F2(self)
   return BEACON:New(self) 

Moose Development/Moose/Wrapper/Scenery.lua

@@ -17,7 +17,8 @@
 -- @extends Wrapper.Positionable#POSITIONABLE
 
 
---- Scenery objects are defined on the map.
+--- Wrapper class to handle Scenery objects that are defined on the map.
+-- 
 -- The @{Scenery#SCENERY} class is a wrapper class to handle the DCS Scenery objects:
 -- 
 --  * Wraps the DCS Scenery objects.

Moose Development/Moose/Wrapper/Static.lua

@@ -15,7 +15,8 @@
 --- @type STATIC
 -- @extends Wrapper.Positionable#POSITIONABLE
 
---- Statics are **Static Units** defined within the Mission Editor.
+--- Wrapper class to handle Static objects.
+-- 
 -- Note that Statics are almost the same as Units, but they don't have a controller.
 -- The @{Static#STATIC} class is a wrapper class to handle the DCS Static objects:
 -- 
@@ -126,7 +127,7 @@ function STATIC:GetThreatLevel()
 end
 
 --- Respawn the @{Wrapper.Unit} using a (tweaked) template of the parent Group.
--- @param #UNIT self
+-- @param #STATIC self
 -- @param Core.Point#COORDINATE Coordinate The coordinate where to spawn the new Static.
 -- @param #number Heading The heading of the unit respawn.
 function STATIC:SpawnAt( Coordinate, Heading )
@@ -139,7 +140,7 @@ end
 
 --- Respawn the @{Wrapper.Unit} at the same location with the same properties.
 -- This is useful to respawn a cargo after it has been destroyed.
--- @param #UNIT self
+-- @param #STATIC self
 function STATIC:ReSpawn()
 
   local SpawnStatic = SPAWNSTATIC:NewFromStatic( self.StaticName )
@@ -149,7 +150,7 @@ end
 
 
 --- Respawn the @{Wrapper.Unit} at a defined Coordinate with an optional heading.
--- @param #UNIT self
+-- @param #STATIC self
 -- @param Core.Point#COORDINATE Coordinate The coordinate where to spawn the new Static.
 -- @param #number Heading The heading of the unit respawn.
 function STATIC:ReSpawnAt( Coordinate, Heading )