| Copyright | (c) Mateusz Kowalczyk 2013-2014 Simon Hengel 2013 |
|---|---|
| License | BSD-like |
| Maintainer | [email protected] |
| Stability | experimental |
| Portability | portable |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
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
parseString :: String -> DocH mod Identifier Source
Variant of parseText for String instead of Text
| :: Maybe Package | |
| -> String | String to parse |
| -> MetaDoc mod Identifier |
Main entry point to the parser. Appends the newline character to the input string.
overIdentifier :: (Namespace -> 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.
data Identifier Source
Identifier string surrounded with namespace, opening, and closing quotes/backticks.
| Show Identifier Source | |
Defined in Documentation.Haddock.Parser.Identifier MethodsshowsPrec :: Int -> Identifier -> ShowS show :: Identifier -> String showList :: [Identifier] -> ShowS | |
| Eq Identifier Source | |
Defined in Documentation.Haddock.Parser.Identifier | |
© The University of Glasgow and others
Licensed under a BSD-style license (see top of the page).
https://downloads.haskell.org/~ghc/9.12.1/docs/libraries/haddock-library-1.11.0-c735/Documentation-Haddock-Parser.html