HDocs.Haddock

Documentation functions

readInstalledDocsF :: DynFlags -> ExceptT String IO (Map String ModuleDocMap)

Read all installed docs

readInstalledDocs :: [String] -> ExceptT String IO (Map String ModuleDocMap)

Read all installed docs

readHaddock :: FilePath -> ExceptT String IO (Map String ModuleDocMap)

Read docs from .haddock file

readSources :: [String] -> [FilePath] -> ExceptT String IO (Map String ModuleDocMap)

Read docs for haskell modules

readSources_ :: [String] -> [FilePath] -> ExceptT String IO [(String, ModuleDocMap)]

Read docs for haskell modules

readSource :: [String] -> FilePath -> ExceptT String IO (String, ModuleDocMap)

Read docs for haskell module

readSourcesGhc :: [String] -> [FilePath] -> ExceptT String Ghc [(String, ModuleDocMap)]

Read docs for source in Ghc monad

readSourceGhc :: [String] -> FilePath -> ExceptT String Ghc (String, ModuleDocMap)

Read docs for haskell module

Extract docs

installedInterfaceDocs :: InstalledInterface -> (String, ModuleDocMap)

Get docs for InstalledInterface

installedInterfacesDocs :: [InstalledInterface] -> Map String ModuleDocMap

Get docs for InstalledInterfaces

interfaceDocs :: Interface -> (String, ModuleDocMap)

Get docs for Interface

Utility functions

haddockFilesF :: DynFlags -> ExceptT String IO [FilePath]

Get list of haddock files in package db

haddockFiles :: [String] -> ExceptT String IO [FilePath]

Get list of haddock files in package db

readInstalledInterfaces :: FilePath -> ExceptT String IO [InstalledInterface]

Read installed interface

readPackageInterfaces :: PackageConfig -> ExceptT String IO [InstalledInterface]

Read installed interfaces for package

lookupDoc :: String -> String -> Map String ModuleDocMap -> Maybe (Doc String)

Lookup doc

lookupNameDoc :: Name -> Map String ModuleDocMap -> Maybe (Doc String)

Lookup doc for Name

module HDocs.Base

data Ghc a

A minimal implementation of a GhcMonad. If you need a custom monad, e.g., to maintain additional state consider wrapping this monad or using GhcT.

Instances

Monad Ghc

Defined in GhcMonad

Methods

(>>=) :: Ghc a -> (a -> Ghc b) -> Ghc b

(>>) :: Ghc a -> Ghc b -> Ghc b

return :: a -> Ghc a

fail :: String -> Ghc a

Functor Ghc

Defined in GhcMonad

Methods

fmap :: (a -> b) -> Ghc a -> Ghc b

(<$) :: a -> Ghc b -> Ghc a

MonadFix Ghc

Defined in GhcMonad

Methods

mfix :: (a -> Ghc a) -> Ghc a

Applicative Ghc

Defined in GhcMonad

Methods

pure :: a -> Ghc a

(<*>) :: Ghc (a -> b) -> Ghc a -> Ghc b

liftA2 :: (a -> b -> c) -> Ghc a -> Ghc b -> Ghc c

(*>) :: Ghc a -> Ghc b -> Ghc b

(<*) :: Ghc a -> Ghc b -> Ghc a

MonadIO Ghc

Defined in GhcMonad

Methods

liftIO :: IO a -> Ghc a

GhcMonad Ghc

Defined in GhcMonad

Methods

getSession :: Ghc HscEnv

setSession :: HscEnv -> Ghc ()

HasDynFlags Ghc

Defined in GhcMonad

Methods

getDynFlags :: Ghc DynFlags

ExceptionMonad Ghc

Defined in GhcMonad

Methods

gcatch :: Exception e => Ghc a -> (e -> Ghc a) -> Ghc a

gmask :: ((Ghc a -> Ghc a) -> Ghc b) -> Ghc b

gbracket :: Ghc a -> (a -> Ghc b) -> (a -> Ghc c) -> Ghc c

gfinally :: Ghc a -> Ghc b -> Ghc a

module Control.Monad.Except

withGhc :: [Flag] -> Ghc a -> IO a