HDocs.Module

Types

type ModuleDocMap = Map String (Doc String)

Documentations in module

type DocsM a = ErrorT String (StateT (Map String ModuleDocMap) IO) a

Docs state

runDocsM :: DocsM a -> IO (Either String a)

Run docs monad

Helpers

withInitializedPackages :: (DynFlags -> IO a) -> IO a

configSession :: [String] -> IO DynFlags

moduleInterface :: DynFlags -> ModuleName -> IO [(PackageConfig, InstalledInterface)]

Load installed interface

packageInterface :: DynFlags -> ModuleName -> PackageConfig -> IO [InstalledInterface]

formatDoc :: Doc String -> String

Format documentation to plain text.

Get module docs

moduleDocs :: [String] -> String -> DocsM ModuleDocMap

Load module documentation

fileDocs :: [String] -> FilePath -> DocsM ModuleDocMap

Load file documentation

docs :: [String] -> String -> DocsM ModuleDocMap

Load docs for file or module