Haddock module description

Christian Maeder maeder@tzi.de
Wed, 04 Jun 2003 16:51:27 +0200


Simon Marlow wrote:
> Haddock understands the style of module header that we're using for the
> hierarchical libraries.  The module header is described in this document
> (see the section Reference Libraries->Coding Style->Module Header):
> 
> http://www.haskell.org/hierarchical-modules/libraries/libraries.html

> 4.9. Coding style
> 4.9.1. Standard module header

> -- |
> -- Module      :  module

> module
> 
>     is the fully qualified module name of the module

This haddock "Module" entry is annoying, since is may become 
inconsistent with the actual module name (following the Haskell keyword 
"module").

In fact I use:

-- Module      :  $Header$

Cheers Christian