initial documentation for better code completion

data/core/object.lua

@@ -1,11 +1,12 @@
+---@class core.object
+---@field super core.object
 local Object = {}
 Object.__index = Object
 
+---Can be overrided by child objects to implement a constructor.
+function Object:new() end
 
-function Object:new()
-end
-
-
+---@return core.object
 function Object:extend()
   local cls = {}
   for k, v in pairs(self) do
@@ -19,12 +20,16 @@ function Object:extend()
   return cls
 end
 
-
+---Check if the object is strictly of the given type.
+---@param T any
+---@return boolean
 function Object:is(T)
   return getmetatable(self) == T
 end
 
-
+---Check if the object inherits from the given type.
+---@param T any
+---@return boolean
 function Object:extends(T)
   local mt = getmetatable(self)
   while mt do
@@ -36,12 +41,14 @@ function Object:extends(T)
   return false
 end
 
-
+---Metamethod to get a string representation of an object.
+---@return string
 function Object:__tostring()
   return "Object"
 end
 
-
+---Methamethod to allow using the object call as a constructor.
+---@return core.object
 function Object:__call(...)
   local obj = setmetatable({}, self)
   obj:new(...)