Documentation.Haddock.Types

Exposes documentation data types used for (some) of Haddock.

Documentation

data Hyperlink

Constructors

Hyperlink

Fields

hyperlinkUrl :: String

hyperlinkLabel :: Maybe String

Instances

Eq Hyperlink

Show Hyperlink

data Picture

Constructors

Picture

Fields

pictureUri :: String

pictureTitle :: Maybe String

Instances

Eq Picture

Show Picture

data Header id

Constructors

Header

Fields

headerLevel :: Int

headerTitle :: id

Instances

Functor Header

Foldable Header

Traversable Header

Eq a => Eq (Header a)

Show a => Show (Header a)

data Example

Constructors

Example

Fields

exampleExpression :: String

exampleResult :: [String]

Instances

Eq Example

Show Example

data DocH mod id

Constructors

DocEmpty

DocAppend (DocH mod id) (DocH mod id)

DocString String

DocParagraph (DocH mod id)

DocIdentifier id

DocIdentifierUnchecked mod

DocModule String

DocWarning (DocH mod id)

DocEmphasis (DocH mod id)

DocMonospaced (DocH mod id)

DocBold (DocH mod id)

DocUnorderedList [DocH mod id]

DocOrderedList [DocH mod id]

DocDefList [(DocH mod id, DocH mod id)]

DocCodeBlock (DocH mod id)

DocHyperlink Hyperlink

DocPic Picture

DocAName String

DocProperty String

DocExamples [Example]

DocHeader (Header (DocH mod id))

Instances

Functor (DocH mod)

Foldable (DocH mod)

Traversable (DocH mod)

(Eq a, Eq b) => Eq (DocH a b)

(Show a, Show b) => Show (DocH a b)

Monoid (DocH mod id)