4f639a9d3a
The plugin now recognizes indentation level and will write the comments
at the same indentation level as the function.
for example:
function()
-- this is junk
-- this is junk
-- The annotation will be created here
function()
end
-- this is junk
-- this is junk
end
neogen
A better Neovim documentation generator
Warning
This project is still in alpha !
Work In progress:
- lua:
@return,@param
Installation
- Packer
use {
"danymat/neogen",
config = function()
require('neogen').setup {
enabled = true
}
end
}
Usage
I exposed a command :Neogen to generate the annotations.
You can bind it to your keybind of choice:
vim.api.nvim_set_keymap("n", "<Leader>ng", ":Neogen<CR>", {})
If you are inside a function, it'll generate the documentation for you with Emmylua annotation convention