More Wiki stuff

LiliaFramework · Oct 28, 2024 · c537dd8 · c537dd8
1 parent 6457310
commit c537dd8
Show file tree

Hide file tree

Showing 5 changed files with 0 additions and 64 deletions.
diff --git a/lilia/gamemode/core/meta/entity.lua b/lilia/gamemode/core/meta/entity.lua
@@ -239,7 +239,6 @@ if SERVER then
     -- @string key Identifier of the networked variable
     -- @tparam any value New value to assign to the networked variable
     -- @client receiver The players to send the networked variable to
-    -- @treturn void
     -- @usage
     -- entity:setNetVar("example", "Hello World!", player)
     -- @see getNetVar

diff --git a/lilia/gamemode/core/meta/inventory.lua b/lilia/gamemode/core/meta/inventory.lua
@@ -66,7 +66,6 @@ end
 -- @realm shared
 -- @tparam any key The key for the data proxy.
 -- @func onChange The function to call when the data associated with the key changes.
--- @treturn void
 -- @usage
 -- inventory:addDataProxy("health", function(old, new)
 --     print("Health changed from", old, "to", new)
@@ -156,7 +155,6 @@ end
 -- @tparam any key The key whose data has changed.
 -- @tparam any oldValue The old value of the data.
 -- @tparam any newValue The new value of the data.
--- @treturn void
 -- @usage
 -- function Inventory:onDataChanged(key, oldValue, newValue)
 --     print(key, "changed from", oldValue, "to", newValue)
@@ -310,7 +308,6 @@ if SERVER then
     --- Synchronizes the addition of an item with clients.
     -- @realm server
     -- @item item The item being added.
-    -- @treturn void
     -- @usage
     -- inventory:syncItemAdded(weapon)
     function Inventory:syncItemAdded(item)
@@ -518,15 +515,13 @@ if SERVER then
 
     --- Initializes an instance of the inventory.
     -- @realm server
-    -- @treturn void
     -- @usage
     -- inventory:onInstanced()
     function Inventory:onInstanced()
     end
 
     --- Callback function called when the inventory is loaded.
     -- @realm server
-    -- @treturn void
     -- @usage
     -- function Inventory:onLoaded()
     --     print("Inventory loaded.")
@@ -574,7 +569,6 @@ if SERVER then
 
     --- Callback function called when items are loaded into the inventory.
     -- @realm server
-    -- @treturn void
     -- @usage
     -- function Inventory:onItemsLoaded(items)
     --     print("Loaded", #items, "items into the inventory.")
@@ -596,7 +590,6 @@ if SERVER then
     -- @realm server
     -- @tparam any key The key whose data has changed.
     -- @tab recipients The recipients to synchronize with.
-    -- @treturn void
     -- @usage
     -- inventory:syncData("health", {client = player})
     function Inventory:syncData(key, recipients)
@@ -611,7 +604,6 @@ if SERVER then
     --- Synchronizes the inventory with clients.
     -- @realm server
     -- @tab recipients The recipients to synchronize with.
-    -- @treturn void
     -- @usage
     -- inventory:sync()
     function Inventory:sync(recipients)
@@ -644,7 +636,6 @@ if SERVER then
 
     --- Deletes the inventory.
     -- @realm server
-    -- @treturn void
     -- @usage
     -- inventory:delete()
     function Inventory:delete()
@@ -653,7 +644,6 @@ if SERVER then
 
     --- Destroys the inventory and its associated items.
     -- @realm server
-    -- @treturn void
     -- @usage
     -- inventory:destroy()
     function Inventory:destroy()

diff --git a/lilia/gamemode/core/meta/item.lua b/lilia/gamemode/core/meta/item.lua
@@ -168,7 +168,6 @@ end
 -- @realm shared
 -- @string name The name of the hook.
 -- @func func The function to call once the event occurs.
--- @treturn void
 -- @usage
 -- item:hook("onUse", function(item)
 --     print("Item was used.")
@@ -181,7 +180,6 @@ end
 -- @realm shared
 -- @string name The name of the hook.
 -- @func func The function to call after the original hook was called.
--- @treturn void
 -- @usage
 -- item:postHook("onUse", function(item, result)
 --     print("Item use post-processing.")
@@ -192,7 +190,6 @@ end
 
 --- Gets called when the item is registered.
 -- @realm shared
--- @treturn void
 -- @usage
 -- function ITEM:onRegistered()
 --     print("Item has been registered.")
@@ -203,7 +200,6 @@ end
 --- A utility function which prints the item's details.
 -- @realm shared
 -- @bool detail Whether additional detail should be printed or not (Owner, X position, Y position).
--- @treturn void
 -- @usage
 -- item:print()
 -- item:print(true)
@@ -217,7 +213,6 @@ end
 
 --- A utility function printing the item's stored data.
 -- @realm shared
--- @treturn void
 -- @usage
 -- item:printData()
 function ITEM:printData()
@@ -301,7 +296,6 @@ if SERVER then
 
     --- Destroys the item instance, removing it from the game world and notifying all clients.
     -- @realm server
-    -- @treturn void
     -- @usage
     -- item:destroy()
     function ITEM:destroy()
@@ -314,7 +308,6 @@ if SERVER then
 
     --- Gets called upon destroying an item.
     -- @realm server
-    -- @treturn void
     -- @usage
     -- function ITEM:onDisposed()
     --     print("Item has been disposed.")
@@ -394,7 +387,6 @@ if SERVER then
 
     --- Gets called upon creating (instancing) an item.
     -- @realm server
-    -- @treturn void
     -- @usage
     -- function ITEM:onInstanced()
     --     print("Item has been instanced.")
@@ -404,7 +396,6 @@ if SERVER then
 
     --- Gets called upon syncing an item.
     -- @realm server
-    -- @treturn void
     -- @usage
     -- function ITEM:onSync(recipient)
     --     print("Item has been synced with recipient:", recipient:Nick())
@@ -414,7 +405,6 @@ if SERVER then
 
     --- Gets called upon removing an item.
     -- @realm server
-    -- @treturn void
     -- @usage
     -- function ITEM:onRemoved()
     --     print("Item has been removed.")
@@ -424,7 +414,6 @@ if SERVER then
 
     --- Gets called upon restoring an item.
     -- @realm server
-    -- @treturn void
     -- @usage
     -- function ITEM:onRestored()
     --     print("Item has been restored.")
@@ -435,7 +424,6 @@ if SERVER then
     --- Synchronizes the item data with the specified recipient or broadcasts it to all clients if no recipient is specified.
     -- @realm server
     -- @client[opt] recipient The player to whom the item data should be synchronized. If set to nil, the data is broadcasted to all clients.
-    -- @treturn void
     -- @usage
     -- item:sync(player)
     -- item:sync()
@@ -460,7 +448,6 @@ if SERVER then
     -- @string key The key to store the value within.
     -- @tparam any[opt=nil] value The value to set for the key.
     -- @tab[opt=nil] receivers The players to replicate the data on.
-    -- @treturn void
     -- @usage
     -- item:setData("health", 100, {player1, player2}, false, false)
     function ITEM:setData(key, value, receivers)
@@ -493,7 +480,6 @@ if SERVER then
     -- @int quantity The quantity to add.
     -- @tab receivers Players who should receive updates about the quantity change.
     -- @bool noCheckEntity If true, entity checks will be skipped.
-    -- @treturn void
     -- @usage
     -- item:addQuantity(5, {player1, player2}, false)
     function ITEM:addQuantity(quantity, receivers, noCheckEntity)
@@ -505,7 +491,6 @@ if SERVER then
     -- @int quantity The new quantity value.
     -- @tab receivers Players who should receive updates about the quantity change.
     -- @bool noCheckEntity If true, entity checks will be skipped.
-    -- @treturn void
     -- @usage
     -- item:setQuantity(10, {player1}, true)
     function ITEM:setQuantity(quantity, receivers, noCheckEntity)