aboutsummaryrefslogtreecommitdiff
path: root/doc/haddock.xml
diff options
context:
space:
mode:
authorDavid Waern <davve@dtek.chalmers.se>2008-01-07 16:48:40 +0000
committerDavid Waern <davve@dtek.chalmers.se>2008-01-07 16:48:40 +0000
commitd21b66c756cb0b69b7268685bae8991725e64c80 (patch)
treec74b6661a086ac2664c5a662fb20117174e40260 /doc/haddock.xml
parentd7f62d19a48aa70aba834eb0893fed5de6c118e6 (diff)
Document OPTIONS_HADDOCK
Diffstat (limited to 'doc/haddock.xml')
-rw-r--r--doc/haddock.xml14
1 files changed, 4 insertions, 10 deletions
diff --git a/doc/haddock.xml b/doc/haddock.xml
index ba3cb3e0..661457e6 100644
--- a/doc/haddock.xml
+++ b/doc/haddock.xml
@@ -1285,26 +1285,20 @@ import B
<para>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
- <literal>-- #</literal> (or
- <literal>{-&nbsp;#&nbsp;...&nbsp;-}</literal>) comment at the
+ module. Attributes are specified in a comma-separated list in an
+ <literal>{-# OPTIONS_HADDOCK ... #-}</literal> pragma at the
top of the module, either before or after the module
description. For example:</para>
<programlisting>
--- #hide, prune, ignore-exports
+{-# OPTIONS_HADDOCK hide, prune, ignore-exports #-}
-- |Module description
module A where
...
</programlisting>
- <para>The options and module description can be in either order, but
- remember to separate them using a blank line if you are using the
- <literal>--</literal> style comments. Without the blank line in the
- example above, the module description would be assumed to be part of
- the options, and Haddock would complain about unrecognised
- options.</para>
+ <para>The options and module description can be in either order.</para>
<para>The following attributes are currently understood by
Haddock:</para>