aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsimonmar <unknown>2005-02-23 15:57:12 +0000
committersimonmar <unknown>2005-02-23 15:57:12 +0000
commit26bfb19c803e78d5a3d1cf4d169d47dfda5d1189 (patch)
tree24beda760c0a6f387c87deb0c83131383e2997ad
parent26b8ddf7c308a8d0e0ff93c64710196f2966bb3a (diff)
[haddock @ 2005-02-23 15:57:12 by simonmar]
Fix documentation regarding the module attributes.
-rw-r--r--doc/haddock.xml8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/haddock.xml b/doc/haddock.xml
index b4464720..f9dbb1ff 100644
--- a/doc/haddock.xml
+++ b/doc/haddock.xml
@@ -1183,11 +1183,19 @@ import B
<programlisting>
-- #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 following attributes are currently understood by
Haddock:</para>