Add @meta for all files. Mark couple params as optional.

This commit is contained in:
Alexander Chibrikin
2026-01-26 16:46:40 +03:00
parent a8a2da4059
commit 966a08b597
47 changed files with 90 additions and 23 deletions

View File

@@ -1,3 +1,6 @@
--- @meta
--- @class ABMDefinition
local ABMDefinition = {
--- Descriptive label for profiling purposes (optional).

View File

@@ -1,4 +1,4 @@
--- @diagnostic disable: missing-return
--- @meta
---@class AuthenticationHandlerGetAuth

View File

@@ -1,3 +1,6 @@
--- @meta
--- @class BiomeDefinition
--- Definition of a biome for use with `core.register_biome`.
local BiomeDefinition = {

View File

@@ -1,4 +1,4 @@
--- @diagnostic disable: missing-return
--- @meta
--- Used by `core.register_chatcommand`.

View File

@@ -1,3 +1,6 @@
--- @meta
--- @class DetachedInventoryCallbacksDef
local DetachedInventoryCallbacksDef = {
--- Called when a player wants to move items inside the inventory.

View File

@@ -1,4 +1,4 @@
--- @diagnostic disable: missing-return
--- @meta
--- Used by `core.register_entity`.

View File

@@ -1,3 +1,6 @@
--- @meta
--- Used by `HTTPApiTable.fetch` and `HTTPApiTable.fetch_async`.
---@class HTTPRequest: table
local HTTPRequest = {

View File

@@ -1,3 +1,6 @@
--- @meta
--- Passed to `HTTPApiTable.fetch` callback. Returned by `HTTPApiTable.fetch_async_get`.
---@class HTTPRequestResult: table
local HTTPRequestResult = {

View File

@@ -1,3 +1,6 @@
--- @meta
--- @class HudDefinition
local HudDefinition = {
--- Name of the HUD element.

View File

@@ -1,3 +1,6 @@
--- @meta
--- @class ItemDefinition: table
local ItemDefinition = {
--- Can contain new lines. "\n" has to be used as new line character.

View File

@@ -1,3 +1,4 @@
--- @meta
--- @class LBMDefinition

View File

@@ -1,3 +1,5 @@
--- @meta
--- @class LSystemTreeDefinition
--- @field axiom string initial tree axiom

View File

@@ -1,3 +1,6 @@
--- @meta
--- @class NodeDefinition: ItemDefinition
local NodeDefinition = {

View File

@@ -1,3 +1,6 @@
--- @meta
--- For 2D or 3D value noise or value noise maps:
---
--- ```lua

View File

@@ -1,3 +1,6 @@
--- @meta
--- @class ObjectProperties
local ObjectProperties = {
--- Defines the maximum and default HP of the entity

View File

@@ -1,3 +1,5 @@
--- @meta
--- @class OreDefinition
--- Defines an ore to be registered with `core.register_ore`.

View File

@@ -1,4 +1,5 @@
--- @diagnostic disable: missing-return
--- @meta
--- Used by `core.register_privilege`.
--- @class PrivilegeDefinition

View File

@@ -1,3 +1,6 @@
--- @meta
--- @class TileAnimationDefinition: table
local TileAnimationDefinition = {
--- @type string one of {"vertical_frames"|"sheet_2d"}

View File

@@ -1,3 +1,6 @@
--- @meta
--- @class TileDefinition
local TileDefinition = {
--- @type string