| Safe Haskell | None |
|---|---|
| Language | Haskell98 |
Language.PureScript.Docs.RenderedCode.Types
Description
Data types and functions for representing a simplified form of PureScript code, intended for use in e.g. HTML documentation.
- data RenderedCodeElement
- asRenderedCodeElement :: Parse String RenderedCodeElement
- data ContainingModule
- asContainingModule :: Parse e ContainingModule
- containingModuleToMaybe :: ContainingModule -> Maybe ModuleName
- maybeToContainingModule :: Maybe ModuleName -> ContainingModule
- fromContainingModule :: ModuleName -> ContainingModule -> ModuleName
- data RenderedCode
- asRenderedCode :: Parse String RenderedCode
- outputWith :: Monoid a => (RenderedCodeElement -> a) -> RenderedCode -> a
- sp :: RenderedCode
- syntax :: String -> RenderedCode
- ident :: String -> RenderedCode
- ctor :: String -> ContainingModule -> RenderedCode
- kind :: String -> RenderedCode
- keyword :: String -> RenderedCode
- keywordForall :: RenderedCode
- keywordData :: RenderedCode
- keywordNewtype :: RenderedCode
- keywordType :: RenderedCode
- keywordClass :: RenderedCode
- keywordInstance :: RenderedCode
- keywordWhere :: RenderedCode
- keywordFixity :: Associativity -> RenderedCode
Documentation
data RenderedCodeElement Source
A single element in a rendered code fragment. The intention is to support multiple output formats. For example, plain text, or highlighted HTML.
data ContainingModule Source
This type is isomorphic to Maybe ModuleName. It makes code a bit easier
to read, as the meaning is more explicit.
Constructors
| ThisModule | |
| OtherModule ModuleName |
containingModuleToMaybe :: ContainingModule -> Maybe ModuleName Source
Convert a ContainingModule to a Maybe ModuleName, using the obvious
isomorphism.
maybeToContainingModule :: Maybe ModuleName -> ContainingModule Source
Convert a Maybe ModuleName to a ContainingModule, using the obvious
isomorphism.
fromContainingModule :: ModuleName -> ContainingModule -> ModuleName Source
A version of fromMaybe for ContainingModule values.
data RenderedCode Source
A type representing a highly simplified version of PureScript code, intended for use in output formats like plain text or HTML.
outputWith :: Monoid a => (RenderedCodeElement -> a) -> RenderedCode -> a Source
This function allows conversion of a RenderedCode value into a value of
some other type (for example, plain text, or HTML). The first argument
is a function specifying how each individual RenderedCodeElement should be
rendered.
sp :: RenderedCode Source
A RenderedCode fragment representing a space.
syntax :: String -> RenderedCode Source
ident :: String -> RenderedCode Source
ctor :: String -> ContainingModule -> RenderedCode Source
kind :: String -> RenderedCode Source
keyword :: String -> RenderedCode Source