Modulehaddock-library-1.11.0Haskell2010

Documentation.Haddock.Types

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

15 types
3 values

Packagehaddock-library-1.11.0
Exports18
LanguageHaskell2010
LicenceBSD-2-Clause
SourceTypes.hs

datadata Meta

With the advent of Version, we may want to start attaching more meta-data to comments. We make a structure for this ahead of time so we don't have to gut half the core each time we want to add such info.

Constructors

Meta
- _version :: Maybe Version
- _package :: Maybe Package

Instances2Eq, Show

Eq MetaDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Show MetaDefined in haddock-library-1.11.0 · Documentation.Haddock.Types

datadata MetaDoc mod id

Constructors

MetaDoc
- _meta :: Meta
- _doc :: DocH mod id

Instances8Bifoldable, Bifunctor, Bitraversable, Functor, Foldable, Traversable, …

Bifoldable MetaDocDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
NOTE: Only defined for base >= 4.10.0
Bifunctor MetaDocDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
NOTE: Only defined for base >= 4.8.0
Bitraversable MetaDocDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
NOTE: Only defined for base >= 4.10.0
Functor (MetaDoc mod)Defined in haddock-library-1.11.0 · Documentation.Haddock.Types
Foldable (MetaDoc mod)Defined in haddock-library-1.11.0 · Documentation.Haddock.Types
Traversable (MetaDoc mod)Defined in haddock-library-1.11.0 · Documentation.Haddock.Types
(Eq id, Eq mod) => Eq (MetaDoc mod id)Defined in haddock-library-1.11.0 · Documentation.Haddock.Types
(Show id, Show mod) => Show (MetaDoc mod id)Defined in haddock-library-1.11.0 · Documentation.Haddock.Types

valueoverDoc :: (DocH a b -> DocH c d) -> MetaDoc a b -> MetaDoc c d

valueoverDocF

:: Functor f
=> DocH a b -> f (DocH c d)
-> MetaDoc a b
-> f (MetaDoc c d)

typetype Version = [Int]

typetype Package = String

datadata Hyperlink id

Constructors

Hyperlink
- hyperlinkUrl :: String
- hyperlinkLabel :: Maybe id

Instances5Functor, Foldable, Traversable, Eq, Show

Functor HyperlinkDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Foldable HyperlinkDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Traversable HyperlinkDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Eq id => Eq (Hyperlink id)Defined in haddock-library-1.11.0 · Documentation.Haddock.Types
Show id => Show (Hyperlink id)Defined in haddock-library-1.11.0 · Documentation.Haddock.Types

datadata ModLink id

Constructors

ModLink
- modLinkName :: String
- modLinkLabel :: Maybe id

Instances5Functor, Foldable, Traversable, Eq, Show

Functor ModLinkDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Foldable ModLinkDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Traversable ModLinkDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Eq id => Eq (ModLink id)Defined in haddock-library-1.11.0 · Documentation.Haddock.Types
Show id => Show (ModLink id)Defined in haddock-library-1.11.0 · Documentation.Haddock.Types

datadata Picture

Constructors

Picture
- pictureUri :: String
- pictureTitle :: Maybe String

Instances2Eq, Show

Eq PictureDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Show PictureDefined in haddock-library-1.11.0 · Documentation.Haddock.Types

datadata Header id

Constructors

Header
- headerLevel :: Int
  between 1 and 6 inclusive
- headerTitle :: id

datadata Example

Constructors

Example
- exampleExpression :: String
- exampleResult :: [String]

Instances2Eq, Show

Eq ExampleDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Show ExampleDefined in haddock-library-1.11.0 · Documentation.Haddock.Types

datadata TableCell id

Constructors

TableCell
- tableCellColspan :: Int
- tableCellRowspan :: Int
- tableCellContents :: id

Instances5Functor, Foldable, Traversable, Eq, Show

Functor TableCellDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Foldable TableCellDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Traversable TableCellDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Eq id => Eq (TableCell id)Defined in haddock-library-1.11.0 · Documentation.Haddock.Types
Show id => Show (TableCell id)Defined in haddock-library-1.11.0 · Documentation.Haddock.Types

newtypenewtype TableRow id

Constructors

TableRow
- tableRowCells :: [TableCell id]

Instances5Functor, Foldable, Traversable, Eq, Show

