Pollock

Description

Synopsis

Documentation

Constructors

Fields

description :: !(Maybe String)
The description field of the Haddock module header.
copyright :: !(Maybe String)
The copyright field of the Haddock module header.
license :: !(Maybe String)
The license field of the Haddock module header.
maintainer :: !(Maybe String)
The maintainer field of the Haddock module header.
stability :: !(Maybe String)
The stability field of the Haddock module header.
portability :: !(Maybe String)
The portability field of the Haddock module header.

Constructors

Fields

moduleHeader :: !ModuleHeader
The haddock module header
haddockableExports :: !Int
How many exported items that could have documentation attached.
haddockedExports :: !Int
How many exported items that do have haddock attached.
numWithSince :: !Int
How many exported items have a since annotation.
numWithCodeBlock :: !Int
How many exported items have a code block included in the documentation.
numWithExample :: !Int
How many exported items have an example included in the documentation.
numWithProperty :: !Int
How many exported items have a property included in the documentation.
numWithWarning :: !Int
How many exported items have a warning attached to them.

A helper suitable for use to set as driverPlugin that ensures the Haddock option is set to allow other funcationality provided here to work.