Functions and commands defined without description text show a warning like DocumentationWarning: Undocumented function Foo and aren't listed at all in the documentation, even if they're declared with a vimdoc comment block that explicitly lists them as @public and declares their signature with @usage. Granted, our warning indicates you shouldn't be doing that anyway, but it should either:
be an error and completely prevent doc generation or
be a warning and generate the best documentation it can from the details given.
(And, FWIW, it's pretty opinionated of us to issue a warning for perfectly valid vimdoc; some really simple functions/commands may be self-explanatory enough from the arg names and just not need prose.)
Functions and commands defined without description text show a warning like
DocumentationWarning: Undocumented function Foo
and aren't listed at all in the documentation, even if they're declared with a vimdoc comment block that explicitly lists them as@public
and declares their signature with@usage
. Granted, our warning indicates you shouldn't be doing that anyway, but it should either:(And, FWIW, it's pretty opinionated of us to issue a warning for perfectly valid vimdoc; some really simple functions/commands may be self-explanatory enough from the arg names and just not need prose.)