Experimenting. Add runtime/lua/vim/decorator.lua

Add decorator.lua to config.lsp.section_order and runtime/lua/vim/decorator.lua to config.files

Run

nvim -u NONE -l src/gen/preload.lua . src/gen/gen_vimdoc.lua

---Custom decorator, see |nvim-tree-decorators|
---
---@class nvim_tree.api.decorator.UserDecorator
---@field private enabled boolean
---@field protected highlight_range nvim_tree.api.decorator.HighlightRange
---@field icon_placement nvim_tree.api.decorator.IconPlacement
---@see |nvim_tree.api.decorator.HighlightRange|

---Custom decorator, see :help nvim-tree-decorators
---
---@class (exact) nvim_tree.api.decorator.UserDecoratorExact
---@field enabled boolean
---@field highlight_range nvim_tree.api.decorator.HighlightRange
---@field icon_placement nvim_tree.api.decorator.IconPlacement

---Abstract: optionally implement to set the node's icon
---
---@param node nvim_tree.api.Node
---@return nvim_tree.api.HighlightedString? icon_node
function nvim_tree.api.decorator.UserDecorator.icon_node(node) end

---Abstract: optionally implement to provide icons and the highlight groups for your icon_placement.
---
---@param node nvim_tree.api.Node
---@return nvim_tree.api.HighlightedString[]? icons
function nvim_tree.api.decorator.UserDecorator:icons(node) end

==============================================================================
Lua module: vim.lsp.decorator                                  *lsp-decorator*

*nvim_tree.api.decorator.UserDecorator*
    Custom decorator, see |nvim-tree-decorators|

    Fields: ~
      • {icon_placement}  (`nvim_tree.api.decorator.IconPlacement`)


             *vim.decorator.nvim_tree.api.decorator.UserDecorator.icon_node()*
nvim_tree.api.decorator.UserDecorator.icon_node({node})
    Abstract: optionally implement to set the node's icon

    Parameters: ~
      • {node}  (`nvim_tree.api.Node`)

    Return: ~
        (`nvim_tree.api.HighlightedString?`) icon_node

Notable:

private and protected fields are not rendered
(exact) class is not rendered
methods are not rendered, only functions edit: lsp/client.lsp is actually rendering methods
- requires a non-namespaced local class e.g. local UserDecorator = {}
params, fields, return are rendered as backticked strings, not links
extends is rendered as a link
does not handle mixin/multiple inheritence, luals doesn't handle them well either
places classes before functions
@enums and @types are not rendered
@see is rendered as a list (exact text) for functions, but not classes. It's sometimes used with help link text, however that upsets luals

Uh oh!

Documentation: Config luals Annotations And Help #2934

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions