Reuse doc completion, hover, and definition for @see
#698
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR improves handling of `@see` contents by reusing machinery introduced for parsing documentation comments. The behaviour is backwards-compatible with the old syntax (`@see class#member`). To avoid code duplication, I've adjusted `TkDocSeeContent` to only include symbols that are valid in cross-references. The rest is pushed into `Description`, [which was already present in AST][desc], but remained empty due to `TkDocSeeContent` consuming the entire line. Fix EmmyLuaLs#671 [desc]: https://github.com/EmmyLuaLs/emmylua-analyzer-rust/blob/2bb63fa4dca5ddd617b70c08f74bf11a15f2b6f8/crates/emmylua_parser/src/grammar/doc/tag.rs#L386
CppCXY
reviewed
Aug 18, 2025
| @@ -403,7 +403,30 @@ impl LuaDocLexer<'_> { | |||
| LuaTokenKind::TkWhitespace | |||
| } | |||
| _ => { | |||
| reader.eat_while(|_| true); | |||
| let mut brace_level = 0usize; | |||
There was a problem hiding this comment.
can not change the lexer, Because anything can follow after "see".
There was a problem hiding this comment.
On the contrary, this change allows handling anything after @see, not only type name. If user follows LuaLs syntax, this will be parsed correctly so that completion and go to definition works. If not, @see content will just be a description, which is not structured.
There was a problem hiding this comment.
if I write ---@see Program Files/..., So I can only see Program in the hover, and after splitting by spaces, their semantic tokens are also different
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR improves handling of
@seecontents by reusing machinery introduced for parsing documentation comments. The behaviour is backwards-compatible with the old syntax (@see class#member).To avoid code duplication, I've adjusted
TkDocSeeContentto only include symbols that are valid in cross-references. The rest is pushed intoDescription, which was already present in AST, but remained empty due toTkDocSeeContentconsuming the entire line.Fix #671