From 7d71718bc6fb36457396e1e6e21533e083987fa4 Mon Sep 17 00:00:00 2001 From: simonmar Date: Thu, 6 Nov 2003 16:50:28 +0000 Subject: [haddock @ 2003-11-06 16:50:28 by simonmar] Add -k/--package docs --- doc/haddock.sgml | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file 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 @@ Generate an HTML index containing entries pulled from all the specified interfaces (interfaces are specified using - or + or ). + This is used to generate a single index for multiple sets of + Haddock documentstation. + + 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. + + @@ -1209,6 +1222,47 @@ module A where +
+ 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. +
+
URLs -- cgit v1.2.3