vimdoc
vimdoc copied to clipboard
google
Helpfile generation for vim
The limitation that @section and @dict must be followed by a blank line is often surprising and can cause some frustrating behavior. (This might be fixable by tweaking codeline.py UnrecognizedLine.)
Broken inline directives fail to cause errors. This can be fixed by expanding all inline directives that are in front of parens. (See output.py Helpfile.Expand.)
If a plugin only has an autoload/ directory and nothing else, then it's a safe bet that it's a @library plugin.
Plugins with directories outside of the standard autoload/ftplugin/etc. may want those custom directories to be noticed by vimdoc. That's not currently possible.
Such as a:firstline and a:lastline in range functions. (It should also perhaps recognize function flags like 'dict' and 'range' more generally.)
This includes adding an augroup section and recognizing augroup lines.
For some plugins, there's no natural place to put doc comments like `@section` blocks to control vimdoc output, so we've resorted to a convention of adding empty `plugin/doc.vim` files purely...
In keeping with the spirit of DRY, it'd be nice if vimdoc could understand maktaba's variable type checking. Whenever `maktaba#ensure` calls are present for `a:foo`, it could add some (optional)...
Should they be presumed @private? Or should they have their signatures put in the helpfile with no explanation? Or should vimdoc complain that they must be explicitly marked @private? Should...