[[haddock @ 2003-11-06 16:50:28 by simonmar]
simonmar**20031106165028
Add -k/--package docs
] {
hunk ./doc/haddock.sgml 516
- or
+ or ).
+ This is used to generate a single index for multiple sets of
+ Haddock documentstation.
hunk ./doc/haddock.sgml 522
+
+ P
+ P
+
+
+
+
+ Set the package name for these modules to
+ P. In a combined index generated
+ with , the package name for each
+ module is shown in the right-hand column.
+
+
hunk ./doc/haddock.sgml 1223
+
+
+
+ Definition lists
+
+ Definition lists are written as follows:
+
+
+-- | This is a definition list:
+--
+-- [@foo@] The description of @foo@.
+--
+-- [@bar@] The description of @bar@.
+
+
+ To produce output something like this:
+
+
+
+ foo
+
+ The description of foo.
+
+
+
+ bar
+
+ The description of bar.
+
+
+
+
+ Each paragraph should be preceded by the
+ “definition term” enclosed in square brackets.
+ The square bracket characters have no special meaning outside
+ the beginning of a definition paragraph. That is, if a
+ paragraph begins with a [ character, then
+ it is assumed to be a definition paragraph, and the next
+ ] character found will close the definition
+ term. Other markup operators may be used freely within the
+ definition term.
}