mirror of
https://github.com/neovim/neovim.git
synced 2026-02-20 10:28:33 +00:00
docs: improve/add documentation of Lua types
- Added `@inlinedoc` so single use Lua types can be inlined into the
functions docs. E.g.
```lua
--- @class myopts
--- @inlinedoc
---
--- Documentation for some field
--- @field somefield integer
--- @param opts myOpts
function foo(opts)
end
```
Will be rendered as
```
foo(opts)
Parameters:
- {opts} (table) Object with the fields:
- somefield (integer) Documentation
for some field
```
- Marked many classes with with `@nodoc` or `(private)`.
We can eventually introduce these when we want to.
This commit is contained in:
committed by
Lewis Russell
parent
813dd36b72
commit
a5fe8f59d9
@@ -797,6 +797,7 @@ end
|
||||
--- `vim.opt_global`.
|
||||
--- </pre>
|
||||
|
||||
--- @nodoc
|
||||
--- @class vim.Option
|
||||
local Option = {} -- luacheck: no unused
|
||||
|
||||
|
||||
Reference in New Issue
Block a user