docvim-0.3.1.1: Documentation generator for Vim plug-ins

Safe HaskellNone
LanguageHaskell2010

Text.Docvim.Util

Description

Functions to facilitate automated and manual testing.

Synopsis

Documentation

compileUnits :: [String] -> Either ParseError Node Source #

Parse and compile a list of strings containing a translation units.

p :: [String] -> String Source #

Convenience function: Parse and compile a list of strings containing translation units, but always returns a string even in the case of an error.

parseUnit :: String -> Either ParseError Node Source #

Parse a string containing a translation unit.

pm :: [String] -> String Source #

Parse and compile a list of input strings into Markdown help format.

pp :: String -> IO () Source #

Pretty-prints the result of parsing and compiling an input string.

To facilitate quick testing in the REPL; example:

pp "unlet g:var"

ppm :: String -> IO () Source #

Pretty-prints the result of parsing and compiling an input string and transforming into Markdown format.

For logging in the REPL.

ppv :: String -> IO () Source #

Pretty-prints the result of parsing and compiling an input string and transforming into Vim help format.

For logging in the REPL.

pv :: [String] -> String Source #

Parse and compile a list of input strings into Vim help format.