aboutsummaryrefslogtreecommitdiff
path: root/src/Binary.hs
Commit message (Collapse)AuthorAgeFilesLines
* [haddock @ 2004-08-09 11:55:05 by simonmar]simonmar2004-08-091-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* [haddock @ 2004-08-09 11:03:04 by simonmar]simonmar2004-08-091-0/+69
| | | | | | Add FormatVersion Patch submitted by: George Russell <ger@informatik.uni-bremen.de>
* [haddock @ 2004-08-03 19:45:11 by sof]sof2004-08-031-0/+3
| | | | make it compile with <= ghc-6.1
* [haddock @ 2003-11-06 16:48:11 by simonmar]simonmar2003-11-061-0/+19
| | | | | | | | | - Include the OptHide setting in the interface, so we don't include hidden modules in the combined index/contents. - Add a -k/--package flag to set the package name for the current set of modules. The package name for each module is now shown in the right-hand column of the contents, in a combined contents page.
* [haddock @ 2003-07-28 16:40:45 by panne]panne2003-07-281-1/+1
| | | | Make it compile with GHC >= 6.01
* [haddock @ 2003-07-28 14:32:42 by simonmar]simonmar2003-07-281-22/+54
| | | | Update to avoid using hslibs with GHC >= 5.04
* [haddock @ 2003-01-16 15:07:57 by ross]ross2003-01-161-1/+1
| | | | Adjust for the new exception libraries (as well as the old ones).
* [haddock @ 2002-07-24 09:42:17 by simonmar]simonmar2002-07-241-37/+47
| | | | Patches to quieten ghc -Wall, from those nice folks at Galois.
* [haddock @ 2002-06-23 14:54:00 by panne]panne2002-06-231-3/+10
| | | | Make it compile with newer GHCs
* [haddock @ 2002-06-21 15:50:42 by simonmar]simonmar2002-06-211-0/+549
Add support for reading and writing interface files(!) This turned out to be quite easy, and necessary to get decent hyperlinks between the documentation for separate packages in the libraries. The functionality isn't quite complete yet: for a given package of modules, you'd like to say "the HTML for these modules lives in directory <dir>" (currently they are assumed to be all in the same place). Two new flags: --dump-interface=FILE dump an interface file in FILE --read-interface=FILE read interface from FILE an interface file describes *all* the modules being processed. Only the exported names are kept in the interface: if you re-export a name from a module in another interface the signature won't be copied. This is a compromise to keep the size of the interfaces sensible. Also, I added another useful option: --no-implicit-prelude avoids trying to import the Prelude. Previously this was the default, but now importing the Prelude from elsewhere makes sense if you also read in an interface containing the Prelude module, so Haddock imports the Prelude implicitly according to the Haskell spec.