docvim-0.3.2.1: Documentation generator for Vim plug-ins

Text.Docvim.Visitor.Options

Synopsis

Documentation

extractOptions :: Alternative f => [Node] -> (f [Node], [Node]) Source #

Extracts a list of nodes (if any exist) from the @options section(s) of the source code.

It is not recommended to have multiple @options sections in a project. If multiple such sections (potentially across multiple translation units) exist, there are no guarantees about order; they just get concatenated in the order we see them.