UPDATE: WRAPPER function params

- Added (Optional) to param descriptions for params that have default values

Moose Development/Moose/Wrapper/Airbase.lua

@@ -2164,7 +2164,7 @@ end
 
 --- Get number of parking spots at an airbase. Optionally, a specific terminal type can be requested.
 -- @param #AIRBASE self
--- @param #AIRBASE.TerminalType termtype Terminal type of which the number of spots is counted. Default all spots but spawn points on runway.
+-- @param #AIRBASE.TerminalType termtype (Optional) Terminal type of which the number of spots is counted. Default all spots but spawn points on runway.
 -- @return #number Number of parking spots at this airbase.
 function AIRBASE:GetParkingSpotsNumber(termtype)
 
@@ -2184,7 +2184,7 @@ end
 --- Get number of free parking spots at an airbase.
 -- @param #AIRBASE self
 -- @param #AIRBASE.TerminalType termtype Terminal type.
--- @param #boolean allowTOAC If true, spots are considered free even though TO_AC is true. Default is off which is saver to avoid spawning aircraft on top of each other. Option might be enabled for FARPS and ships.
+-- @param #boolean allowTOAC (Optional) If true, spots are considered free even though TO_AC is true. Default is off which is saver to avoid spawning aircraft on top of each other. Option might be enabled for FARPS and ships.
 -- @return #number Number of free parking spots at this airbase.
 function AIRBASE:GetFreeParkingSpotsNumber(termtype, allowTOAC)
 
@@ -2207,7 +2207,7 @@ end
 --- Get the coordinates of free parking spots at an airbase.
 -- @param #AIRBASE self
 -- @param #AIRBASE.TerminalType termtype Terminal type.
--- @param #boolean allowTOAC If true, spots are considered free even though TO_AC is true. Default is off which is saver to avoid spawning aircraft on top of each other. Option might be enabled for FARPS and ships.
+-- @param #boolean allowTOAC (Optional) If true, spots are considered free even though TO_AC is true. Default is off which is saver to avoid spawning aircraft on top of each other. Option might be enabled for FARPS and ships.
 -- @return #table Table of coordinates of the free parking spots.
 function AIRBASE:GetFreeParkingSpotsCoordinates(termtype, allowTOAC)
 
@@ -2434,7 +2434,7 @@ end
 --- Get a table containing the coordinates, terminal index and terminal type of free parking spots at an airbase.
 -- @param #AIRBASE self
 -- @param #AIRBASE.TerminalType termtype Terminal type.
--- @param #boolean allowTOAC If true, spots are considered free even though TO_AC is true. Default is off which is saver to avoid spawning aircraft on top of each other. Option might be enabled for FARPS and ships.
+-- @param #boolean allowTOAC (Optional) If true, spots are considered free even though TO_AC is true. Default is off which is saver to avoid spawning aircraft on top of each other. Option might be enabled for FARPS and ships.
 -- @return #table Table free parking spots. Table has the elements ".Coordinate, ".TerminalID", ".TerminalType", ".TOAC", ".Free", ".TerminalID0", ".DistToRwy".
 function AIRBASE:GetFreeParkingSpotsTable(termtype, allowTOAC)
 
@@ -2486,7 +2486,7 @@ end
 --- Place markers of parking spots on the F10 map.
 -- @param #AIRBASE self
 -- @param #AIRBASE.TerminalType termtype Terminal type for which marks should be placed.
--- @param #boolean mark If false, do not place markers but only give output to DCS.log file. Default true.
+-- @param #boolean mark (Optional) If false, do not place markers but only give output to DCS.log file. Default true.
 function AIRBASE:MarkParkingSpots(termtype, mark)
 
   -- Default is true.
@@ -3266,7 +3266,7 @@ end
 --- Set the active runway for landing and takeoff.
 -- @param #AIRBASE self
 -- @param #string Name Name of the runway, e.g. "31" or "02L" or "90R". If not given, the runway is determined from the wind direction.
--- @param #boolean PreferLeft If `true`, perfer the left runway. If `false`, prefer the right runway. If `nil` (default), do not care about left or right.
+-- @param #boolean PreferLeft (Optional) If `true`, perfer the left runway. If `false`, prefer the right runway. If `nil` (default), do not care about left or right.
 function AIRBASE:SetActiveRunway(Name, PreferLeft)
 
   self:SetActiveRunwayTakeoff(Name, PreferLeft)
@@ -3278,7 +3278,7 @@ end
 --- Set the active runway for landing.
 -- @param #AIRBASE self
 -- @param #string Name Name of the runway, e.g. "31" or "02L" or "90R". If not given, the runway is determined from the wind direction.
--- @param #boolean PreferLeft If `true`, perfer the left runway. If `false`, prefer the right runway. If `nil` (default), do not care about left or right.
+-- @param #boolean PreferLeft (Optional) If `true`, perfer the left runway. If `false`, prefer the right runway. If `nil` (default), do not care about left or right.
 -- @return #AIRBASE.Runway The active runway for landing.
 function AIRBASE:SetActiveRunwayLanding(Name, PreferLeft)
 
@@ -3326,7 +3326,7 @@ end
 --- Set the active runway for takeoff.
 -- @param #AIRBASE self
 -- @param #string Name Name of the runway, e.g. "31" or "02L" or "90R". If not given, the runway is determined from the wind direction.
