| Safe Haskell | None |
|---|
HDocs.Haddock
- readInstalledDocs :: [String] -> ErrorT String IO (Map String ModuleDocMap)
- readHaddock :: FilePath -> ErrorT String IO (Map String ModuleDocMap)
- readSource :: [String] -> FilePath -> ErrorT String IO (String, ModuleDocMap)
- installedInterfaceDocs :: InstalledInterface -> (String, ModuleDocMap)
- installedInterfacesDocs :: [InstalledInterface] -> Map String ModuleDocMap
- interfaceDocs :: Interface -> (String, ModuleDocMap)
- haddockFiles :: [String] -> ErrorT String IO [FilePath]
- readInstalledInterfaces :: FilePath -> ErrorT String IO [InstalledInterface]
- readPackageInterfaces :: PackageConfig -> ErrorT 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] -> ErrorT String IO (Map String ModuleDocMap)Source
Read all installed docs
readHaddock :: FilePath -> ErrorT String IO (Map String ModuleDocMap)Source
Read docs from .haddock file
readSource :: [String] -> FilePath -> ErrorT 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 ModuleDocMapSource
Get docs for InstalledInterfaces
interfaceDocs :: Interface -> (String, ModuleDocMap)Source
Get docs for Interface
Utility functions
haddockFiles :: [String] -> ErrorT String IO [FilePath]Source
Get list of haddock files in package db
readInstalledInterfaces :: FilePath -> ErrorT String IO [InstalledInterface]Source
Read installed interface
readPackageInterfaces :: PackageConfig -> ErrorT 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