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.
This commit is contained in:
MrNewb committed 2025-10-12 21:54:52 -04:00
1 parent c73faa43db
commit a7b3a34998
14 files changed
+42 -56

No files matched your search

+3 -4
View File
@@ -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)