--- @param #boolean PreferLeft If `true`, perfer the left runway. If `false`, prefer the right runway. If `nil` (default), do not care about left or right.
+-- @param #boolean PreferLeft (Optional) If `true`, perfer the left runway. If `false`, prefer the right runway. If `nil` (default), do not care about left or right.
 -- @return #AIRBASE.Runway The active runway for landing.
 function AIRBASE:SetActiveRunwayTakeoff(Name, PreferLeft)
 
@@ -3351,7 +3351,7 @@ end
 --- Get the runway where aircraft would be taking of or landing into the direction of the wind.
 -- NOTE that this requires the wind to be non-zero as set in the mission editor.
 -- @param #AIRBASE self
--- @param #boolean PreferLeft If `true`, perfer the left runway. If `false`, prefer the right runway. If `nil` (default), do not care about left or right.
+-- @param #boolean PreferLeft (Optional) If `true`, perfer the left runway. If `false`, prefer the right runway. If `nil` (default), do not care about left or right.
 -- @return #AIRBASE.Runway Active runway data table.
 function AIRBASE:GetRunwayIntoWind(PreferLeft)
 
@@ -3407,7 +3407,7 @@ end
 
 --- Get name of a given runway, e.g. "31L".
 -- @param #AIRBASE self
--- @param #AIRBASE.Runway Runway The runway. Default is the active runway.
+-- @param #AIRBASE.Runway Runway (Optional) The runway. Default is the active runway.
 -- @param #boolean LongLeftRight If `true`, return "Left" or "Right" instead of "L" or "R".
 -- @return #string Name of the runway or "XX" if it could not be found.
 function AIRBASE:GetRunwayName(Runway, LongLeftRight)
@@ -3438,7 +3438,7 @@ end
 --- Function that checks if at leat one unit of a group has been spawned close to a spawn point on the runway.
 -- @param #AIRBASE self
 -- @param Wrapper.Group#GROUP group Group to be checked.
--- @param #number radius Radius around the spawn point to be checked. Default is 50 m.
+-- @param #number radius (Optional) Radius around the spawn point to be checked. Default is 50 m.
 -- @param #boolean despawn If true, the group is destroyed.
 -- @return #boolean True if group is within radius around spawn points on runway.
 function AIRBASE:CheckOnRunWay(group, radius, despawn)

Moose Development/Moose/Wrapper/Client.lua

@@ -117,7 +117,7 @@ end
 -- @param #CLIENT self
 -- @param #string ClientName Name of the DCS **Unit** as defined within the Mission Editor.
 -- @param #string ClientBriefing Text that describes the briefing of the mission when a Player logs into the Client.
--- @param #boolean Error A flag that indicates whether an error should be raised if the CLIENT cannot be found. By default an error will be raised.
+-- @param #boolean Error (Optional) A flag that indicates whether an error should be raised if the CLIENT cannot be found. By default an error will be raised.
 -- @return #CLIENT
 -- @usage
 -- -- Create new Clients.

Moose Development/Moose/Wrapper/Controllable.lua

@@ -784,7 +784,7 @@ end
 
 --- Activate LINK4 system of the CONTROLLABLE. The controllable should be an aircraft carrier!
 -- @param #CONTROLLABLE self
--- @param #number Frequency Link4 Frequency in MHz, e.g. 336 (defaults to 336 MHz)
+-- @param #number Frequency (Optional) Link4 Frequency in MHz, e.g. 336 (defaults to 336 MHz)
 -- @param #number UnitID (Optional) The DCS UNIT ID of the unit the LINK4 system is attached to. Defaults to the UNIT itself.
 -- @param #string Callsign (Optional) Morse code identification callsign.
 -- @param #number Delay (Optional) Delay in seconds before the LINK4 is activated.
