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

# 3.3. The module description

A module may contain a documentation comment before the module header, in which case this comment is interpreted by Haddock as an overall description of the module itself, and placed in a section entitled "Description" in the documentation for the module. For example:

    -- | This is the description for module "Foo"
    module Foo where
    ...

Prev | Home | Next
Documenting parts of a declaration | Up | Controlling the documentation structure