haddock-library-1.2.1: 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
LanguageHaskell2010

Documentation.Haddock.Types

Description

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

Synopsis

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.

Constructors

Meta 

Instances

data MetaDoc mod id

Constructors

MetaDoc 

Fields

_meta :: Meta
 
_doc :: DocH mod id
 

Instances

Functor (MetaDoc mod) 
Foldable (MetaDoc mod) 
Traversable (MetaDoc mod) 
(Eq mod, Eq id) => Eq (MetaDoc mod id) 
(Show mod, Show id) => Show (MetaDoc mod id) 

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

type Version = [Int]

data Picture

Constructors

Picture 

Instances

data Header id

Constructors

Header 

Fields

headerLevel :: Int
 
headerTitle :: id
 

Instances

data Example

Constructors

Example 

Instances

data DocH mod id

Instances

Functor (DocH mod) 
Foldable (DocH mod) 
Traversable (DocH mod) 
(Eq mod, Eq id) => Eq (DocH mod id) 
(Show mod, Show id) => Show (DocH mod id)