@@ -875,7 +875,7 @@ end
 --- Set callsign of the CONTROLLABLE. See [DCS command setCallsign](https://wiki.hoggitworld.com/view/DCS_command_setCallsign)
 -- @param #CONTROLLABLE self
 -- @param DCS#CALLSIGN CallName Number corresponding the the callsign identifier you wish this group to be called.
--- @param #number CallNumber The number value the group will be referred to as. Only valid numbers are 1-9. For example Uzi **5**-1. Default 1.
+-- @param #number CallNumber (Optional) The number value the group will be referred to as. Only valid numbers are 1-9. For example Uzi **5**-1. Default 1.
 -- @param #number Delay (Optional) Delay in seconds before the callsign is set. Default is immediately.
 -- @return #CONTROLLABLE self
 function CONTROLLABLE:CommandSetCallsign( CallName, CallNumber, Delay )
@@ -953,7 +953,7 @@ end
 --- Set radio frequency. See [DCS command SetFrequency](https://wiki.hoggitworld.com/view/DCS_command_setFrequency)
 -- @param #CONTROLLABLE self
 -- @param #number Frequency Radio frequency in MHz.
--- @param #number Modulation Radio modulation. Default `radio.modulation.AM`.
+-- @param #number Modulation (Optional) Radio modulation. Default `radio.modulation.AM`.
 -- @param #number Power (Optional) Power of the Radio in Watts. Defaults to 10.
 -- @param #number Delay (Optional) Delay in seconds before the frequency is set. Default is immediately.
 -- @return #CONTROLLABLE self
@@ -980,7 +980,7 @@ end
 --- [AIR] Set radio frequency. See [DCS command SetFrequencyForUnit](https://wiki.hoggitworld.com/view/DCS_command_setFrequencyForUnit)
 -- @param #CONTROLLABLE self
 -- @param #number Frequency Radio frequency in MHz.
--- @param #number Modulation Radio modulation. Default `radio.modulation.AM`.
+-- @param #number Modulation (Optional) Radio modulation. Default `radio.modulation.AM`.
 -- @param #number Power (Optional) Power of the Radio in Watts. Defaults to 10.
 -- @param #number UnitID (Optional, if your object is a UNIT) The UNIT ID this is for.
 -- @param #number Delay (Optional) Delay in seconds before the frequency is set. Default is immediately.
@@ -1005,7 +1005,7 @@ end
 
 --- [AIR] Set smoke on or off. See [DCS command smoke on off](https://wiki.hoggitworld.com/view/DCS_command_smoke_on_off)
 -- @param #CONTROLLABLE self
--- @param #boolean OnOff Set to true for on and false for off. Defaults to true.
+-- @param #boolean OnOff (Optional) Set to true for on and false for off. Defaults to true.
 -- @param #number Delay (Optional) Delay the command by this many seconds.
 -- @return #CONTROLLABLE self
 function CONTROLLABLE:CommandSmokeOnOff(OnOff, Delay)
@@ -1065,7 +1065,7 @@ end
 --- Set EPLRS data link on/off.
 -- @param #CONTROLLABLE self
 -- @param #boolean SwitchOnOff If true (or nil) switch EPLRS on. If false switch off.
--- @param #number idx Task index. Default 1.
+-- @param #number idx (Optional) Task index. Default 1.
 -- @return #table Task wrapped action.
 function CONTROLLABLE:TaskEPLRS( SwitchOnOff, idx )
 
@@ -1383,7 +1383,7 @@ end
 -- The controllable has to be an infantry group!
 -- @param #CONTROLLABLE self
 -- @param Core.Point#COORDINATE Coordinate Coordinates where AI is expecting to be picked up.
--- @param #number Radius Radius in meters. Default 200 m.
+-- @param #number Radius (Optional) Radius in meters. Default 200 m.
 -- @param #string UnitType The unit type name of the carrier, e.g. "UH-1H". Must not be specified.
 -- @return DCS#Task Embark to transport task.
 function CONTROLLABLE:TaskEmbarkToTransport( Coordinate, Radius, UnitType )
@@ -1457,8 +1457,8 @@ end
 --- (AIR) Orbit at a position with at a given altitude and speed. Optionally, a race track pattern can be specified.
 -- @param #CONTROLLABLE self
 -- @param Core.Point#COORDINATE Coord Coordinate at which the CONTROLLABLE orbits. Can also be given as a `DCS#Vec3` or `DCS#Vec2` object.
--- @param #number Altitude Altitude in meters of the orbit pattern. Default y component of Coord.
--- @param #number Speed Speed [m/s] flying the orbit pattern. Default 128 m/s = 250 knots.
+-- @param #number Altitude (Optional) Altitude in meters of the orbit pattern. Default y component of Coord.
+-- @param #number Speed (Optional) Speed [m/s] flying the orbit pattern. Default 128 m/s = 250 knots.
 -- @param Core.Point#COORDINATE CoordRaceTrack (Optional) If this coordinate is specified, the CONTROLLABLE will fly a race-track pattern using this and the initial coordinate.
 -- @return #CONTROLLABLE self
 function CONTROLLABLE:TaskOrbit( Coord, Altitude, Speed, CoordRaceTrack )
@@ -1528,11 +1528,11 @@ end
 --
 -- @param #CONTROLLABLE self
 -- @param Wrapper.Airbase#AIRBASE Airbase Airbase to attack.
--- @param #number WeaponType (optional) Bitmask of weapon types those allowed to use. See [DCS enum weapon flag](https://wiki.hoggitworld.com/view/DCS_enum_weapon_flag). Default 2147485694 = AnyBomb (GuidedBomb + AnyUnguidedBomb).
--- @param DCS#AI.Task.WeaponExpend WeaponExpend Enum AI.Task.WeaponExpend that defines how much munitions the AI will expend per attack run. Default "ALL".
--- @param #number AttackQty Number of times the group will attack if the target. Default 1.
--- @param DCS#Azimuth Direction (optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.
--- @param #boolean GroupAttack (optional) Flag indicates that the target must be engaged by all aircrafts of the controllable. Has effect only if the task is assigned to a group and not to a single aircraft.
+-- @param #number WeaponType (Optional) Bitmask of weapon types those allowed to use. See [DCS enum weapon flag](https://wiki.hoggitworld.com/view/DCS_enum_weapon_flag). Default 2147485694 = AnyBomb (GuidedBomb + AnyUnguidedBomb).
+-- @param DCS#AI.Task.WeaponExpend (Optional) WeaponExpend Enum AI.Task.WeaponExpend that defines how much munitions the AI will expend per attack run. Default "ALL".
+-- @param #number AttackQty (Optional) Number of times the group will attack if the target. Default 1.
+-- @param DCS#Azimuth Direction (Optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.
+-- @param #boolean GroupAttack (Optional) Flag indicates that the target must be engaged by all aircrafts of the controllable. Has effect only if the task is assigned to a group and not to a single aircraft.
 -- @return DCS#Task The DCS task structure.
 function CONTROLLABLE:TaskBombingRunway( Airbase, WeaponType, WeaponExpend, AttackQty, Direction, GroupAttack )
 
@@ -1723,7 +1723,7 @@ end
 -- @param DCS#Vec3 Vec3 Position of the unit / lead unit of the controllable relative lead unit of another controllable in frame reference oriented by course of lead unit of another controllable. If another controllable is on land the unit / controllable will orbit around.
 -- @param #number LastWaypointIndex Detach waypoint of another controllable. Once reached the unit / controllable Escort task is finished.
 -- @param #number EngagementDistance Maximal distance from escorted controllable to threat in meters. If the threat is already engaged by escort escort will disengage if the distance becomes greater than 1.5 * engagementDistMax.
--- @param DCS#AttributeNameArray TargetTypes Array of AttributeName that is contains threat categories allowed to engage. Default {"Air"}. See https://wiki.hoggit.us/view/DCS_enum_attributes
+-- @param DCS#AttributeNameArray TargetTypes (Optional) Array of AttributeName that is contains threat categories allowed to engage. Default {"Air"}. See https://wiki.hoggit.us/view/DCS_enum_attributes
 -- @return DCS#Task The DCS task structure.
 function CONTROLLABLE:TaskEscort( FollowControllable, Vec3, LastWaypointIndex, EngagementDistance, TargetTypes )
 
@@ -1763,7 +1763,7 @@ end
 -- @param #number AmmoCount (optional) Quantity of ammunition to expand (omit to fire until ammunition is depleted).
 -- @param #number WeaponType (optional) Enum for weapon type ID. This value is only required if you want the group firing to use a specific weapon, for instance using the task on a ship to force it to fire guided missiles at targets within cannon range. See http://wiki.hoggit.us/view/DCS_enum_weapon_flag
 -- @param #number Altitude (Optional) Altitude in meters.
--- @param #number ASL Altitude is above mean sea level. Default is above ground level.
+-- @param #number ASL (Optional) Altitude is above mean sea level. Default is above ground level.
 -- @return DCS#Task The DCS task structure.
 function CONTROLLABLE:TaskFireAtPoint( Vec2, Radius, AmmoCount, WeaponType, Altitude, ASL )
 
@@ -1816,11 +1816,11 @@ end
 -- It's important to note that depending on the type of unit that is being assigned the task (AIR or GROUND), you must choose the correct type of callsign enumerator. For airborne controllables use CALLSIGN.Aircraft and for ground based use CALLSIGN.JTAC enumerators.
 -- @param #CONTROLLABLE self
 -- @param Wrapper.Group#GROUP AttackGroup Target GROUP object.
--- @param #number WeaponType Bitmask of weapon types, which are allowed to use.
--- @param DCS#AI.Task.Designation Designation (Optional) Designation type.
+-- @param #number WeaponType (Optional) Bitmask of weapon types, which are allowed to use. Defaults tp ENUMS.WeaponFlag.AutoDCS.
+-- @param DCS#AI.Task.Designation Designation (Optional) Designation type. Defaults to Auto.
 -- @param #boolean Datalink (Optional) Allows to use datalink to send the target information to attack aircraft. Enabled by default.
--- @param #number Frequency Frequency in MHz used to communicate with the FAC. Default 133 MHz.
--- @param #number Modulation Modulation of radio for communication. Default 0=AM.
+-- @param #number Frequency (Optional) Frequency in MHz used to communicate with the FAC. Default 133 MHz.
+-- @param #number Modulation (Optional) Modulation of radio for communication. Default 0=AM.
 -- @param #number CallsignName Callsign enumerator name of the FAC. (CALLSIGN.Aircraft.{name} for airborne controllables, CALLSIGN.JTACS.{name} for ground units)
 -- @param #number CallsignNumber Callsign number, e.g. Axeman-**1**.
 -- @return DCS#Task The DCS task structure.
@@ -1846,8 +1846,8 @@ end
 --- (AIR) Engaging targets of defined types.
 -- @param #CONTROLLABLE self
 -- @param DCS#Distance Distance Maximal distance from the target to a route leg. If the target is on a greater distance it will be ignored.
--- @param DCS#AttributeNameArray TargetTypes Array of target categories allowed to engage.
--- @param #number Priority All enroute tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first. Default 0.
+-- @param DCS#AttributeNameArray TargetTypes (Optional) Array of target categories allowed to engage. Defaults to {"Air"}.
+-- @param #number Priority (Optional) All enroute tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first. Default 0.
 -- @return DCS#Task The DCS task structure.
 function CONTROLLABLE:EnRouteTaskEngageTargets( Distance, TargetTypes, Priority )
 
@@ -1888,7 +1888,7 @@ end
 
 --- (AIR) Enroute anti-ship task.
 -- @param #CONTROLLABLE self
--- @param DCS#AttributeNameArray TargetTypes Array of target categories allowed to engage. Default `{"Ships"}`.
+-- @param DCS#AttributeNameArray TargetTypes (Optional) Array of target categories allowed to engage. Default `{"Ships"}`.
 -- @param #number Priority (Optional) All en-route tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first. Default 0.
 -- @return DCS#Task The DCS task structure.
 function CONTROLLABLE:EnRouteTaskAntiShip(TargetTypes, Priority)
@@ -1909,7 +1909,7 @@ end
 
 --- (AIR) Enroute SEAD task.
 -- @param #CONTROLLABLE self
--- @param DCS#AttributeNameArray TargetTypes Array of target categories allowed to engage. Default `{"Air Defence"}`.
+-- @param DCS#AttributeNameArray TargetTypes (Optional) Array of target categories allowed to engage. Default `{"Air Defence"}`.
 -- @param #number Priority (Optional) All en-route tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first. Default 0.
 -- @return DCS#Task The DCS task structure.
 function CONTROLLABLE:EnRouteTaskSEAD(TargetTypes, Priority)
@@ -1930,7 +1930,7 @@ end
 
 --- (AIR) Enroute CAP task.
 -- @param #CONTROLLABLE self
--- @param DCS#AttributeNameArray TargetTypes Array of target categories allowed to engage. Default `{"Air"}`.
+-- @param DCS#AttributeNameArray TargetTypes (Optional) Array of target categories allowed to engage. Default `{"Air"}`.
 -- @param #number Priority (Optional) All en-route tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first. Default 0.
 -- @return DCS#Task The DCS task structure.
 function CONTROLLABLE:EnRouteTaskCAP(TargetTypes, Priority)
@@ -2103,11 +2103,11 @@ end
 -- Target designation is set to auto and is dependent on the circumstances.
 -- See [hoggit](https://wiki.hoggitworld.com/view/DCS_task_fac).
 -- @param #CONTROLLABLE self
--- @param #number Frequency Frequency in MHz. Default 133 MHz.
--- @param #number Modulation Radio modulation. Default `radio.modulation.AM`.
+-- @param #number Frequency (Optional) Frequency in MHz. Default 133 MHz.
+-- @param #number Modulation (Optional) Radio modulation. Default `radio.modulation.AM`.
 -- @param #number CallsignID CallsignID, e.g. `CALLSIGN.JTAC.Anvil` for ground or `CALLSIGN.Aircraft.Ford` for air.
 -- @param #number CallsignNumber Callsign first number, e.g. 2 for `Ford-2`.
--- @param #number Priority All en-route tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first.
+-- @param #number Priority (Optional) All en-route tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first. Defaults to 0.
 -- @return DCS#Task The DCS task structure.
 function CONTROLLABLE:EnRouteTaskFAC( Frequency, Modulation, CallsignID, CallsignNumber, Priority )
 
@@ -2337,8 +2337,8 @@ do -- Patrol methods
   -- @param #table ZoneList Table of zones.
   -- @param #number Speed Speed in km/h the group moves at.
   -- @param #string Formation (Optional) Formation the group should use.
-  -- @param #number DelayMin Delay in seconds before the group progresses to the next route point. Default 1 sec.
-  -- @param #number DelayMax Max. delay in seconds. Actual delay is randomly chosen between DelayMin and DelayMax. Default equal to DelayMin.
+  -- @param #number DelayMin (Optional) Delay in seconds before the group progresses to the next route point. Default 1 sec.
+  -- @param #number DelayMax (Optional) Max. delay in seconds. Actual delay is randomly chosen between DelayMin and DelayMax. Default equal to DelayMin.
   -- @return #CONTROLLABLE
   function CONTROLLABLE:PatrolZones( ZoneList, Speed, Formation, DelayMin, DelayMax )
 
@@ -2853,7 +2853,7 @@ do -- Route methods
   -- @param #CONTROLLABLE self
   -- @param Core.Zone#ZONE Zone The zone where to route to.
   -- @param #boolean Randomize Defines whether to target point gets randomized within the Zone.
-  -- @param #number Speed The speed in m/s. Default is 5.555 m/s = 20 km/h.
+  -- @param #number Speed (Optional) The speed in m/s. Default is 5.555 m/s = 20 km/h.
   -- @param DCS#FORMATION Formation The formation string.
   function CONTROLLABLE:TaskRouteToZone( Zone, Randomize, Speed, Formation )
     self:F2( Zone )
@@ -2913,7 +2913,7 @@ do -- Route methods
   -- A given formation can be given.
   -- @param #CONTROLLABLE self
   -- @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 #number Speed (Optional) The speed in m/s. Default is 5.555 m/s = 20 km/h.
   -- @param DCS#FORMATION Formation The formation string.
   function CONTROLLABLE:TaskRouteToVec2( Vec2, Speed, Formation )
 
@@ -3845,7 +3845,7 @@ end
 
 --- Set RTB on bingo fuel.
 -- @param #CONTROLLABLE self
--- @param #boolean RTB true if RTB on bingo fuel (default), false if no RTB on bingo fuel.
+-- @param #boolean RTB (Optional) true if RTB on bingo fuel (default), false if no RTB on bingo fuel.
 -- Warning! When you switch this option off, the airborne group will continue to fly until all fuel has been consumed, and will crash.
 -- @return #CONTROLLABLE self
 function CONTROLLABLE:OptionRTBBingoFuel( RTB ) -- R2.2
@@ -3972,7 +3972,7 @@ end
 
 --- [Ground] Option that defines the vehicle spacing when in an on road and off road formation. 
 -- @param #CONTROLLABLE self
--- @param #number meters Can be zero to 100 meters. Defaults to 50 meters.
+-- @param #number meters (Optional) Can be zero to 100 meters. Defaults to 50 meters.
 -- @return #CONTROLLABLE self
 function CONTROLLABLE:OptionFormationInterval(meters)
   self:F2( { self.ControllableName } )
@@ -3993,7 +3993,7 @@ end
 
 --- [Air] Defines the usage of Electronic Counter Measures by airborne forces.
 -- @param #CONTROLLABLE self
--- @param #number ECMvalue Can be - 0=Never on, 1=if locked by radar, 2=if detected by radar, 3=always on, defaults to 1
+-- @param #number ECMvalue (Optional) Can be - 0=Never on, 1=if locked by radar, 2=if detected by radar, 3=always on, defaults to 1
 -- @return #CONTROLLABLE self
 function CONTROLLABLE:OptionECM( ECMvalue )
   self:F2( { self.ControllableName } )
@@ -4289,7 +4289,7 @@ end
 
 --- Defines the range at which a GROUND unit/group is allowed to use its weapons automatically.
 -- @param #CONTROLLABLE self
--- @param #number EngageRange Engage range limit in percent (a number between 0 and 100). Default 100.
+-- @param #number EngageRange (Optional) Engage range limit in percent (a number between 0 and 100). Default 100.
 -- @return #CONTROLLABLE self
 function CONTROLLABLE:OptionEngageRange( EngageRange )
   self:F2( { self.ControllableName } )
@@ -4439,7 +4439,7 @@ end
 
 --- [AIR] Set the AI to report contact for certain types of objects.
 -- @param #CONTROLLABLE self
--- @param #table Objects Table of attribute names for which AI reports contact. Defaults to {"Air"}. See [Hoggit Wiki](https://wiki.hoggitworld.com/view/DCS_enum_attributes)
+-- @param #table Objects (Optional) Table of attribute names for which AI reports contact. Defaults to {"Air"}. See [Hoggit Wiki](https://wiki.hoggitworld.com/view/DCS_enum_attributes)
 -- @return #CONTROLLABLE self
 function CONTROLLABLE:SetOptionRadioContact(Objects)
  self:F2( { self.ControllableName } )
@@ -4453,7 +4453,7 @@ end
 
 --- [AIR] Set the AI to report engaging certain types of objects.
 -- @param #CONTROLLABLE self
--- @param #table Objects Table of attribute names for which AI reports contact. Defaults to {"Air"}, see [Hoggit Wiki](https://wiki.hoggitworld.com/view/DCS_enum_attributes)
+-- @param #table Objects (Optional) Table of attribute names for which AI reports contact. Defaults to {"Air"}, see [Hoggit Wiki](https://wiki.hoggitworld.com/view/DCS_enum_attributes)
 -- @return #CONTROLLABLE self
 function CONTROLLABLE:SetOptionRadioEngage(Objects)
  self:F2( { self.ControllableName } )
@@ -4467,7 +4467,7 @@ end
 
 --- [AIR] Set the AI to report killing certain types of objects.
 -- @param #CONTROLLABLE self
--- @param #table Objects Table of attribute names for which AI reports contact. Defaults to {"Air"}, see [Hoggit Wiki](https://wiki.hoggitworld.com/view/DCS_enum_attributes)
+-- @param #table Objects (Optional) Table of attribute names for which AI reports contact. Defaults to {"Air"}, see [Hoggit Wiki](https://wiki.hoggitworld.com/view/DCS_enum_attributes)
 -- @return #CONTROLLABLE self
 function CONTROLLABLE:SetOptionRadioKill(Objects)
  self:F2( { self.ControllableName } )
@@ -4481,12 +4481,12 @@ end
 
 --- (GROUND) Relocate controllable to a random point within a given radius; use e.g.for evasive actions; Note that not all ground controllables can actually drive, also the alarm state of the controllable might stop it from moving.
 -- @param #CONTROLLABLE self
--- @param #number speed Speed of the controllable, default 20
--- @param #number radius Radius of the relocation zone, default 500
--- @param #boolean onroad If true, route on road (less problems with AI way finding), default true
--- @param #boolean shortcut If true and onroad is set, take a shorter route - if available - off road, default false
--- @param #string formation Formation string as in the mission editor, e.g. "Vee", "Diamond", "Line abreast", etc. Defaults to "Off Road"
--- @param #boolean onland (optional) If true, try up to 50 times to get a coordinate on land.SurfaceType.LAND. Note - this descriptor value is not reliably implemented on all maps.
+-- @param #number speed (Optional) Speed of the controllable, default 20
+-- @param #number radius (Optional) Radius of the relocation zone, default 500
+-- @param #boolean onroad (Optional) If true, route on road (less problems with AI way finding), default true
+-- @param #boolean shortcut (Optional) If true and onroad is set, take a shorter route - if available - off road, default false
+-- @param #string formation (Optional) Formation string as in the mission editor, e.g. "Vee", "Diamond", "Line abreast", etc. Defaults to "Off Road"
+-- @param #boolean onland (Optional) If true, try up to 50 times to get a coordinate on land.SurfaceType.LAND. Note - this descriptor value is not reliably implemented on all maps.
 -- @return #CONTROLLABLE self
 function CONTROLLABLE:RelocateGroundRandomInRadius( speed, radius, onroad, shortcut, formation, onland )
   self:F2( { self.ControllableName } )
@@ -5869,8 +5869,8 @@ end
 
 --- [GROUND] Create and enable a new IR Marker for the given controllable UNIT or GROUP.
 -- @param #CONTROLLABLE self
--- @param #boolean EnableImmediately (Optionally) If true start up the IR Marker immediately. Else you need to call `myobject:EnableIRMarker()` later on.
--- @param #number Runtime (Optionally) Run this IR Marker for the given number of seconds, then stop. Use in conjunction with EnableImmediately. Defaults to 60 seconds.
+-- @param #boolean EnableImmediately (Optional) If true start up the IR Marker immediately. Else you need to call `myobject:EnableIRMarker()` later on.
+-- @param #number Runtime (Optional) Run this IR Marker for the given number of seconds, then stop. Use in conjunction with EnableImmediately. Defaults to 60 seconds.
 -- @return #CONTROLLABLE self
 function CONTROLLABLE:NewIRMarker(EnableImmediately, Runtime)
   self:T2("NewIRMarker")

Moose Development/Moose/Wrapper/DynamicCargo.lua

@@ -547,7 +547,7 @@ end
 
 --- [USER] Destroy a DYNAMICCARGO object.
 -- @param #DYNAMICCARGO self
--- @param #boolean GenerateEvent Set to false to remove an item silently. Defaults to true.
+-- @param #boolean GenerateEvent (Optional) Set to false to remove an item silently. Defaults to true.
 -- @return #boolean Return Returns nil if the object could not be found, else returns true.
 function DYNAMICCARGO:Destroy(GenerateEvent)
   local DCSObject = self:GetDCSObject()

Moose Development/Moose/Wrapper/Group.lua

@@ -604,7 +604,7 @@ end
 -- See [hoggit documentation](https://wiki.hoggitworld.com/view/DCS_func_hasAttribute).
 -- @param #GROUP self
 -- @param #string attribute The name of the attribute the group is supposed to have. Valid attributes can be found in the "db_attributes.lua" file which is located at in "C:\Program Files\Eagle Dynamics\DCS World\Scripts\Database".
--- @param #boolean all If true, all units of the group must have the attribute in order to return true. Default is only one unit of a heterogenious group needs to have the attribute.
+-- @param #boolean all (Optional) If true, all units of the group must have the attribute in order to return true. Default is only one unit of a heterogenious group needs to have the attribute.
 -- @return #boolean Group has this attribute.
 function GROUP:HasAttribute(attribute, all)
 

Moose Development/Moose/Wrapper/Marker.lua

@@ -586,7 +586,7 @@ end
 
 --- Set text that is displayed in the marker panel. Note this does not show the marker.
 -- @param #MARKER self
--- @param #string Text Marker text. Default is an empty string "".
+-- @param #string (Optional) Text Marker text. Default is an empty string "".
 -- @return #MARKER self
 function MARKER:SetText( Text )
   self.text = Text and tostring( Text ) or ""

Moose Development/Moose/Wrapper/Net.lua

@@ -449,7 +449,7 @@ end
 
 --- Set block time in seconds.
 -- @param #NET self
--- @param #number Seconds Numnber of seconds this block will last. Defaults to 600.
+-- @param #number Seconds (Optional) Numnber of seconds this block will last. Defaults to 600.
 -- @return #NET self
 function NET:SetBlockTime(Seconds)
   self.BlockTime = Seconds or 600

Moose Development/Moose/Wrapper/Positionable.lua

@@ -449,7 +449,7 @@ end
 
 --- Triggers an explosion at the coordinates of the positionable.
 -- @param #POSITIONABLE self
--- @param #number power Power of the explosion in kg TNT. Default 100 kg TNT.
+-- @param #number power (Optional) Power of the explosion in kg TNT. Default 100 kg TNT.
 -- @param #number delay (Optional) Delay of explosion in seconds.
 -- @return #POSITIONABLE self
 function POSITIONABLE:Explode(power, delay)
@@ -477,9 +477,9 @@ end
 
 --- Returns a COORDINATE object, which is offset with respect to the orientation of the POSITIONABLE.
 -- @param #POSITIONABLE self
--- @param #number x Offset in the direction "the nose" of the unit is pointing in meters. Default 0 m.
--- @param #number y Offset "above" the unit in meters. Default 0 m.
--- @param #number z Offset in the direction "the wing" of the unit is pointing in meters. z>0 starboard, z<0 port. Default 0 m.
+-- @param #number x (Optional) Offset in the direction "the nose" of the unit is pointing in meters. Default 0 m.
+-- @param #number y (Optional) Offset "above" the unit in meters. Default 0 m.
+-- @param #number z(Optional)  Offset in the direction "the wing" of the unit is pointing in meters. z>0 starboard, z<0 port. Default 0 m.
 -- @return Core.Point#COORDINATE The COORDINATE of the offset with respect to the orientation of the  POSITIONABLE.
 function POSITIONABLE:GetOffsetCoordinate( x, y, z )
 
@@ -518,9 +518,9 @@ end
 
 --- Returns a COORDINATE object, which is transformed to be relative to the POSITIONABLE. Inverse of @{#POSITIONABLE.GetOffsetCoordinate}.
 -- @param #POSITIONABLE self
--- @param #number x Offset along the world x-axis in meters. Default 0 m.
--- @param #number y Offset along the world y-axis in meters. Default 0 m.
--- @param #number z Offset along the world z-axis in meters. Default 0 m.
+-- @param #number x (Optional) Offset along the world x-axis in meters. Default 0 m.
+-- @param #number y (Optional) Offset along the world y-axis in meters. Default 0 m.
+-- @param #number z (Optional) Offset along the world z-axis in meters. Default 0 m.
 -- @return Core.Point#COORDINATE The relative COORDINATE with respect to the orientation of the  POSITIONABLE.
 function POSITIONABLE:GetRelativeCoordinate( x, y, z )
 

Moose Development/Moose/Wrapper/Static.lua

@@ -246,7 +246,7 @@ end
 --- Spawn the @{Wrapper.Static} at a specific coordinate and heading.
 -- @param #STATIC self
 -- @param Core.Point#COORDINATE Coordinate The coordinate where to spawn the new Static.
--- @param #number Heading The heading of the static respawn in degrees. Default is 0 deg.
+-- @param #number Heading (Optional) The heading of the static respawn in degrees. Default is 0 deg.
 -- @param #number Delay Delay in seconds before the static is spawned.
 function STATIC:SpawnAt(Coordinate, Heading, Delay)
 

Moose Development/Moose/Wrapper/Storage.lua

@@ -292,7 +292,7 @@ end
 
 --- Set verbosity level.
 -- @param #STORAGE self
--- @param #number VerbosityLevel Level of output (higher=more). Default 0.
+-- @param #number VerbosityLevel (Optional) Level of output (higher=more). Default 0.
 -- @return #STORAGE self
 function STORAGE:SetVerbosity(VerbosityLevel)
   self.verbose=VerbosityLevel or 0
@@ -816,7 +816,7 @@ end
 -- @param #STORAGE self
 -- @param #string Path The path to use. Use double backslashes \\\\ on Windows filesystems.
 -- @param #string Filename The name of the file.
--- @param #number Interval The interval, start after this many seconds and repeat every interval seconds. Defaults to 300.
+-- @param #number Interval (Optional) The interval, start after this many seconds and repeat every interval seconds. Defaults to 300.
 -- @param #boolean LoadOnce If LoadOnce is true or nil, we try to load saved storage first.
 -- @return #STORAGE self
 function STORAGE:StartAutoSave(Path,Filename,Interval,LoadOnce)

Moose Development/Moose/Wrapper/Unit.lua

@@ -1445,7 +1445,7 @@ end
 
 --- Triggers an explosion at the coordinates of the unit.
 -- @param #UNIT self
--- @param #number power Power of the explosion in kg TNT. Default 100 kg TNT.
+-- @param #number power (Optional) Power of the explosion in kg TNT. Default 100 kg TNT.
 -- @param #number delay (Optional) Delay of explosion in seconds.
 -- @return #UNIT self
 function UNIT:Explode(power, delay)

Moose Development/Moose/Wrapper/Weapon.lua

@@ -259,7 +259,7 @@ end
 
 --- Set verbosity level.
 -- @param #WEAPON self
--- @param #number VerbosityLevel Level of output (higher=more). Default 0.
+-- @param #number VerbosityLevel (Optional) Level of output (higher=more). Default 0.
 -- @return #WEAPON self
 function WEAPON:SetVerbosity(VerbosityLevel)
   self.verbose=VerbosityLevel or 0
@@ -268,7 +268,7 @@ end
 
 --- Set track position time step.
 -- @param #WEAPON self
--- @param #number TimeStep Time step in seconds when the position is updated. Default 0.01 sec ==> 100 evaluations per second.
+-- @param #number TimeStep (Optional) Time step in seconds when the position is updated. Default 0.01 sec ==> 100 evaluations per second.
 -- @return #WEAPON self
 function WEAPON:SetTimeStepTrack(TimeStep)
   self.dtTrack=TimeStep or 0.01
@@ -281,7 +281,7 @@ end
 -- a good result on the impact point.
 -- It uses the DCS function [getIP](https://wiki.hoggitworld.com/view/DCS_func_getIP).
 -- @param #WEAPON self
--- @param #number Distance Distance in meters. Default is 50 m. Set to 0 to deactivate.
+-- @param #number Distance (Optional) Distance in meters. Default is 50 m. Set to 0 to deactivate.
 -- @return #WEAPON self
 function WEAPON:SetDistanceInterceptPoint(Distance)
   self.distIP=Distance or 50
@@ -307,7 +307,7 @@ end
 --- Put smoke on impact point. This requires that the tracking has been started.
 -- @param #WEAPON self
 -- @param #boolean Switch If `true` or nil, impact is smoked.
--- @param #number SmokeColor Color of smoke. Default is `SMOKECOLOR.Red`.
+-- @param #number SmokeColor (Optional) Color of smoke. Default is `SMOKECOLOR.Red`.
 -- @return #WEAPON self
 function WEAPON:SetSmokeImpact(Switch, SmokeColor)
 
@@ -718,7 +718,7 @@ end
 -- the (approximate) impact point. Of course, the smaller the time step, the better the position can be determined. However, this can hit the performance as many
 -- calculations per second need to be carried out.
 -- @param #WEAPON self
--- @param #number Delay Delay in seconds before the tracking starts. Default 0.001 sec.
+-- @param #number Delay (Optional) Delay in seconds before the tracking starts. Default 0.001 sec.
 -- @return #WEAPON self
 function WEAPON:StartTrack(Delay)
 
@@ -904,7 +904,7 @@ end
 
 --- Compute estimated intercept/impact point (IP) based on last known position and direction.
 -- @param #WEAPON self
--- @param #number Distance Distance in meters. Default 50 m.
+-- @param #number Distance (Optional) Distance in meters. Default 50 m.
 -- @return DCS#Vec3 Estimated intercept/impact point. Can also return `nil`, if no IP can be determined.
 function WEAPON:_GetIP(Distance)