Skip to main content

Code annotations

Adds the ability to generate annotations from function, class or variable signatures.

Settings

Settings for the annotations module.

You can access and override these values in your config.lua. I.e.

local annotations_settings = doom.features.annotations.settings
annotations_settings.<field> = <new_value>
annotations.settings = {
enabled = true,
languages = {
lua = {
template = {
annotation_convention = "emmylua",
},
},
typescript = {
template = {
annotation_convention = "tsdoc",
},
},
},
}

Plugins/Packages

Plugins for the doom.features.annotations module.

These plugins will be passed into packer.nvim on startup. You can tweak the packer options by accessing these values in your config.lua file. i.e.:

local annotations_packages = doom.features.annotations.packages
annotations_packages['neogen'].commit = '<my_new_commit_sha>'
KeySourceCommitIs Lazy?
neogen danymat/neogend7d7ade52d97d06e868ec4d9a0bc59282

Keybinds

Override these keybinds in your config.lua:

local annotations = doom.features.annotations
annotations.binds = {
{ "<leader>prefix", "<cmd>echo 'my new keybind'<CR>", name = "Description for my new keybind" }
}
KeymapDescription
<leader>cg Generate annotations