haddock

Portabilityportable
Stabilityexperimental
Maintainerhaddock@projects.haskell.org
Safe HaskellSafe-Infered

Haddock.Utils

Contents

Description

 

Synopsis

Misc utilities

toDescription :: Interface -> Maybe (Doc Name)

Extract a module's short description.

toInstalledDescription :: InstalledInterface -> Maybe (Doc Name)

Extract a module's short description.

Filename utilities

frameIndexHtmlFile :: String

The name of the module index file to be displayed inside a frame. Modules are display in full, but without indentation. Clicking opens in the main window.

Anchor and URL utilities

makeAnchorId :: String -> String

Takes an arbitrary string and makes it a valid anchor ID. The mapping is identity preserving.

Miscellaneous utilities

bye :: String -> IO a

die :: String -> IO a

dieMsg :: String -> IO a

mapSnd :: (b -> c) -> [(a, b)] -> [(a, c)]

mapMaybeM :: Monad m => (a -> m b) -> Maybe a -> m (Maybe b)

HTML cross reference mapping

Doc markup

markup :: DocMarkup id a -> Doc id -> a

idMarkup :: DocMarkup a (Doc a)

The identity markup

List utilities

replace :: Eq a => a -> a -> [a] -> [a]

spanWith :: (a -> Maybe b) -> [a] -> ([b], [a])

MTL stuff

class Monad m => MonadIO m where

Methods

liftIO :: IO a -> m a

Instances

Logging

out

Arguments

:: MonadIO m 
=> Verbosity

program verbosity

-> Verbosity

message verbosity

-> String 
-> m () 

Print a message to stdout, if it is not too verbose

System tools