HDocs.Haddock

Documentation functions

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

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

Functor Ghc

MonadFix Ghc

Applicative Ghc

GhcMonad Ghc

HasDynFlags Ghc

ExceptionMonad Ghc

MonadIO Ghc

module Control.Monad.Except

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