Functor TableRowDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Foldable TableRowDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Traversable TableRowDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Eq id => Eq (TableRow id)Defined in haddock-library-1.11.0 · Documentation.Haddock.Types
Show id => Show (TableRow id)Defined in haddock-library-1.11.0 · Documentation.Haddock.Types

datadata Table id

Constructors

Table
- tableHeaderRows :: [TableRow id]
- tableBodyRows :: [TableRow id]

Instances5Functor, Foldable, Traversable, Eq, Show

Functor TableDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Foldable TableDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Traversable TableDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Eq id => Eq (Table id)Defined in haddock-library-1.11.0 · Documentation.Haddock.Types
Show id => Show (Table id)Defined in haddock-library-1.11.0 · Documentation.Haddock.Types

datadata DocH mod id

Constructors

DocEmpty
DocAppend (DocH mod id) (DocH mod id)
DocString String
DocParagraph (DocH mod id)
DocIdentifier id
DocIdentifierUnchecked mod
A qualified identifier that couldn't be resolved.
DocModule (ModLink (DocH mod id))
A link to a module, with an optional label.
DocWarning (DocH mod id)
This constructor has no counterpart in Haddock markup.
DocEmphasis (DocH mod id)
DocMonospaced (DocH mod id)
DocBold (DocH mod id)
DocUnorderedList [DocH mod id]
DocOrderedList [(Int, DocH mod id)]
DocDefList [(DocH mod id, DocH mod id)]
DocCodeBlock (DocH mod id)
DocHyperlink (Hyperlink (DocH mod id))
DocPic Picture
DocMathInline String
DocMathDisplay String
DocAName String
A (HTML) anchor. It must not contain any spaces.
DocProperty String
DocExamples [Example]
DocHeader (Header (DocH mod id))
DocTable (Table (DocH mod id))

Instances8Bifoldable, Bifunctor, Bitraversable, Functor, Foldable, Traversable, …

Bifoldable DocHDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
NOTE: Only defined for base >= 4.10.0
Bifunctor DocHDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
NOTE: Only defined for base >= 4.8.0
Bitraversable DocHDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
NOTE: Only defined for base >= 4.10.0
Functor (DocH mod)Defined in haddock-library-1.11.0 · Documentation.Haddock.Types
Foldable (DocH mod)Defined in haddock-library-1.11.0 · Documentation.Haddock.Types
Traversable (DocH mod)Defined in haddock-library-1.11.0 · Documentation.Haddock.Types
(Eq id, Eq mod) => Eq (DocH mod id)Defined in haddock-library-1.11.0 · Documentation.Haddock.Types
(Show id, Show mod) => Show (DocH mod id)Defined in haddock-library-1.11.0 · Documentation.Haddock.Types

datadata Namespace

The namespace qualification for an identifier.

Value Type None

Instances4Enum, Eq, Ord, Show

Enum NamespaceDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Eq NamespaceDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Ord NamespaceDefined in haddock-library-1.11.0 · Documentation.Haddock.Types
Show NamespaceDefined in haddock-library-1.11.0 · Documentation.Haddock.Types

valuerenderNs :: Namespace -> String

Render the a namespace into the same format it was initially parsed.

datadata DocMarkupH mod id a

DocMarkupH is a set of instructions for marking up documentation. In fact, it's really just a mapping from Doc to some other type [a], where [a] is usually the type of the output (HTML, say). Use markup to apply a DocMarkupH to a DocH.

Constructors

Markup
- markupEmpty :: a
- markupString :: String -> a
- markupParagraph :: a -> a
- markupAppend :: a -> a -> a
- markupIdentifier :: id -> a
- markupIdentifierUnchecked :: mod -> a
- markupModule :: ModLink a -> a
- markupWarning :: a -> a
- markupEmphasis :: a -> a
- markupBold :: a -> a
- markupMonospaced :: a -> a
- markupUnorderedList :: [a] -> a
- markupOrderedList :: [(Int, a)] -> a
- markupDefList :: [(a, a)] -> a
- markupCodeBlock :: a -> a
- markupHyperlink :: Hyperlink a -> a
- markupAName :: String -> a
- markupPic :: Picture -> a
- markupMathInline :: String -> a
- markupMathDisplay :: String -> a
- markupProperty :: String -> a
- markupExample :: [Example] -> a
- markupHeader :: Header a -> a
- markupTable :: Table a -> a