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

@@ -46,7 +46,7 @@
--
-- ### Author: **funkyfranky**
--
-- @module Ops.Atis
-- @module Ops.ATIS
-- @image OPS_ATIS.png
--- ATIS class.
@@ -1047,7 +1047,7 @@ end
-- Or you make your life simple and just include the sign so you don't have to bother about East/West.
--
-- @param #ATIS self
-- @param #number magvar Magnetic variation in degrees. Positive for easterly and negative for westerly variation. Default is magnatic declinaton of the used map, c.f. @{Utilities.UTils#UTILS.GetMagneticDeclination}.
-- @param #number magvar Magnetic variation in degrees. Positive for easterly and negative for westerly variation. Default is magnatic declinaton of the used map, c.f. @{Utilities.Utils#UTILS.GetMagneticDeclination}.
-- @return #ATIS self
function ATIS:SetMagneticDeclination( magvar )
self.magvar = magvar or UTILS.GetMagneticDeclination()