Skip to content

@alias and @enum file paths #3257

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+7 −1
Open

@alias and @enum file paths #3257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d9da18a
Export @alias and @enum into docs with file path
tommaisey Aug 21, 2025
5d36ba1
Render strings correctly in exported enum doc comments
tommaisey Aug 21, 2025
f2e803e
Update changelog for alias/enum file paths improvement
tommaisey Aug 21, 2025
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
1 change: 1 addition & 0 deletions changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## Unreleased
<!-- Add all new changes here. They will be moved under a version at release -->
* `NEW` Doc output now contains file paths for `@alias` and `@enum` types
* `FIX` Incorrect inject-field message for extra table field in exact class
* `CHG` Rename configuration option `Lua.diagnostics.disableScheme` to `Lua.diagnostics.validScheme` and improve its description. Now it enables diagnostics for Lua files that use the specified scheme.
* `FIX` adds the `|lambda|` operator to the `Lua.runtime.nonstandardSymbol` configuration template, which allows the use of that option. Previously, support for it existed in the parser, but we could not actually use the option because it is not recognised in the configuration.
Expand Down
5 changes: 5 additions & 0 deletions script/cli/doc/export.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,11 @@ export.makeDocObject['INIT'] = function(source, has_seen)
end

export.makeDocObject['doc.alias'] = function(source, obj, has_seen)
obj.file = export.getLocalPath(guide.getUri(source))
end

export.makeDocObject['doc.enum'] = function(source, obj, has_seen)
obj.file = export.getLocalPath(guide.getUri(source))
end

export.makeDocObject['doc.field'] = function(source, obj, has_seen)
Expand Down Expand Up @@ -256,6 +260,7 @@ export.makeDocObject['variable'] = function(source, obj, has_seen)
or set.type == 'setmethod'
or set.type == 'setindex'
or set.type == 'doc.alias'
or set.type == 'doc.enum'
or set.type == 'doc.class'
then
table.insert(obj.defines, export.documentObject(set, has_seen))
Expand Down
2 changes: 1 addition & 1 deletion script/core/hover/description.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -507,7 +507,7 @@ local function tryDocEnum(source)
end
if field.value.type == 'integer'
or field.value.type == 'string' then
md:add('lua', (' %s: %s = %s,'):format(key, field.value.type, field.value[1]))
md:add('lua', (' %s: %s = %q,'):format(key, field.value.type, field.value[1]))
end
if field.value.type == 'binary'
or field.value.type == 'unary' then
Expand Down
Loading