simonmar 2004/08/09 04:55:09 PDT
Modified files:
haddock/src Binary.hs HaddockHH.hs HaddockHtml.hs
HaddockModuleTree.hs HaddockTypes.hs
HaddockUtil.hs HsParser.ly HsSyn.lhs
Main.hs
Log:
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 <[EMAIL PROTECTED]>,
with a few small changes be me, mostly to merge with other recent
changes.
ToDo: document the module header.
Revision Changes Path
1.10 +4 -4 fptools/haddock/src/Binary.hs
1.12 +2 -2 fptools/haddock/src/HaddockHH.hs
1.88 +31 -16 fptools/haddock/src/HaddockHtml.hs
1.5 +16 -15 fptools/haddock/src/HaddockModuleTree.hs
1.19 +1 -1 fptools/haddock/src/HaddockTypes.hs
1.26 +191 -41 fptools/haddock/src/HaddockUtil.hs
1.21 +14 -10 fptools/haddock/src/HsParser.ly
1.22 +18 -6 fptools/haddock/src/HsSyn.lhs
1.71 +107 -36 fptools/haddock/src/Main.hs
_______________________________________________
Cvs-fptools mailing list
[EMAIL PROTECTED]
http://www.haskell.org/mailman/listinfo/cvs-fptools
