| Copyright | (c) Mateusz Kowalczyk 2013-2014, Simon Hengel 2013 |
|---|---|
| License | BSD-like |
| Maintainer | [email protected] |
| Stability | experimental |
| Portability | portable |
| Safe Haskell | None |
| Language | Haskell2010 |
Documentation.Haddock.Parser
Description
Parser used for Haddock comments. For external users of this library, the most commonly used combination of functions is going to be
toRegular.parseParas
- parseString :: String -> DocH mod Identifier
- parseParas :: String -> MetaDoc mod Identifier
- overIdentifier :: (String -> Maybe a) -> DocH mod Identifier -> DocH mod a
- toRegular :: DocH mod Identifier -> DocH mod String
- type Identifier = (Char, String, Char)
Documentation
parseString :: String -> DocH mod Identifier Source
Parse a text paragraph. Actually just a wrapper over parseStringBS which
drops leading whitespace and encodes the string to UTF8 first.
Arguments
| :: String | String to parse |
| -> MetaDoc mod Identifier |
Main entry point to the parser. Appends the newline character to the input string.
overIdentifier :: (String -> Maybe a) -> DocH mod Identifier -> DocH mod a Source
Maps over DocIdentifiers over String with potentially failing
conversion using user-supplied function. If the conversion fails,
the identifier is deemed to not be valid and is treated as a
regular string.
toRegular :: DocH mod Identifier -> DocH mod String Source
Drops the quotes/backticks around all identifiers, as if they
were valid but still Strings.
type Identifier = (Char, String, Char) Source
Identifier string surrounded with opening and closing quotes/backticks.