haskell-docs-4.2.9: A program to find and display the docs and type of a name

Safe HaskellNone
LanguageHaskell98

Haskell.Docs.HaddockDoc

Contents

Description

Post-haddock-api.

Synopsis

Documentation

doc :: Doc String -> String Source #

Render the doc.

Get documentation of parts of things

interfaceNameMap :: InstalledInterface -> Map String (Doc String) Source #

Get a mapping from names to doc string of that name from a Haddock interface.

interfaceArgMap :: InstalledInterface -> Map String (Map Int (Doc Name)) Source #

Get a mapping from names to doc string of that name from a Haddock interface.

normalize :: [Char] -> [Char] Source #

Strip redundant whitespace.

trim :: [Char] -> [Char] Source #

Trim either side of a string.

formatExample :: Example -> String Source #

Format an example to plain text.