Haddock User Guide
Prev | Chapter 3. Documentation and Markup | Next

# 3.7. Module Attributes

Certain attributes may be specified for each module which affects the way that Haddock generates documentation for that module. Attributes are specified in a comma-separated list in a `-- #` (or `{- # ... -}`) comment at the top of the module, either before or after the module description. For example:

    -- #hide, prune, ignore-exports
    -- |Module description
    module A where
    ...

The following attributes are currently understood by Haddock:

`hide`

  Omit this module from the generated documentation, but nevertheless propagate definitions and documentation from within this module to modules that re-export those definitions.

`prune`

  Omit definitions that have no documentation annotations from the generated documentation.

`ignore-exports`

  Ignore the export list. Generate documentation as if the module had no export list - i.e. all the top-level declarations are exported, and section headings may be given in the body of the module.

Prev | Home | Next
Hyperlinking and re-exported entities | Up | Markup