haddock-library-1.4.3: 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 Source #

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

Eq Meta Source # 

Methods

(==) :: Meta -> Meta -> Bool #

(/=) :: Meta -> Meta -> Bool #

Show Meta Source # 

Methods

showsPrec :: Int -> Meta -> ShowS #

show :: Meta -> String #

showList :: [Meta] -> ShowS #

data MetaDoc mod id Source #

Constructors

MetaDoc 

Fields

Instances

Functor (MetaDoc mod) Source # 

Methods

fmap :: (a -> b) -> MetaDoc mod a -> MetaDoc mod b #

(<$) :: a -> MetaDoc mod b -> MetaDoc mod a #

Foldable (MetaDoc mod) Source # 

Methods

fold :: Monoid m => MetaDoc mod m -> m #

foldMap :: Monoid m => (a -> m) -> MetaDoc mod a -> m #

foldr :: (a -> b -> b) -> b -> MetaDoc mod a -> b #

foldr' :: (a -> b -> b) -> b -> MetaDoc mod a -> b #

foldl :: (b -> a -> b) -> b -> MetaDoc mod a -> b #

foldl' :: (b -> a -> b) -> b -> MetaDoc mod a -> b #

foldr1 :: (a -> a -> a) -> MetaDoc mod a -> a #

foldl1 :: (a -> a -> a) -> MetaDoc mod a -> a #

toList :: MetaDoc mod a -> [a] #

null :: MetaDoc mod a -> Bool #

length :: MetaDoc mod a -> Int #

elem :: Eq a => a -> MetaDoc mod a -> Bool #

maximum :: Ord a => MetaDoc mod a -> a #

minimum :: Ord a => MetaDoc mod a -> a #

sum :: Num a => MetaDoc mod a -> a #

product :: Num a => MetaDoc mod a -> a #

Traversable (MetaDoc mod) Source # 

Methods

traverse :: Applicative f => (a -> f b) -> MetaDoc mod a -> f (MetaDoc mod b) #

sequenceA :: Applicative f => MetaDoc mod (f a) -> f (MetaDoc mod a) #

mapM :: Monad m => (a -> m b) -> MetaDoc mod a -> m (MetaDoc mod b) #

sequence :: Monad m => MetaDoc mod (m a) -> m (MetaDoc mod a) #

(Eq id, Eq mod) => Eq (MetaDoc mod id) Source # 

Methods

(==) :: MetaDoc mod id -> MetaDoc mod id -> Bool #

(/=) :: MetaDoc mod id -> MetaDoc mod id -> Bool #

(Show id, Show mod) => Show (MetaDoc mod id) Source # 

Methods

showsPrec :: Int -> MetaDoc mod id -> ShowS #

show :: MetaDoc mod id -> String #

showList :: [MetaDoc mod id] -> ShowS #

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

type Version = [Int] Source #

data Header id Source #

Constructors

Header 

Fields

Instances

Functor Header Source # 

Methods

fmap :: (a -> b) -> Header a -> Header b #

(<$) :: a -> Header b -> Header a #

Foldable Header Source # 

Methods

fold :: Monoid m => Header m -> m #

foldMap :: Monoid m => (a -> m) -> Header a -> m #

foldr :: (a -> b -> b) -> b -> Header a -> b #

foldr' :: (a -> b -> b) -> b -> Header a -> b #

foldl :: (b -> a -> b) -> b -> Header a -> b #

foldl' :: (b -> a -> b) -> b -> Header a -> b #

foldr1 :: (a -> a -> a) -> Header a -> a #

foldl1 :: (a -> a -> a) -> Header a -> a #

toList :: Header a -> [a] #

null :: Header a -> Bool #

length :: Header a -> Int #

elem :: Eq a => a -> Header a -> Bool #

maximum :: Ord a => Header a -> a #

minimum :: Ord a => Header a -> a #

sum :: Num a => Header a -> a #

product :: Num a => Header a -> a #

Traversable Header Source # 

Methods

traverse :: Applicative f => (a -> f b) -> Header a -> f (Header b) #

sequenceA :: Applicative f => Header (f a) -> f (Header a) #

mapM :: Monad m => (a -> m b) -> Header a -> m (Header b) #

sequence :: Monad m => Header (m a) -> m (Header a) #

Eq id => Eq (Header id) Source # 

Methods

(==) :: Header id -> Header id -> Bool #

(/=) :: Header id -> Header id -> Bool #

Show id => Show (Header id) Source # 

Methods

showsPrec :: Int -> Header id -> ShowS #

show :: Header id -> String #

showList :: [Header id] -> ShowS #

data DocH mod id Source #

Instances

Functor (DocH mod) Source # 

Methods

fmap :: (a -> b) -> DocH mod a -> DocH mod b #

(<$) :: a -> DocH mod b -> DocH mod a #

Foldable (DocH mod) Source # 

Methods

fold :: Monoid m => DocH mod m -> m #

foldMap :: Monoid m => (a -> m) -> DocH mod a -> m #

foldr :: (a -> b -> b) -> b -> DocH mod a -> b #

foldr' :: (a -> b -> b) -> b -> DocH mod a -> b #

foldl :: (b -> a -> b) -> b -> DocH mod a -> b #

foldl' :: (b -> a -> b) -> b -> DocH mod a -> b #

foldr1 :: (a -> a -> a) -> DocH mod a -> a #

foldl1 :: (a -> a -> a) -> DocH mod a -> a #

toList :: DocH mod a -> [a] #

null :: DocH mod a -> Bool #

length :: DocH mod a -> Int #

elem :: Eq a => a -> DocH mod a -> Bool #

maximum :: Ord a => DocH mod a -> a #

minimum :: Ord a => DocH mod a -> a #

sum :: Num a => DocH mod a -> a #

product :: Num a => DocH mod a -> a #

Traversable (DocH mod) Source # 

Methods

traverse :: Applicative f => (a -> f b) -> DocH mod a -> f (DocH mod b) #

sequenceA :: Applicative f => DocH mod (f a) -> f (DocH mod a) #

mapM :: Monad m => (a -> m b) -> DocH mod a -> m (DocH mod b) #

sequence :: Monad m => DocH mod (m a) -> m (DocH mod a) #

(Eq id, Eq mod) => Eq (DocH mod id) Source # 

Methods

(==) :: DocH mod id -> DocH mod id -> Bool #

(/=) :: DocH mod id -> DocH mod id -> Bool #

(Show id, Show mod) => Show (DocH mod id) Source # 

Methods

showsPrec :: Int -> DocH mod id -> ShowS #

show :: DocH mod id -> String #

showList :: [DocH mod id] -> ShowS #