haddock-2.2.0: A documentation-generation tool for Haskell librariesSource codeContentsIndex
Distribution.Haddock
Synopsis
readInterfaceFile :: Maybe Session -> FilePath -> IO (Either String InterfaceFile)
data InterfaceFile = InterfaceFile {
ifLinkEnv :: LinkEnv
ifInstalledIfaces :: [InstalledInterface]
}
type LinkEnv = Map Name Module
data InstalledInterface = InstalledInterface {
instMod :: Module
instInfo :: HaddockModInfo Name
instDocMap :: Map Name (HsDoc DocName)
instExports :: [Name]
instVisibleExports :: [Name]
}
data DocName
= Documented Name Module
| Undocumented Name
Documentation
readInterfaceFile :: Maybe Session -> FilePath -> IO (Either String InterfaceFile)Source
Read a Haddock (.haddock) interface file. Return either an InterfaceFile or an error message. If given a GHC Session, the function registers all read names in the name cache of the session.
data InterfaceFile Source
Constructors
InterfaceFile
ifLinkEnv :: LinkEnv
ifInstalledIfaces :: [InstalledInterface]
show/hide Instances
type LinkEnv = Map Name ModuleSource
data InstalledInterface Source
A smaller version of Interface that we can get from the Haddock interface files.
Constructors
InstalledInterface
instMod :: Module
instInfo :: HaddockModInfo Name
instDocMap :: Map Name (HsDoc DocName)
instExports :: [Name]
instVisibleExports :: [Name]
show/hide Instances
data DocName Source
Constructors
Documented Name Module
Undocumented Name
show/hide Instances
Binary DocName
Produced by Haddock version 2.3.0