haddock-2.1.0: A documentation-generation tool for Haskell libraries Contents Index

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)

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

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

type LinkEnv = Map Name Module

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

data DocName

Constructors Documented Name Module Undocumented Name Instances Binary DocName

Produced by Haddock version 2.1.0