aboutsummaryrefslogtreecommitdiff
path: root/src/HaddockHH.hs
diff options
context:
space:
mode:
authorsimonmar <unknown>2004-08-09 11:55:07 +0000
committersimonmar <unknown>2004-08-09 11:55:07 +0000
commitaf7f8c0379dc19ee831e25b64c9e94e733f331be (patch)
tree61060c13326cbd1055272acd1030a28f8c97c14b /src/HaddockHH.hs
parent97c3579a60e07866c9efaaa11d4b915424a43868 (diff)
[haddock @ 2004-08-09 11:55:05 by simonmar]
Add support for a short description for each module, which is included in the contents. The short description should be given in a "Description: " field of the header. Included in this patch are changes that make the format of the header a little more flexible. From the comments: -- all fields in the header are optional and have the form -- -- [spaces1][field name][spaces] ":" -- [text]"\n" ([spaces2][space][text]"\n" | [spaces]"\n")* -- where each [spaces2] should have [spaces1] as a prefix. -- -- Thus for the key "Description", -- -- > Description : this is a -- > rather long -- > -- > description -- > -- > The module comment starts here -- -- the value will be "this is a .. description" and the rest will begin -- at "The module comment". The header fields must be in the following order: Module, Description, Copyright, License, Maintainer, Stability, Portability. Patches submitted by: George Russell <ger@informatik.uni-bremen.de>, with a few small changes be me, mostly to merge with other recent changes. ToDo: document the module header.
Diffstat (limited to 'src/HaddockHH.hs')
-rw-r--r--src/HaddockHH.hs4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/HaddockHH.hs b/src/HaddockHH.hs
index e0e9a97a..8ad4dfe2 100644
--- a/src/HaddockHH.hs
+++ b/src/HaddockHH.hs
@@ -57,9 +57,9 @@ ppHHContents odir doctitle maybe_package tree = do
fn _ [] = error "HaddockHH.ppHHContents.fn: no module trees given"
ppNode :: [String] -> ModuleTree -> Doc
- ppNode ss (Node s leaf _pkg []) =
+ ppNode ss (Node s leaf _pkg _ []) =
ppLeaf s ss leaf
- ppNode ss (Node s leaf _pkg ts) =
+ ppNode ss (Node s leaf _pkg _ ts) =
ppLeaf s ss leaf $$
text "<UL>" $+$
nest 4 (fn (s:ss) ts) $+$