Read a Haddock (.haddock) interface file. Return either an
InterfaceFile or an error message.
This function can be called in two ways. Within a GHC session it will
update the use and update the session's name cache. Outside a GHC session
a new empty name cache is used. The function is therefore generic in the
monad being used. The exact monad is whichever monad the first
argument, the getter and setter of the name cache, requires.
|data InstalledInterface ||Source|
|A smaller version of Interface that we can get from the Haddock
|instMod :: Module||The module represented by this interface
|instInfo :: HaddockModInfo Name||Textual information about the module
|instDocMap :: Map Name (HsDoc DocName)||Everything declared in the module (including subordinates) that has docs
|instExports :: [Name]||All names exported by this module
|instVisibleExports :: [Name]|
All the visible names exported by this module
For a name to be visible, it has to:
- be exported normally, and not via a full module re-exportation.
- have a declaration in this module or any of it's imports, with the
exception that it can't be from another package.
Basically, a visible name is a name that will show up in the documentation
for this module.
|instOptions :: [DocOption]||The Haddock options for this module (prune, ignore-exports, etc)
|instSubMap :: Map Name [Name]|
|A DocName is an identifier that may be documented. The Module
component specifies the place which we want to link to in the documentation.
|The OccName belonging to this name
|Produced by Haddock version 2.4.2|