vimdoc
vimdoc copied to clipboard
google
Helpfile generation for vim
The default documentation for a `plugin[mappings]` flag just says ``` Configures whether plugin/mappings.vim should be loaded. Default: 0 ``` It should also mention that it can accept string values, and...
If there's no plugin name declared in addon-info.json, vimdoc takes the name of the directory that contains the plugin as the plugin name. Often this directory will have a "vim-"...
Vimdoc can detect ``` vim call s:plugin.Flag('foo', 'bar') ``` but not ``` vim call s:plugin.Flag( \ 'foo', 'bar') ```
Tests would be nice. Vimdoc is currently pretty hacky and fairly buggy.
Vimdoc issues an ArgumentMismatch warning if actual function arguments don't match those declared in the doc block, but it's not checking command arguments at all. It should issue a warning...
Vimdoc should detect undeclared thrown errors and either error out of doc generation or automatically document them. This would include explicit `throw` invocations and/or errors thrown by detected function calls,...
We got rid of pipe line continuations in vimdoc. That means currently there's no way to have an `@throws` line longer than 80 characters. Given this vimdoc comment: ``` "...
Would be cool if we had a logo to include in the docs and the deb. I'm assuming this would be some kind of a "V" with a scroll or...
I'm working on a plugin whose configuration uses a mix of vim builtin settings and maktaba flags. Accordingly, I want to add custom text to the configuration section to point...
module.py Module.Merge may be a good place to start. In fact, vimdoc exceptions should be made more intelligent across the board. Line numbers are a good place to start, though.