aboutsummaryrefslogtreecommitdiff
Commit message (Collapse)AuthorAgeFilesLines
* [haddock @ 2002-05-08 13:37:25 by simonmar]simonmar2002-05-082-4/+17
| | | | | | | | | | Change the markup for typewriter-font from [...] to @...@. The reasoning is that the '@' symbol is much less likely to be needed than square brackets, and we don't want to have to escape square brackets in code fragments. This will be mildly painful in the short term, but it's better to get the change out of the way as early as possible.
* [haddock @ 2002-05-08 11:22:30 by simonmar]simonmar2002-05-083-0/+30
| | | | Update to test new features.
* [haddock @ 2002-05-08 11:21:56 by simonmar]simonmar2002-05-087-154/+268
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add a facility for specifying options that affect Haddock's treatment of the module. Options are given at the top of the module in a comma-separated list, beginning with '-- #'. eg. -- # prune, hide, ignore-exports Options currently available, with their meanings: prune: ignore declarations which have no documentation annotations ignore-exports: act as if the export list were not specified (i.e. export everything local to the module). hide: do not include this module in the generated documentation, but propagate any exported definitions to modules which re-export them. There's a slight change in the semantics for re-exporting a full module by giving 'module M' in the export list: if module M does not have the 'hide' option, then the documentation will now just contain a reference to module M rather than the full inlined contents of that module. These features, and some other changes in the pipeline, are the result of discussions between myself and Manuel Chakravarty <chak@cse.unsw.edu.au> (author of IDoc) yesterday. Also: some cleanups, use a Writer monad to collect error messages in some places instead of just printing them with trace.
* [haddock @ 2002-05-07 15:37:15 by simonmar]simonmar2002-05-072-3/+15
| | | | Allow code blocks to be denoted with bird-tracks in addition to [...].
* [haddock @ 2002-05-07 15:36:36 by simonmar]simonmar2002-05-071-0/+2
| | | | | DocEmpty is a right and left-unit of DocAppend (remove it in the smart constructor).
* [haddock @ 2002-05-06 13:32:32 by simonmar]simonmar2002-05-061-0/+2
| | | | Be more lenient about extra paragraph breaks
* [haddock @ 2002-05-06 13:02:42 by simonmar]simonmar2002-05-061-2/+7
| | | | Add another named chunk with a different name
* [haddock @ 2002-05-06 12:49:21 by simonmar]simonmar2002-05-061-2/+3
| | | | Fix silly bug in named documentation block lookup.
* [haddock @ 2002-05-06 12:32:32 by simonmar]simonmar2002-05-061-4/+8
| | | | Allow empty data declarations (another GHC extension).
* [haddock @ 2002-05-06 12:30:09 by simonmar]simonmar2002-05-061-3/+0
| | | | Remove workaround for simplifier bug in previous revision.
* [haddock @ 2002-05-06 12:29:26 by simonmar]simonmar2002-05-061-1/+2
| | | | | Add missing type signature (a different workaround for the bug in GHC's simplifier).
* [haddock @ 2002-05-06 09:51:10 by simonmar]simonmar2002-05-061-0/+79
| | | | Add RPM spec file (thanks to Tom Moertel <tom-rpms@moertel.com>)
* [haddock @ 2002-05-05 19:40:51 by panne]panne2002-05-051-1/+5
| | | | | | As a temporary hack/workaround for a bug in GHC's simplifier, don't pass Happy the -c option for generating the parsers in this subdir. Furthermore, disable -O for HaddocParse, too.
* [haddock @ 2002-05-03 08:50:00 by simonmar]simonmar2002-05-031-6/+6
| | | | Fix some typos.
* [haddock @ 2002-05-01 11:03:26 by simonmar]simonmar2002-05-011-0/+2
| | | | Add another item
* [haddock @ 2002-05-01 11:02:52 by simonmar]simonmar2002-05-011-8/+11
| | | | update
* [haddock @ 2002-04-29 15:57:30 by simonmar]simonmar2002-04-291-0/+2
| | | | Add BinDist bits
* [haddock @ 2002-04-29 15:56:39 by simonmar]simonmar2002-04-292-5/+8
| | | | Install the auxilliary bits
* [haddock @ 2002-04-29 15:56:19 by simonmar]simonmar2002-04-291-1/+1
| | | | Fix for 'make install'
* [haddock @ 2002-04-29 15:55:46 by simonmar]simonmar2002-04-291-2/+2
| | | | remove a trace
* [haddock @ 2002-04-29 15:37:48 by simonmar]simonmar2002-04-291-0/+143
| | | | Add an example
* [haddock @ 2002-04-29 15:37:32 by simonmar]simonmar2002-04-291-1/+1
| | | | syntax fix
* [haddock @ 2002-04-29 15:28:54 by simonmar]simonmar2002-04-293-22/+34
| | | | Allow '-- |' style annotations on constructors and record fields.
* [haddock @ 2002-04-29 15:28:12 by simonmar]simonmar2002-04-291-1/+1
| | | | bugfix for declBinders on a NewTypeDecl
* [haddock @ 2002-04-26 16:02:14 by simonmar]simonmar2002-04-261-0/+4
| | | | Add a couple of things I forgot about
* [haddock @ 2002-04-26 16:01:44 by simonmar]simonmar2002-04-261-74/+455
| | | | Yet more keyboard bashing - this is pretty much complete now.
* [haddock @ 2002-04-26 13:15:02 by simonmar]simonmar2002-04-262-14/+22
| | | | | | Move the explicit formatting of the little table for the stability/portability/maintainer info from the HTML into the CSS, and remove the explicit table size (just right-align it).
* [haddock @ 2002-04-26 11:18:56 by simonmar]simonmar2002-04-269-32/+72
| | | | | | | - support for fundeps (partially contributed by Brett Letner - thanks Brett). - make it build with GHC 4.08.2
* [haddock @ 2002-04-26 10:13:00 by simonmar]simonmar2002-04-261-0/+2
| | | | Include $(GHC_HAPPY_OPTS) when compiling HsParser
* [haddock @ 2002-04-26 08:43:33 by simonmar]simonmar2002-04-261-1/+1
| | | | Package util reqd. to compile with 4.08.2
* [haddock @ 2002-04-25 16:48:36 by simonmar]simonmar2002-04-251-10/+340
| | | | More keyboard bashing
* [haddock @ 2002-04-25 14:40:05 by simonmar]simonmar2002-04-2511-40/+103
| | | | | | | - Add support for named chunks of documentation which can be referenced from the export list. - Copy the icon from $libdir to the destination in HTML mode.
* [haddock @ 2002-04-25 14:20:12 by simonmar]simonmar2002-04-251-0/+0
| | | | Add the little lambda icon
* [haddock @ 2002-04-24 15:57:47 by simonmar]simonmar2002-04-242-14/+12
| | | | Handle gcons in export lists (a common extension).
* [haddock @ 2002-04-24 15:16:57 by simonmar]simonmar2002-04-241-2/+0
| | | | Done module headers now.
* [haddock @ 2002-04-24 15:14:11 by simonmar]simonmar2002-04-244-36/+78
| | | | | | | Grok the kind of module headers we use in fptools/libraries, and pass the "portability", "stability", and "maintainer" strings through into the generated HTML. If the module header doesn't match the pattern, then we don't include the info in the HTML.
* [haddock @ 2002-04-24 15:12:41 by simonmar]simonmar2002-04-241-3/+7
| | | | | Stop slurping comment lines when we see a row of dashes longer than length 2: these are useful as separators.
* [haddock @ 2002-04-11 13:40:30 by simonmar]simonmar2002-04-119-121/+276
| | | | | | | | | | | | | - copy haddock.css into the same place as the generated HTML - new option: --css <file> specifies the style sheet to use - new option: -o <dir> specifies the directory in which to generate the output. - because Haddock now needs to know where to find its default stylesheet, we have to have a wrapper script and do the haddock-inplace thing (Makefile code copied largely from fptools/happy).
* [haddock @ 2002-04-11 13:38:02 by simonmar]simonmar2002-04-111-2/+2
| | | | mention Opera
* [haddock @ 2002-04-10 16:38:03 by simonmar]simonmar2002-04-101-4/+5
| | | | update again
* [haddock @ 2002-04-10 16:28:05 by simonmar]simonmar2002-04-102-3/+13
| | | | | | Parse errors in doc strings are now reported as warnings rather that causing the whole thing to fall over. It still needs cleaning up (the warning is emitted with trace) but this will do for the time being.
* [haddock @ 2002-04-10 16:10:49 by simonmar]simonmar2002-04-101-6/+12
| | | | more updates
* [haddock @ 2002-04-10 16:10:26 by simonmar]simonmar2002-04-102-2/+5
| | | | | Now we understand (or at least don't barf on) type signatures in patterns such as you might find when scoped type variables are in use.
* [haddock @ 2002-04-10 15:50:10 by simonmar]simonmar2002-04-104-11/+51
| | | | | Generate a little table of contents at the top of the module doc (only if the module actually contains some section headings, though).
* [haddock @ 2002-04-10 14:59:51 by simonmar]simonmar2002-04-101-1/+2
| | | | Sort the module tree
* [haddock @ 2002-04-10 14:30:58 by simonmar]simonmar2002-04-101-2/+148
| | | | Add an introduction
* [haddock @ 2002-04-10 13:37:23 by simonmar]simonmar2002-04-101-14/+19
| | | | Update the TODO list, separate into pre-1.0 and post-1.0 items
* [haddock @ 2002-04-10 13:32:39 by simonmar]simonmar2002-04-102-0/+32
| | | | Skeleton documentation
* [haddock @ 2002-04-10 13:26:09 by simonmar]simonmar2002-04-103-139/+330
| | | | | | | | | Lots of changes, including: - add index support to the HTML backend - clean up the renamer, put it into a monad - propogate unresolved names to the top level and report them in a nicer way - various bugfixes
* [haddock @ 2002-04-10 13:23:55 by simonmar]simonmar2002-04-101-2/+2
| | | | | Not sure why I made the constructor name for a record declaration into a TyCls name, but change it back into a Var name anyhow.