comments: update @class definitions

This commit is contained in:
Starbeamrainbowlabs 2023-07-02 19:03:46 +01:00
parent c6bc6e26e7
commit 047033a6ef
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
7 changed files with 10 additions and 10 deletions

View file

@ -5,7 +5,7 @@ local Vector3 = wea_c.Vector3
--- Perlin noise generation engine. --- Perlin noise generation engine.
-- Original code by Ken Perlin: http://mrl.nyu.edu/~perlin/noise/ -- Original code by Ken Perlin: http://mrl.nyu.edu/~perlin/noise/
-- Port from this StackOverflow answer: https://stackoverflow.com/a/33425812/1460422 -- Port from this StackOverflow answer: https://stackoverflow.com/a/33425812/1460422
-- @class -- @class worldeditadditions.noise.engines.Perlin
local Perlin = {} local Perlin = {}
Perlin.__index = Perlin Perlin.__index = Perlin

View file

@ -6,7 +6,7 @@ else
end end
--- A least-recently-used cache implementation. --- A least-recently-used cache implementation.
-- @class -- @class worldeditadditions_core.LRU
local LRU = {} local LRU = {}
LRU.__index = LRU LRU.__index = LRU

View file

@ -8,7 +8,7 @@ local wea_c = worldeditadditions_core
-- ██ ██ ██ ██████ ███████ -- ██ ██ ██ ██████ ███████
--- A single face of a Mesh. --- A single face of a Mesh.
-- @class -- @class worldeditadditions_core.Face
local Face = {} local Face = {}
Face.__index = Face Face.__index = Face
@ -42,7 +42,7 @@ function Face.__eq(a, b) return Face.equal(a, b) end
-- ██ ██ ███████ ███████ ██ ██ -- ██ ██ ███████ ███████ ██ ██
--- A mesh of faces. --- A mesh of faces.
-- @class -- @class worldeditadditions_core.Mesh
local Mesh = {} local Mesh = {}
Mesh.__index = Mesh Mesh.__index = Mesh

View file

@ -1,6 +1,7 @@
--- A container for transmitting (axis table, sign) or (dir, sign) pairs --- A container for transmitting (axis table, sign) or (dir, sign) pairs
-- and other data within parsing functions. -- and other data within parsing functions.
-- @class -- @internal
-- @class worldeditadditions_core.parse.key_instance
local key_instance = {} local key_instance = {}
key_instance.__index = key_instance key_instance.__index = key_instance
key_instance.__name = "Key Instance" key_instance.__name = "Key Instance"

View file

@ -1,8 +1,7 @@
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
--- A Queue implementation --- A Queue implementation
-- Taken & adapted from https://www.lua.org/pil/11.4.html -- Taken & adapted from https://www.lua.org/pil/11.4.html
-- @submodule worldeditadditions.utils.queue -- @class worldeditadditions_core.Queue
-- @class
local Queue = {} local Queue = {}
Queue.__index = Queue Queue.__index = Queue

View file

@ -1,4 +1,3 @@
--- A wrapper to simultaniously handle global and world settings.
-- Initialize settings container -- Initialize settings container
local wea_c = worldeditadditions_core local wea_c = worldeditadditions_core
@ -8,7 +7,8 @@ wea_c.settings = {}
local path = minetest.get_worldpath() .. "/worldeditadditions" local path = minetest.get_worldpath() .. "/worldeditadditions"
minetest.mkdir(path) minetest.mkdir(path)
-- @class --- A wrapper to simultaniously handle global and world settings.
-- @namespace worldeditadditions_core.setting_handler
local setting_handler = {} local setting_handler = {}
--- Reads world settings into WEA core settings object --- Reads world settings into WEA core settings object

View file

@ -1,5 +1,5 @@
--- A 3-dimensional vector. --- A 3-dimensional vector.
-- @class -- @class worldeditadditions_core.Vector3
local Vector3 = {} local Vector3 = {}
Vector3.__index = Vector3 Vector3.__index = Vector3
Vector3.__name = "Vector3" -- A hack to allow identification in wea.inspect Vector3.__name = "Vector3" -- A hack to allow identification in wea.inspect