| Safe Haskell | None |
|---|---|
| Language | Haskell98 |
HDocs.Haddock
- readInstalledDocs :: [String] -> ExceptT String IO (Map String ModuleDocMap)
- readHaddock :: FilePath -> ExceptT String IO (Map String ModuleDocMap)
- readSource :: [String] -> FilePath -> ExceptT String IO (String, ModuleDocMap)
- installedInterfaceDocs :: InstalledInterface -> (String, ModuleDocMap)
- installedInterfacesDocs :: [InstalledInterface] -> Map String ModuleDocMap
- interfaceDocs :: Interface -> (String, ModuleDocMap)
- 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
Documentation functions
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
readSource :: [String] -> FilePath -> ExceptT String IO (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 InstalledInterfaces
interfaceDocs :: Interface -> (String, ModuleDocMap) Source
Get docs for Interface
Utility functions
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