From a7b3a34998c1ec97bbd3599110afa4adb08b65b0 Mon Sep 17 00:00:00 2001 From: MrNewb <47620135+MrNewb@users.noreply.github.com> Date: Sun, 12 Oct 2025 21:54:52 -0400 Subject: [PATCH] Add LuaDoc @description to fuel API functions Replaced comment blocks with LuaDoc @description tags for GetResourceName, GetFuel, and SetFuel functions across all fuel module client files. This improves code documentation consistency and supports better tooling integration. --- modules/fuel/_default/client.lua | 7 +++---- modules/fuel/bigDaddy-Fuel/client.lua | 7 +++---- modules/fuel/cdn-fuel/client.lua | 7 +++---- modules/fuel/esx-sna-fuel/client.lua | 7 +++---- modules/fuel/lc_fuel/client.lua | 7 +++---- modules/fuel/legacyfuel/client.lua | 7 +++---- modules/fuel/okokGasStation/client.lua | 7 +++---- modules/fuel/ox_fuel/client.lua | 7 +++---- modules/fuel/ps-fuel/client.lua | 7 +++---- modules/fuel/qb-fuel/client.lua | 7 +++---- modules/fuel/qs-fuelstations/client.lua | 7 +++---- modules/fuel/renewed-Fuel/client.lua | 7 +++---- modules/fuel/ti_fuel/client.lua | 7 +++---- modules/fuel/x-fuel/client.lua | 7 +++---- 14 files changed, 42 insertions(+), 56 deletions(-) diff --git a/modules/fuel/_default/client.lua b/modules/fuel/_default/client.lua index 53748be..28c6ae5 100644 --- a/modules/fuel/_default/client.lua +++ b/modules/fuel/_default/client.lua @@ -2,14 +2,13 @@ Fuel = Fuel or {} ----Returns the name of the active fuel resource. ----If no supported resource is found, "default" will be returned. +---@description Returns the name of the active fuel resource. ---@return string Fuel.GetResourceName = function() return 'default' end ----Returns the current fuel level of a vehicle. +---@description Returns the current fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@return number The vehicle fuel level. Fuel.GetFuel = function(vehicle) @@ -17,7 +16,7 @@ Fuel.GetFuel = function(vehicle) return GetVehicleFuelLevel(vehicle) end ----Sets the fuel level of a vehicle. +---@description Sets the fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@param fuel number The fuel level to assign. ---@param type? string The fuel type, used only in ti_fuel. (default: RON91) diff --git a/modules/fuel/bigDaddy-Fuel/client.lua b/modules/fuel/bigDaddy-Fuel/client.lua index 56b1721..c3569d2 100644 --- a/modules/fuel/bigDaddy-Fuel/client.lua +++ b/modules/fuel/bigDaddy-Fuel/client.lua @@ -3,14 +3,13 @@ local resourceName = "BigDaddy-Fuel" if GetResourceState(resourceName) == 'missing' then return end Fuel = Fuel or {} ----Returns the name of the active fuel resource. ----If no supported resource is found, "default" will be returned. +---@description Returns the name of the active fuel resource. ---@return string Fuel.GetResourceName = function() return resourceName end ----Returns the current fuel level of a vehicle. +---@description Returns the current fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@return number The vehicle fuel level. Fuel.GetFuel = function(vehicle) @@ -18,7 +17,7 @@ Fuel.GetFuel = function(vehicle) return exports['BigDaddy-Fuel']:GetFuel(vehicle) end ----Sets the fuel level of a vehicle. +---@description Sets the fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@param fuel number The fuel level to assign. ---@param type? string The fuel type, used only in ti_fuel. (default: RON91) diff --git a/modules/fuel/cdn-fuel/client.lua b/modules/fuel/cdn-fuel/client.lua index c4fd02f..f83bb4b 100644 --- a/modules/fuel/cdn-fuel/client.lua +++ b/modules/fuel/cdn-fuel/client.lua @@ -3,14 +3,13 @@ local resourceName = "cdn-fuel" if GetResourceState(resourceName) == 'missing' then return end Fuel = Fuel or {} ----Returns the name of the active fuel resource. ----If no supported resource is found, "default" will be returned. +---@description Returns the name of the active fuel resource. ---@return string Fuel.GetResourceName = function() return resourceName end ----Returns the current fuel level of a vehicle. +---@description Returns the current fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@return number The vehicle fuel level. Fuel.GetFuel = function(vehicle) @@ -18,7 +17,7 @@ Fuel.GetFuel = function(vehicle) return exports['cdn-fuel']:GetFuel(vehicle) end ----Sets the fuel level of a vehicle. +---@description Sets the fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@param fuel number The fuel level to assign. ---@param type? string The fuel type, used only in ti_fuel. (default: RON91) diff --git a/modules/fuel/esx-sna-fuel/client.lua b/modules/fuel/esx-sna-fuel/client.lua index 87eefe7..7ba9f75 100644 --- a/modules/fuel/esx-sna-fuel/client.lua +++ b/modules/fuel/esx-sna-fuel/client.lua @@ -3,14 +3,13 @@ local resourceName = "esx-sna-fuel" if GetResourceState(resourceName) == 'missing' then return end Fuel = Fuel or {} ----Returns the name of the active fuel resource. ----If no supported resource is found, "default" will be returned. +---@description Returns the name of the active fuel resource. ---@return string Fuel.GetResourceName = function() return resourceName end ----Returns the current fuel level of a vehicle. +---@description Returns the current fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@return number The vehicle fuel level. Fuel.GetFuel = function(vehicle) @@ -18,7 +17,7 @@ Fuel.GetFuel = function(vehicle) return exports['esx-sna-fuel']:GetFuel(vehicle) end ----Sets the fuel level of a vehicle. +---@description Sets the fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@param fuel number The fuel level to assign. ---@param type? string The fuel type, used only in ti_fuel. (default: RON91) diff --git a/modules/fuel/lc_fuel/client.lua b/modules/fuel/lc_fuel/client.lua index 7471143..aae2689 100644 --- a/modules/fuel/lc_fuel/client.lua +++ b/modules/fuel/lc_fuel/client.lua @@ -3,14 +3,13 @@ local resourceName = "lc_fuel" if GetResourceState(resourceName) == 'missing' then return end Fuel = Fuel or {} ----Returns the name of the active fuel resource. ----If no supported resource is found, "default" will be returned. +---@description Returns the name of the active fuel resource. ---@return string Fuel.GetResourceName = function() return resourceName end ----Returns the current fuel level of a vehicle. +---@description Returns the current fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@return number The vehicle fuel level. Fuel.GetFuel = function(vehicle) @@ -18,7 +17,7 @@ Fuel.GetFuel = function(vehicle) return exports["lc_fuel"]:GetFuel(vehicle) end ----Sets the fuel level of a vehicle. +---@description Sets the fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@param fuel number The fuel level to assign. ---@param type? string The fuel type, used only in ti_fuel. (default: RON91) diff --git a/modules/fuel/legacyfuel/client.lua b/modules/fuel/legacyfuel/client.lua index 49a875c..dd17acc 100644 --- a/modules/fuel/legacyfuel/client.lua +++ b/modules/fuel/legacyfuel/client.lua @@ -4,14 +4,13 @@ if GetResourceState(resourceName) == 'missing' then return end if GetResourceState("qb-fuel") == 'started' then return end Fuel = Fuel or {} ----Returns the name of the active fuel resource. ----If no supported resource is found, "default" will be returned. +---@description Returns the name of the active fuel resource. ---@return string Fuel.GetResourceName = function() return resourceName end ----Returns the current fuel level of a vehicle. +---@description Returns the current fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@return number The vehicle fuel level. Fuel.GetFuel = function(vehicle) @@ -19,7 +18,7 @@ Fuel.GetFuel = function(vehicle) return exports['LegacyFuel']:GetFuel(vehicle) end ----Sets the fuel level of a vehicle. +---@description Sets the fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@param fuel number The fuel level to assign. ---@param type? string The fuel type, used only in ti_fuel. (default: RON91) diff --git a/modules/fuel/okokGasStation/client.lua b/modules/fuel/okokGasStation/client.lua index f71a6c5..b2fc8c9 100644 --- a/modules/fuel/okokGasStation/client.lua +++ b/modules/fuel/okokGasStation/client.lua @@ -3,14 +3,13 @@ local resourceName = "okokGasStation" if GetResourceState(resourceName) == 'missing' then return end Fuel = Fuel or {} ----Returns the name of the active fuel resource. ----If no supported resource is found, "default" will be returned. +---@description Returns the name of the active fuel resource. ---@return string Fuel.GetResourceName = function() return resourceName end ----Returns the current fuel level of a vehicle. +---@description Returns the current fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@return number The vehicle fuel level. Fuel.GetFuel = function(vehicle) @@ -18,7 +17,7 @@ Fuel.GetFuel = function(vehicle) return exports['okokGasStation']:GetFuel(vehicle) end ----Sets the fuel level of a vehicle. +---@description Sets the fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@param fuel number The fuel level to assign. ---@param type? string The fuel type, used only in ti_fuel. (default: RON91) diff --git a/modules/fuel/ox_fuel/client.lua b/modules/fuel/ox_fuel/client.lua index c643b95..5b7cb92 100644 --- a/modules/fuel/ox_fuel/client.lua +++ b/modules/fuel/ox_fuel/client.lua @@ -3,14 +3,13 @@ local resourceName = "ox_fuel" if GetResourceState(resourceName) == 'missing' then return end Fuel = Fuel or {} ----Returns the name of the active fuel resource. ----If no supported resource is found, "default" will be returned. +---@description Returns the name of the active fuel resource. ---@return string Fuel.GetResourceName = function() return resourceName end ----Returns the current fuel level of a vehicle. +---@description Returns the current fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@return number The vehicle fuel level. Fuel.GetFuel = function(vehicle) @@ -18,7 +17,7 @@ Fuel.GetFuel = function(vehicle) return Entity(vehicle).state.fuel end ----Sets the fuel level of a vehicle. +---@description Sets the fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@param fuel number The fuel level to assign. ---@param type? string The fuel type, used only in ti_fuel. (default: RON91) diff --git a/modules/fuel/ps-fuel/client.lua b/modules/fuel/ps-fuel/client.lua index 520a6b6..e5c9d7b 100644 --- a/modules/fuel/ps-fuel/client.lua +++ b/modules/fuel/ps-fuel/client.lua @@ -3,14 +3,13 @@ local resourceName = "ps-fuel" if GetResourceState(resourceName) == 'missing' then return end Fuel = Fuel or {} ----Returns the name of the active fuel resource. ----If no supported resource is found, "default" will be returned. +---@description Returns the name of the active fuel resource. ---@return string Fuel.GetResourceName = function() return resourceName end ----Returns the current fuel level of a vehicle. +---@description Returns the current fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@return number The vehicle fuel level. Fuel.GetFuel = function(vehicle) @@ -18,7 +17,7 @@ Fuel.GetFuel = function(vehicle) return exports["ps-fuel"]:GetFuel(vehicle) end ----Sets the fuel level of a vehicle. +---@description Sets the fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@param fuel number The fuel level to assign. ---@param type? string The fuel type, used only in ti_fuel. (default: RON91) diff --git a/modules/fuel/qb-fuel/client.lua b/modules/fuel/qb-fuel/client.lua index 8c57932..cb741cd 100644 --- a/modules/fuel/qb-fuel/client.lua +++ b/modules/fuel/qb-fuel/client.lua @@ -3,14 +3,13 @@ local resourceName = "qb-fuel" if GetResourceState(resourceName) == 'missing' then return end Fuel = Fuel or {} ----Returns the name of the active fuel resource. ----If no supported resource is found, "default" will be returned. +---@description Returns the name of the active fuel resource. ---@return string Fuel.GetResourceName = function() return resourceName end ----Returns the current fuel level of a vehicle. +---@description Returns the current fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@return number The vehicle fuel level. Fuel.GetFuel = function(vehicle) @@ -18,7 +17,7 @@ Fuel.GetFuel = function(vehicle) return exports['qb-fuel']:GetFuel(vehicle) end ----Sets the fuel level of a vehicle. +---@description Sets the fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@param fuel number The fuel level to assign. ---@param type? string The fuel type, used only in ti_fuel. (default: RON91) diff --git a/modules/fuel/qs-fuelstations/client.lua b/modules/fuel/qs-fuelstations/client.lua index 84e9e93..e6a2364 100644 --- a/modules/fuel/qs-fuelstations/client.lua +++ b/modules/fuel/qs-fuelstations/client.lua @@ -3,14 +3,13 @@ local resourceName = "qs-fuelstations" if GetResourceState(resourceName) == 'missing' then return end Fuel = Fuel or {} ----Returns the name of the active fuel resource. ----If no supported resource is found, "default" will be returned. +---@description Returns the name of the active fuel resource. ---@return string Fuel.GetResourceName = function() return resourceName end ----Returns the current fuel level of a vehicle. +---@description Returns the current fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@return number The vehicle fuel level. Fuel.GetFuel = function(vehicle) @@ -18,7 +17,7 @@ Fuel.GetFuel = function(vehicle) return exports['qs-fuelstations']:GetFuel(vehicle) end ----Sets the fuel level of a vehicle. +---@description Sets the fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@param fuel number The fuel level to assign. ---@param type? string The fuel type, used only in ti_fuel. (default: RON91) diff --git a/modules/fuel/renewed-Fuel/client.lua b/modules/fuel/renewed-Fuel/client.lua index c5c0b90..0197cbc 100644 --- a/modules/fuel/renewed-Fuel/client.lua +++ b/modules/fuel/renewed-Fuel/client.lua @@ -3,14 +3,13 @@ local resourceName = "Renewed-Fuel" if GetResourceState(resourceName) == 'missing' then return end Fuel = Fuel or {} ----Returns the name of the active fuel resource. ----If no supported resource is found, "default" will be returned. +---@description Returns the name of the active fuel resource. ---@return string Fuel.GetResourceName = function() return resourceName end ----Returns the current fuel level of a vehicle. +---@description Returns the current fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@return number The vehicle fuel level. Fuel.GetFuel = function(vehicle) @@ -18,7 +17,7 @@ Fuel.GetFuel = function(vehicle) return exports['Renewed-Fuel']:GetFuel(vehicle) end ----Sets the fuel level of a vehicle. +---@description Sets the fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@param fuel number The fuel level to assign. ---@param type? string The fuel type, used only in ti_fuel. (default: RON91) diff --git a/modules/fuel/ti_fuel/client.lua b/modules/fuel/ti_fuel/client.lua index 005a078..fee140d 100644 --- a/modules/fuel/ti_fuel/client.lua +++ b/modules/fuel/ti_fuel/client.lua @@ -3,14 +3,13 @@ local resourceName = "ti_fuel" if GetResourceState(resourceName) == 'missing' then return end Fuel = Fuel or {} ----Returns the name of the active fuel resource. ----If no supported resource is found, "default" will be returned. +---@description Returns the name of the active fuel resource. ---@return string Fuel.GetResourceName = function() return resourceName end ----Returns the current fuel level of a vehicle. +---@description Returns the current fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@return number The vehicle fuel level. Fuel.GetFuel = function(vehicle) @@ -19,7 +18,7 @@ Fuel.GetFuel = function(vehicle) return level end ----Sets the fuel level of a vehicle. +---@description Sets the fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@param fuel number The fuel level to assign. ---@param type? string The fuel type, used only in ti_fuel. (default: RON91) diff --git a/modules/fuel/x-fuel/client.lua b/modules/fuel/x-fuel/client.lua index 712c5de..0468f47 100644 --- a/modules/fuel/x-fuel/client.lua +++ b/modules/fuel/x-fuel/client.lua @@ -3,14 +3,13 @@ local resourceName = "x-fuel" if GetResourceState(resourceName) == 'missing' then return end Fuel = Fuel or {} ----Returns the name of the active fuel resource. ----If no supported resource is found, "default" will be returned. +---@description Returns the name of the active fuel resource. ---@return string Fuel.GetResourceName = function() return resourceName end ----Returns the current fuel level of a vehicle. +---@description Returns the current fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@return number The vehicle fuel level. Fuel.GetFuel = function(vehicle) @@ -19,7 +18,7 @@ Fuel.GetFuel = function(vehicle) return level end ----Sets the fuel level of a vehicle. +---@description Sets the fuel level of a vehicle. ---@param vehicle number The vehicle entity handle. ---@param fuel number The fuel level to assign. ---@param type? string The fuel type, used only in ti_fuel. (default: RON91)