From 047033a6efe2dabcbaedd204235e342b2cf5e636 Mon Sep 17 00:00:00 2001
From: Starbeamrainbowlabs <sbrl@starbeamrainbowlabs.com>
Date: Sun, 2 Jul 2023 19:03:46 +0100
Subject: [PATCH] comments: update @class definitions

---
 worldeditadditions/lib/noise/engines/perlin.lua      | 2 +-
 worldeditadditions_core/utils/lru.lua                | 2 +-
 worldeditadditions_core/utils/mesh.lua               | 4 ++--
 worldeditadditions_core/utils/parse/key_instance.lua | 3 ++-
 worldeditadditions_core/utils/queue.lua              | 3 +--
 worldeditadditions_core/utils/setting_handler.lua    | 4 ++--
 worldeditadditions_core/utils/vector3.lua            | 2 +-
 7 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/worldeditadditions/lib/noise/engines/perlin.lua b/worldeditadditions/lib/noise/engines/perlin.lua
index a46717a..d81bd6b 100644
--- a/worldeditadditions/lib/noise/engines/perlin.lua
+++ b/worldeditadditions/lib/noise/engines/perlin.lua
@@ -5,7 +5,7 @@ local Vector3 = wea_c.Vector3
 --- Perlin noise generation engine.
 -- Original code by Ken Perlin: http://mrl.nyu.edu/~perlin/noise/
 -- Port from this StackOverflow answer: https://stackoverflow.com/a/33425812/1460422
--- @class
+-- @class	worldeditadditions.noise.engines.Perlin
 local Perlin = {}
 Perlin.__index = Perlin
 
diff --git a/worldeditadditions_core/utils/lru.lua b/worldeditadditions_core/utils/lru.lua
index 139ea6f..e2fb0e2 100644
--- a/worldeditadditions_core/utils/lru.lua
+++ b/worldeditadditions_core/utils/lru.lua
@@ -6,7 +6,7 @@ else
 end
 
 --- A least-recently-used cache implementation.
--- @class
+-- @class	worldeditadditions_core.LRU
 local LRU = {}
 LRU.__index = LRU
 
diff --git a/worldeditadditions_core/utils/mesh.lua b/worldeditadditions_core/utils/mesh.lua
index 28271fd..9815bab 100644
--- a/worldeditadditions_core/utils/mesh.lua
+++ b/worldeditadditions_core/utils/mesh.lua
@@ -8,7 +8,7 @@ local wea_c = worldeditadditions_core
 -- ██      ██   ██  ██████ ███████
 
 --- A single face of a Mesh.
--- @class
+-- @class	worldeditadditions_core.Face
 local Face = {}
 Face.__index = Face
 
@@ -42,7 +42,7 @@ function Face.__eq(a, b) return Face.equal(a, b) end
 -- ██      ██ ███████ ███████ ██   ██
 
 --- A mesh of faces.
--- @class
+-- @class	worldeditadditions_core.Mesh
 local Mesh = {}
 Mesh.__index = Mesh
 
diff --git a/worldeditadditions_core/utils/parse/key_instance.lua b/worldeditadditions_core/utils/parse/key_instance.lua
index 1cec51d..727fa43 100644
--- a/worldeditadditions_core/utils/parse/key_instance.lua
+++ b/worldeditadditions_core/utils/parse/key_instance.lua
@@ -1,6 +1,7 @@
 --- A container for transmitting (axis table, sign) or (dir, sign) pairs
 -- and other data within parsing functions.
--- @class
+-- @internal
+-- @class worldeditadditions_core.parse.key_instance
 local key_instance = {}
 key_instance.__index = key_instance
 key_instance.__name = "Key Instance"
diff --git a/worldeditadditions_core/utils/queue.lua b/worldeditadditions_core/utils/queue.lua
index 197ff2e..9bda947 100644
--- a/worldeditadditions_core/utils/queue.lua
+++ b/worldeditadditions_core/utils/queue.lua
@@ -1,8 +1,7 @@
 -------------------------------------------------------------------------------
 --- A Queue implementation
 -- Taken & adapted from https://www.lua.org/pil/11.4.html
--- @submodule worldeditadditions.utils.queue
--- @class
+-- @class	worldeditadditions_core.Queue
 local Queue = {}
 Queue.__index = Queue
 
diff --git a/worldeditadditions_core/utils/setting_handler.lua b/worldeditadditions_core/utils/setting_handler.lua
index 5265c97..c9019b7 100644
--- a/worldeditadditions_core/utils/setting_handler.lua
+++ b/worldeditadditions_core/utils/setting_handler.lua
@@ -1,4 +1,3 @@
---- A wrapper to simultaniously handle global and world settings.
 
 -- Initialize settings container
 local wea_c = worldeditadditions_core
@@ -8,7 +7,8 @@ wea_c.settings = {}
 local path = minetest.get_worldpath() .. "/worldeditadditions"
 minetest.mkdir(path)
 
--- @class
+--- A wrapper to simultaniously handle global and world settings.
+-- @namespace worldeditadditions_core.setting_handler
 local setting_handler = {}
 
 --- Reads world settings into WEA core settings object
diff --git a/worldeditadditions_core/utils/vector3.lua b/worldeditadditions_core/utils/vector3.lua
index 6f69ce7..a18500b 100644
--- a/worldeditadditions_core/utils/vector3.lua
+++ b/worldeditadditions_core/utils/vector3.lua
@@ -1,5 +1,5 @@
 --- A 3-dimensional vector.
--- @class
+-- @class	worldeditadditions_core.Vector3
 local Vector3 = {}
 Vector3.__index = Vector3
 Vector3.__name = "Vector3" -- A hack to allow identification in wea.inspect