Haskell.Docs.Formatting

Formatting of Haddock documentation.

Formatting

printSexp :: [IdentDoc] -> Ghc ()

Print docs as s-expressions.

printIdentDoc

Arguments

:: Bool

Print modules only?

-> Bool

Print package?

-> Bool

Print module?

-> IdentDoc

-> Ghc ()

Print an identifier' documentation.

formatDoc :: Doc String -> String

Format some documentation to plain text.

Internal functions

data Sexp

S-expression type.

Constructors

Atom String

String String

List [Sexp]

renderSexp :: Sexp -> String

Render an s-expression to string.

toSexp :: IdentDoc -> Ghc Sexp

Convert docs to an s-expression.

doc :: Doc String -> String

Render the doc.

normalize :: [Char] -> [Char]

Strip redundant whitespace.

trim :: [Char] -> [Char]

Trim either side of a string.

formatExample :: Example -> String

Format an example to plain text.

formatArg :: Show a => a -> Doc String -> String

Format an argument.

indentAfter :: Int -> String -> String

Indent after the first line.