Skip to content

Alternate fix for #1173 #1178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 28, 2022
Merged

Alternate fix for #1173 #1178

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9f546ba
Update love-api builder
C3pa May 28, 2022
94d4cc3
Don't modify the meta data
C3pa May 28, 2022
e4ebac9
Make code more readable by adding a new variable
C3pa May 28, 2022
ac4d8bc
Remove unused brackets
C3pa May 28, 2022
6803eb5
Add ~= nil check
C3pa May 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion tools/love-api.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,16 @@ local function formatIndex(key)
return ('[%q]'):format(key)
end

local function isTableOptional(tbl)
local optional = true
for _, field in ipairs(tbl) do
if field.default == nil then
optional = nil
end
end
return optional
end

local buildType

local function buildDocTable(tbl)
Expand Down Expand Up @@ -146,9 +156,10 @@ local function buildFunction(func, node, typeName)
for _, param in ipairs(func.variants[1].arguments or {}) do
for paramName in param.name:gmatch '[%a_][%w_]*' do
params[#params+1] = paramName
local optional = param.type == 'table' and isTableOptional(param.table) or (param.default ~= nil)
text[#text+1] = ('---@param %s%s %s # %s'):format(
paramName,
param.default == nil and '' or '?',
optional and '?' or '',
buildType(param),
param.description
)
Expand Down