aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsimonmar <unknown>2003-11-06 16:50:28 +0000
committersimonmar <unknown>2003-11-06 16:50:28 +0000
commit7d71718bc6fb36457396e1e6e21533e083987fa4 (patch)
tree7c8898dc2fb5b625d6f9209f1ae69cc4e72637c5
parentdb6d762f755e94540ce1d42e03c4fde8f26cb4c2 (diff)
[haddock @ 2003-11-06 16:50:28 by simonmar]
Add -k/--package docs
-rw-r--r--doc/haddock.sgml60
1 files changed, 57 insertions, 3 deletions
diff --git a/doc/haddock.sgml b/doc/haddock.sgml
index ed65801a..7d76bcd8 100644
--- a/doc/haddock.sgml
+++ b/doc/haddock.sgml
@@ -513,12 +513,25 @@
<listitem>
<para>Generate an HTML index containing entries pulled from
all the specified interfaces (interfaces are specified using
- <option>-i</option> or <option>--read-interface). This is
- used to generate a single index for multiple sets of Haddock
- documentstation.</option>
+ <option>-i</option> or <option>--read-interface</option>).
+ This is used to generate a single index for multiple sets of
+ Haddock documentstation.</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><option>-k</option> <replaceable>P</replaceable></term>
+ <term><option>--package=</option><replaceable>P</replaceable></term>
+ <indexterm><primary><option>-k</option></primary>
+ </indexterm>
+ <indexterm><primary><option>--package</option></primary></indexterm>
+ <listitem>
+ <para>Set the package name for these modules to
+ <replaceable>P</replaceable>. In a combined index generated
+ with <option>--gen-index</option>, the package name for each
+ module is shown in the right-hand column.</para>
+ </listitem>
+ </varlistentry>
</variablelist>
</chapter>
@@ -1210,6 +1223,47 @@ module A where
</section>
<section>
+ <title>Definition lists</title>
+
+ <para>Definition lists are written as follows:</para>
+
+<programlisting>
+-- | This is a definition list:
+--
+-- [@foo@] The description of @foo@.
+--
+-- [@bar@] The description of @bar@.
+</programlisting>
+
+ <para>To produce output something like this:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><literal>foo</literal></term>
+ <listitem>
+ <para>The description of <literal>foo</literal>.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>bar</literal></term>
+ <listitem>
+ <para>The description of <literal>bar</literal>.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>Each paragraph should be preceded by the
+ &ldquo;definition term&rdquo; 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 <literal>[</literal> character, then
+ it is assumed to be a definition paragraph, and the next
+ <literal>]</literal> character found will close the definition
+ term. Other markup operators may be used freely within the
+ definition term.</para>
+ </section>
+
+ <section>
<title>URLs</title>
<para>A URL can be included in a documentation comment by