purescript-0.12.0: PureScript Programming Language Compiler

Safe HaskellNone
LanguageHaskell2010

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.

Synopsis

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.

Constructors

Syntax Text 
Keyword Text 
Space 
Symbol Namespace Text Link

Any symbol which you might or might not want to link to, in any namespace (value, type, or kind). Note that this is not related to the kind called Symbol for type-level strings.

data Namespace Source #

Instances

Eq Namespace Source # 
Ord Namespace Source # 
Show Namespace Source # 
Generic Namespace Source # 

Associated Types

type Rep Namespace :: * -> * #

ToJSON Namespace Source # 
FromJSON Namespace Source # 
NFData Namespace Source # 

Methods

rnf :: Namespace -> () #

type Rep Namespace Source # 
type Rep Namespace = D1 * (MetaData "Namespace" "Language.PureScript.Docs.RenderedCode.Types" "purescript-0.12.0-GnFPE64AyqYHZk4VD04uBy" False) ((:+:) * (C1 * (MetaCons "ValueLevel" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "TypeLevel" PrefixI False) (U1 *)) (C1 * (MetaCons "KindLevel" PrefixI False) (U1 *))))

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.

parens :: RenderedCode -> RenderedCode Source #

Wrap a RenderedCode value in parens.