docvim- Documentation generator for Vim plug-ins

Safe HaskellNone




getPluginName :: Node -> Maybe String Source #

Returns the name of the plug-in or Nothing if none is found.

In the event that there are multiple `@plugin` annotations competing to define the name of plugin, the first encountered one wins.

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

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

It is not recommended to have multiple `@plugin` 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.