Skip to content
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.

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

Refering to a symbol from luadoc #2175

Closed
Frityet opened this issue Jun 20, 2023 · 2 comments · Fixed by #2656
Closed

Refering to a symbol from luadoc #2175

Frityet opened this issue Jun 20, 2023 · 2 comments · Fixed by #2656
Labels
enhancement New feature or request

Comments

@Frityet
Copy link
Contributor

Frityet commented Jun 20, 2023

It would be nice to be able to refer to a specific function/type from luadoc

---Hello
---@class SomeClass

---This uses [this](lua://SomeClass)
local function f() end

and then on hover, I can hover over this in order to get the docs of SomeClass. Its like @see but inline

@carsakiller
Copy link
Collaborator

carsakiller commented Jun 21, 2023

There is a @see annotation, but I think specifying a markdown link is way more useful. Maybe I close my old issue and we instead do something like what you have mentioned.

@Frityet
Copy link
Contributor Author

Frityet commented Jul 9, 2023

I agree!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants