Does field annotation support multi-line documentation? #2344
-
|
For example. ---@class lsp.config
---@field cmd table|string|fun(dispatchers: table):table command string or
--- list treated like |jobstart()|. The command must launch the language server
--- process. `cmd` can also be a function that creates an RPC client.
--- The function receives a dispatchers table and must return a table with the
--- functions `request`, `notify`, `is_closing` and `terminate`
--- See |vim.lsp.rpc.request()| and |vim.lsp.rpc.notify()|
--- For TCP there is a built-in rpc client factory: |vim.lsp.rpc.connect()| |
Beta Was this translation helpful? Give feedback.
Answered by
carsakiller
Mar 18, 2026
Replies: 2 comments
This comment has been hidden.
This comment has been hidden.
-
Beta Was this translation helpful? Give feedback.
0 replies
Answer selected by
carsakiller
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment

Not sure if this was always possible, but at least right now you actually can have a multi-line description for a
@fieldby putting the description above the field:Code