| Copyright | (c) Trevis Elser 2023 |
|---|---|
| License | MIT |
| Maintainer | trevis@flipstone.com |
| Stability | experimental |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Pollock
Description
Synopsis
- processModule :: MonadIO m => TcGblEnv -> m ModuleInfo
- data ModuleHeader = ModuleHeader {}
- data ModuleInfo = ModuleInfo {
- moduleHeader :: !ModuleHeader
- haddockableExports :: !Int
- haddockedExports :: !Int
- numWithSince :: !Int
- numWithCodeBlock :: !Int
- numWithExample :: !Int
- numWithProperty :: !Int
- numWithWarning :: !Int
- ensureHaddockIsOn :: [a] -> HscEnv -> IO HscEnv
Documentation
processModule :: MonadIO m => TcGblEnv -> m ModuleInfo Source #
Read a module from a TcGblEnv to determine information about the Haddock as seen with
ModuleInfo.
Since: 0.1.0.0
data ModuleHeader Source #
Constructors
| ModuleHeader | |
Fields
| |
data ModuleInfo Source #
Constructors
| ModuleInfo | |
Fields
| |