From 414a1d2ca5495547a7a7de9bb1653fb26c2a725f Mon Sep 17 00:00:00 2001 From: Rolln-dev Date: Mon, 2 Mar 2026 08:12:03 -0700 Subject: [PATCH] UPDATE: NAVIGATION function params - Added (Optional) to param descriptions for params that have default values --- Moose Development/Moose/Navigation/Beacons.lua | 2 +- Moose Development/Moose/Navigation/Point.lua | 12 ++++++------ Moose Development/Moose/Navigation/Radios.lua | 2 +- Moose Development/Moose/Navigation/Towns.lua | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/Moose Development/Moose/Navigation/Beacons.lua b/Moose Development/Moose/Navigation/Beacons.lua index 84ecf218d..69b14f184 100644 --- a/Moose Development/Moose/Navigation/Beacons.lua +++ b/Moose Development/Moose/Navigation/Beacons.lua @@ -242,7 +242,7 @@ end --- Find closest beacons to a given coordinate. -- @param #BEACONS self -- @param Core.Point#COORDINATE Coordinate The reference coordinate. --- @param #number Nmax Max number of beacons. Default 5. +-- @param #number Nmax (Optional) Max number of beacons. Default 5. -- @param #number TypeID (Optional) Only search for specific beacon types, *e.g.* `BEACON.Type.TACAN`. -- @param #number DistMax (Optional) Max search distance in meters. -- @return #table Table of #BEACONS.Beacon closest beacons. diff --git a/Moose Development/Moose/Navigation/Point.lua b/Moose Development/Moose/Navigation/Point.lua index e02fb9945..bc1f4148f 100644 --- a/Moose Development/Moose/Navigation/Point.lua +++ b/Moose Development/Moose/Navigation/Point.lua @@ -115,7 +115,7 @@ NAVFIX.version="0.1.0" --- Create a new NAVFIX class instance from a given VECTOR. -- @param #NAVFIX self -- @param #string Name Name/ident of the point. Should be unique! --- @param #string Type Type of the point. Default `NAVFIX.Type.POINT`. +-- @param #string Type (Optional) Type of the point. Default `NAVFIX.Type.POINT`. -- @param Core.Vector#VECTOR Vector Position vector of the navpoint. -- @return #NAVFIX self function NAVFIX:NewFromVector(Name, Type, Vector) @@ -150,7 +150,7 @@ end --- Create a new NAVFIX class instance from a given COORDINATE. -- @param #NAVFIX self -- @param #string Name Name of the fix. Should be unique! --- @param #string Type Type of the point. Default `NAVFIX.Type.POINT`. +-- @param #string Type (Optional) Type of the point. Default `NAVFIX.Type.POINT`. -- @param Core.Point#COORDINATE Coordinate Coordinate of the point. -- @return #NAVFIX self function NAVFIX:NewFromCoordinate(Name, Type, Coordinate) @@ -168,7 +168,7 @@ end --- Create a new NAVFIX instance from given latitude and longitude in degrees, minutes and seconds (DMS). -- @param #NAVFIX self -- @param #string Name Name of the fix. Should be unique! --- @param #string Type Type of the point. Default `NAVFIX.Type.POINT`. +-- @param #string Type (Optional) Type of the point. Default `NAVFIX.Type.POINT`. -- @param #string Latitude Latitude in DMS as string. -- @param #string Longitude Longitude in DMS as string. -- @return #NAVFIX self @@ -186,7 +186,7 @@ end --- Create a new NAVFIX instance from given latitude and longitude in decimal degrees (DD). -- @param #NAVFIX self -- @param #string Name Name of the fix. Should be unique! --- @param #string Type Type of the point. Default `NAVFIX.Type.POINT`. +-- @param #string Type (Optional) Type of the point. Default `NAVFIX.Type.POINT`. -- @param #number Latitude Latitude in DD. -- @param #number Longitude Longitude in DD. -- @return #NAVFIX self @@ -523,7 +523,7 @@ NAVAID.version="0.1.0" --- Create a new NAVAID class instance. -- @param #NAVAID self -- @param #string Name Name/ident of this navaid. --- @param #string Type Type of the point. Default `NAVFIX.Type.POINT`. +-- @param #string Type (Optional) Type of the point. Default `NAVFIX.Type.POINT`. -- @param #string ZoneName Name of the zone to scan the scenery. -- @param #string SceneryName Name of the scenery object. -- @return #NAVAID self @@ -579,7 +579,7 @@ end --- Set channel of, *e.g.*, TACAN beacons. -- @param #NAVAID self -- @param #number Channel The channel. --- @param #string Band The band either `"X"` (default) or `"Y"`. +-- @param #string Band (Optional) The band either `"X"` (default) or `"Y"`. -- @return #NAVAID self function NAVAID:SetChannel(Channel, Band) diff --git a/Moose Development/Moose/Navigation/Radios.lua b/Moose Development/Moose/Navigation/Radios.lua index fb78e56f4..fa85d5fc3 100644 --- a/Moose Development/Moose/Navigation/Radios.lua +++ b/Moose Development/Moose/Navigation/Radios.lua @@ -249,7 +249,7 @@ end --- Find closest radios to a given coordinate. -- @param #RADIOS self -- @param Core.Point#COORDINATE Coordinate The reference coordinate. --- @param #number Nmax Max number of radios. Default 5. +-- @param #number Nmax (Optional) Max number of radios. Default 5. -- @param #number DistMax (Optional) Max search distance in meters. -- @return #table Table of #RADIOS.Radio closest radios. function RADIOS:GetClosestRadios(Coordinate, Nmax, DistMax) diff --git a/Moose Development/Moose/Navigation/Towns.lua b/Moose Development/Moose/Navigation/Towns.lua index 3825854f9..064f27846 100644 --- a/Moose Development/Moose/Navigation/Towns.lua +++ b/Moose Development/Moose/Navigation/Towns.lua @@ -240,7 +240,7 @@ end --- Find closest towns to a given coordinate. -- @param #TOWNS self -- @param Core.Point#COORDINATE Coordinate The reference coordinate. --- @param #number Nmax Max number of towns. Default 5. +-- @param #number Nmax (Optional) Max number of towns. Default 5. -- @param #number DistMax (Optional) Max search distance in meters. -- @return #table Table of #TOWNS.Town closest towns. function TOWNS:GetClosestTowns(Coordinate, Nmax, DistMax)