haddock-2.0.0.0 Contents Index

Distribution.Haddock

Synopsis

readInterfaceFile :: Maybe Session -> FilePath -> IO (Either String InterfaceFile) data InterfaceFile = InterfaceFile { ifLinkEnv :: LinkEnv ifInstalledIfaces :: [InstalledInterface] } type LinkEnv = Map Name Name data InstalledInterface = InstalledInterface { instMod :: Module instInfo :: (HaddockModInfo Name) instDocMap :: (Map Name (HsDoc DocName)) instExports :: [Name] instVisibleExports :: [Name] }

Documentation

readInterfaceFile :: Maybe Session -> FilePath -> IO (Either String InterfaceFile)

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. The aim is to be compatible with interface files produced by any Haddock of version 2.0.0.0 or greater.

data InterfaceFile

Constructors InterfaceFile ifLinkEnv :: LinkEnv ifInstalledIfaces :: [InstalledInterface] Instances Binary InterfaceFile

type LinkEnv = Map Name Name

data InstalledInterface

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] Instances Binary InstalledInterface

Produced by Haddock version 0.8