Safe Haskell | None |
---|---|
Language | Haskell98 |
Synopsis
- readInstalledDocsF :: DynFlags -> ExceptT String IO (Map String ModuleDocMap)
- readInstalledDocs :: [String] -> ExceptT String IO (Map String ModuleDocMap)
- readHaddock :: FilePath -> ExceptT String IO (Map String ModuleDocMap)
- readSources :: [String] -> [FilePath] -> ExceptT String IO (Map String ModuleDocMap)
- readSources_ :: [String] -> [FilePath] -> ExceptT String IO [(String, ModuleDocMap)]
- readSource :: [String] -> FilePath -> ExceptT String IO (String, ModuleDocMap)
- readSourcesGhc :: [String] -> [FilePath] -> ExceptT String Ghc [(String, ModuleDocMap)]
- readSourceGhc :: [String] -> FilePath -> ExceptT String Ghc (String, ModuleDocMap)
- installedInterfaceDocs :: InstalledInterface -> (String, ModuleDocMap)
- installedInterfacesDocs :: [InstalledInterface] -> Map String ModuleDocMap
- interfaceDocs :: Interface -> (String, ModuleDocMap)
- haddockFilesF :: DynFlags -> ExceptT String IO [FilePath]
- haddockFiles :: [String] -> ExceptT String IO [FilePath]
- readInstalledInterfaces :: FilePath -> ExceptT String IO [InstalledInterface]
- readPackageInterfaces :: PackageConfig -> ExceptT String IO [InstalledInterface]
- lookupDoc :: String -> String -> Map String ModuleDocMap -> Maybe (Doc String)
- lookupNameDoc :: Name -> Map String ModuleDocMap -> Maybe (Doc String)
- module HDocs.Base
- data Ghc a
- module Control.Monad.Except
- withGhc :: [Flag] -> Ghc a -> IO a
Documentation functions
readInstalledDocsF :: DynFlags -> ExceptT String IO (Map String ModuleDocMap) Source #
Read all installed docs
readInstalledDocs :: [String] -> ExceptT String IO (Map String ModuleDocMap) Source #
Read all installed docs
readHaddock :: FilePath -> ExceptT String IO (Map String ModuleDocMap) Source #
Read docs from .haddock file
readSources :: [String] -> [FilePath] -> ExceptT String IO (Map String ModuleDocMap) Source #
Read docs for haskell modules
readSources_ :: [String] -> [FilePath] -> ExceptT String IO [(String, ModuleDocMap)] Source #
Read docs for haskell modules
readSource :: [String] -> FilePath -> ExceptT String IO (String, ModuleDocMap) Source #
Read docs for haskell module
readSourcesGhc :: [String] -> [FilePath] -> ExceptT String Ghc [(String, ModuleDocMap)] Source #
Read docs for source in Ghc monad
readSourceGhc :: [String] -> FilePath -> ExceptT String Ghc (String, ModuleDocMap) Source #
Read docs for haskell module
Extract docs
installedInterfaceDocs :: InstalledInterface -> (String, ModuleDocMap) Source #
Get docs for InstalledInterface
installedInterfacesDocs :: [InstalledInterface] -> Map String ModuleDocMap Source #
Get docs for InstalledInterface
s
interfaceDocs :: Interface -> (String, ModuleDocMap) Source #
Get docs for Interface
Utility functions
haddockFilesF :: DynFlags -> ExceptT String IO [FilePath] Source #
Get list of haddock files in package db
haddockFiles :: [String] -> ExceptT String IO [FilePath] Source #
Get list of haddock files in package db
readInstalledInterfaces :: FilePath -> ExceptT String IO [InstalledInterface] Source #
Read installed interface
readPackageInterfaces :: PackageConfig -> ExceptT String IO [InstalledInterface] Source #
Read installed interfaces for package
lookupNameDoc :: Name -> Map String ModuleDocMap -> Maybe (Doc String) Source #
Lookup doc for Name
module HDocs.Base
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 | |
MonadIO Ghc | |
GhcMonad Ghc | |
Defined in GhcMonad getSession :: Ghc HscEnv # setSession :: HscEnv -> Ghc () # | |
HasDynFlags Ghc | |
Defined in GhcMonad getDynFlags :: Ghc DynFlags # | |
ExceptionMonad Ghc | |
module Control.Monad.Except