haddock-library-1.0.0: Library exposing some functionality of Haddock.

Copyright(c) Simon Marlow 2003-2006, David Waern 2006-2009, Mateusz Kowalczyk 2013
LicenseBSD-like
Maintainerhaddock@projects.haskellorg
Stabilityexperimental
Portabilityportable
Safe HaskellSafe-Inferred
LanguageHaskell2010

Documentation.Haddock.Types

Description

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

Documentation

data Hyperlink Source

Constructors

Hyperlink 

Fields

hyperlinkUrl :: String
 
hyperlinkLabel :: Maybe String
 

data Picture Source

Constructors

Picture 

Fields

pictureUri :: String
 
pictureTitle :: Maybe String
 

Instances

data Header id Source

Constructors

Header 

Fields

headerLevel :: Int
 
headerTitle :: id
 

Instances

data Example Source

Constructors

Example 

Fields

exampleExpression :: String
 
exampleResult :: [String]
 

Instances

data DocH mod id Source

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)