Copyright | (c) Simon Marlow 2003-2006, David Waern 2006-2009, Mateusz Kowalczyk 2013 |
---|---|
License | BSD-like |
Maintainer | haddock@projects.haskellorg |
Stability | experimental |
Portability | portable |
Safe Haskell | Safe |
Language | Haskell2010 |
Documentation.Haddock.Types
Description
Exposes documentation data types used for (some) of Haddock.
- newtype Meta = Meta {}
- data MetaDoc mod id = MetaDoc {}
- overDoc :: (DocH a b -> DocH c d) -> MetaDoc a b -> MetaDoc c d
- type Version = [Int]
- data Hyperlink = Hyperlink {}
- data Picture = Picture {}
- data Header id = Header {
- headerLevel :: Int
- headerTitle :: id
- data Example = Example {}
- data DocH mod id
- = 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))
Documentation
newtype 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.
data MetaDoc mod id
data Picture
Constructors
Picture | |
Fields
|
data Header id
Constructors
Header | |
Fields
|
data Example
Constructors
Example | |
Fields
|
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)) |