Modulehaddock-library-1.11.0Haskell2010

Documentation.Haddock.Parser

Parser used for Haddock comments. For external users of this library, the most commonly used combination of functions is going to be

toRegular . _doc . parseParas

1 type
4 values

Packagehaddock-library-1.11.0
Exports5
LanguageHaskell2010
LicenceBSD-2-Clause
SourceParser.hs

valueparseString :: String -> DocH mod Identifier

Variant of parseText for String instead of Text

valueparseParas

:: Maybe Package
-> String
String to parse
-> MetaDoc mod Identifier

Main entry point to the parser. Appends the newline character to the input string.

valueoverIdentifier

:: Namespace -> String -> Maybe a
-> DocH mod Identifier
-> DocH mod a

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.

valuetoRegular :: DocH mod Identifier -> DocH mod String

Drops the quotes/backticks around all identifiers, as if they were valid but still Strings.

datadata Identifier

Identifier string surrounded with namespace, opening, and closing quotes/backticks.

Instances2Eq, Show

Eq IdentifierDefined in haddock-library-1.11.0 · Documentation.Haddock.Parser.Identifier
Show IdentifierDefined in haddock-library-1.11.0 · Documentation.Haddock.Parser.Identifier