mirror of
https://github.com/neovim/neovim
synced 2025-07-16 09:11:51 +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
@ -108,22 +108,25 @@ function M.read(path)
|
||||
return contents
|
||||
end
|
||||
|
||||
---@class vim.trust.opts
|
||||
---@field action string
|
||||
---@field path? string
|
||||
---@field bufnr? integer
|
||||
--- @class vim.trust.opts
|
||||
--- @inlinedoc
|
||||
---
|
||||
--- - `'allow'` to add a file to the trust database and trust it,
|
||||
--- - `'deny'` to add a file to the trust database and deny it,
|
||||
--- - `'remove'` to remove file from the trust database
|
||||
--- @field action 'allow'|'deny'|'remove'
|
||||
---
|
||||
--- Path to a file to update. Mutually exclusive with {bufnr}.
|
||||
--- Cannot be used when {action} is "allow".
|
||||
--- @field path? string
|
||||
--- Buffer number to update. Mutually exclusive with {path}.
|
||||
--- @field bufnr? integer
|
||||
|
||||
--- Manage the trust database.
|
||||
---
|
||||
--- The trust database is located at |$XDG_STATE_HOME|/nvim/trust.
|
||||
---
|
||||
---@param opts (table):
|
||||
--- - action (string): "allow" to add a file to the trust database and trust it,
|
||||
--- "deny" to add a file to the trust database and deny it,
|
||||
--- "remove" to remove file from the trust database
|
||||
--- - path (string|nil): Path to a file to update. Mutually exclusive with {bufnr}.
|
||||
--- Cannot be used when {action} is "allow".
|
||||
--- - bufnr (number|nil): Buffer number to update. Mutually exclusive with {path}.
|
||||
---@param opts? vim.trust.opts
|
||||
---@return boolean success true if operation was successful
|
||||
---@return string msg full path if operation was successful, else error message
|
||||
function M.trust(opts)
|
||||
|
Reference in New Issue
Block a user