aboutsummaryrefslogtreecommitdiff
path: root/src
Commit message (Collapse)AuthorAgeFilesLines
* [haddock @ 2003-05-06 10:04:47 by simonmar]simonmar2003-05-061-1/+4
| | | | | Catch another case of a paragraph containing just a DocMonospaced that should turn into a DocCodeBlock.
* [haddock @ 2003-04-30 14:02:32 by simonmar]simonmar2003-04-301-1/+9
| | | | | | | | When installing on Windows, run cygpath over $(HADDOCKLIB) so that haddock (a mingw program, built by GHC) can understand it. You still need to be in a cygwin environment to run Haddock, because of the shell script wrapper.
* [haddock @ 2003-04-25 10:50:05 by ross]ross2003-04-252-3/+80
| | | | | | | | | | | | | | | | | | | | | | | | | | | | An 80% solution to generating derived instances. A complete solution would duplicate the instance inference logic, but if a type variable occurs as a constructor argument, then we can just propagate the derived class to the variable. But we know nothing of the constraints on any type variables that occur elsewhere. For example, the declarations data Either a b = Left a | Right b deriving (Eq, Ord) data Ptr a = Ptr Addr# deriving (Eq, Ord) newtype IORef a = IORef (STRef RealWorld a) deriving Eq yield the instances (Eq a, Eq b) => Eq (Either a b) (Ord a, Ord b) => Ord (Either a b) Eq (Ptr a) Ord (Ptr a) (??? a) => Eq (IORef a) The last example shows the limits of this local analysis. Note that a type variable may be in both categories: then we know a constraint, but there may be more, or a stronger constraint, e.g. data Tree a = Node a [Tree a] deriving Eq yields (Eq a, ??? a) => Eq (Tree a)
* [haddock @ 2003-03-10 21:34:24 by panne]panne2003-03-102-18/+29
| | | | Escape fragments. This fixes e.g. links to operators.
* [haddock @ 2003-03-09 21:13:43 by panne]panne2003-03-091-7/+10
| | | | | Don't append a fragment to non-defining index entries, only documents with a defining occurrence have a name anchor.
* [haddock @ 2003-03-08 19:02:38 by panne]panne2003-03-081-1/+1
| | | | | Fixed some broken/redirected/canonicalized links found by a very picky link checker.
* [haddock @ 2003-02-24 21:26:29 by panne]panne2003-02-241-2/+4
| | | | | | | | Don't convert a "newtype" to a single-constructor "data" for non-abstractly exported types, they are quite different regarding strictness/pattern matching. Now a "data" without any constructors is only emitted for an abstractly exported type, regardless if it is actually a "newtype" or a "data".
* [haddock @ 2003-02-20 21:31:40 by panne]panne2003-02-201-8/+14
| | | | | * Add varsyms and consyms to index * Exclude empty entries from index
* [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-11-13 09:49:46 by simonmar]simonmar2002-11-131-1/+1
| | | | Small bugfix in the --read-interface option parsing from Brett Letner.
* [haddock @ 2002-11-11 09:32:57 by simonmar]simonmar2002-11-111-2/+2
| | | | Fix cut-n-pasto
* [haddock @ 2002-08-02 09:25:20 by simonmar]simonmar2002-08-022-11/+29
| | | | | | | Remove <P>..</P> from around list items, to reduce excess whitespace between the items of bulleted and ordered lists. (Suggestion from Daan Leijen).
* [haddock @ 2002-07-25 14:37:28 by simonmar]simonmar2002-07-255-8/+18
| | | | | | | | | | | | | | | | Patch to allow simple hyperlinking to an arbitrary location in another module's documentation, from Volker Stolz. Now in a doc comment: #foo# creates <a name="foo"></a> And you can use the form "M\#foo" to hyperlink to the label 'foo' in module 'M'. Note that the backslash is necessary for now.
* [haddock @ 2002-07-24 09:42:17 by simonmar]simonmar2002-07-2417-653/+871
| | | | Patches to quieten ghc -Wall, from those nice folks at Galois.
* [haddock @ 2002-07-24 09:28:19 by simonmar]simonmar2002-07-241-25/+25
| | | | Remove ^Ms
* [haddock @ 2002-07-23 10:18:46 by simonmar]simonmar2002-07-231-12/+23
| | | | Add a version banner when invoked with -v
* [haddock @ 2002-07-19 10:00:16 by simonmar]simonmar2002-07-191-14/+16
| | | | | | | | | | | | Relax the restrictions which require doc comments to be followed by semi colons - in some cases this isn't necessary. Now you can write module M where { -- | some doc class C where {} } without needing to put a semicolon before the class declaration.
* [haddock @ 2002-07-19 09:59:02 by simonmar]simonmar2002-07-192-11/+17
| | | | Allow special id's ([], (), etc.) to be used in an import declarations.
* [haddock @ 2002-07-19 09:13:10 by simonmar]simonmar2002-07-191-16/+22
| | | | Allow special id's ([], (), etc.) to be used in an import declaration.
* [haddock @ 2002-07-15 16:16:50 by simonmar]simonmar2002-07-151-5/+7
| | | | | | | | Allow multiple sections/subsections before and after a comma in the export list. Also at the same time I made the syntax a little stricter (multiple commas now aren't allowed between export specs).
* [haddock @ 2002-07-15 10:14:30 by simonmar]simonmar2002-07-152-10/+32
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Be a bit more liberal in the kind of commenting styles we allow, as suggested by Malcolm Wallace. Mostly this consists of allowing doc comments either side of a separator token. In an export list, a section heading is now allowed before the comma, as well as after it. eg. module M where ( T(..) -- * a section heading , f -- * another section heading , g ) In record fields, doc comments are allowed anywhere (previously a doc-next was allowed only after the comma, and a doc-before was allowed only before the comma). eg. data R = C { -- | describes 'f' f :: Int -- | describes 'g' , g :: Int }
* [haddock @ 2002-07-15 09:54:16 by simonmar]simonmar2002-07-151-17/+12
| | | | merge rev. 1.35
* [haddock @ 2002-07-15 09:19:38 by simonmar]simonmar2002-07-151-6/+7
| | | | | | | Fix a bug in mkExportItems when processing a module without an explicit export list. We were placing one copy of a declaration for each binder in the declaration, which for a data type would mean one copy of the whole declaration per constructor or record selector.
* [haddock @ 2002-07-10 10:58:31 by simonmar]simonmar2002-07-101-5/+5
| | | | Sort the options a bit
* [haddock @ 2002-07-10 10:26:11 by simonmar]simonmar2002-07-103-108/+118
| | | | | Tweaks to the MS Help support: the extra files are now only generated if you ask for them (--ms-help).
* [haddock @ 2002-07-10 09:40:56 by simonmar]simonmar2002-07-101-1/+3
| | | | Fix for rendering of the (->) type constructor, from Ross Paterson.
* [haddock @ 2002-07-09 16:33:31 by krasimir]krasimir2002-07-094-26/+128
| | | | 'Microsoft HTML Help' support
* [haddock @ 2002-07-09 10:12:51 by simonmar]simonmar2002-07-091-0/+2
| | | | commented-out debugging code
* [haddock @ 2002-07-09 10:12:10 by simonmar]simonmar2002-07-091-2/+2
| | | | | | Don't require that the list type comes from "Prelude" for it to be treated as special syntax (sometimes it comes from Data.List or maybe even GHC.Base).
* [haddock @ 2002-07-04 15:26:13 by simonmar]simonmar2002-07-041-14/+25
| | | | More bugfixes to the export handling
* [haddock @ 2002-07-04 14:56:10 by simonmar]simonmar2002-07-041-22/+27
| | | | | | | Clean up the code that constructs the exported declarations, and fix a couple of bugs along the way. Now if you import a class hiding one of the methods, then re-export the class, the version in the documentation will correctly have the appropriate method removed.
* [haddock @ 2002-07-03 16:01:07 by simonmar]simonmar2002-07-033-45/+112
| | | | | | Handle import specs properly, include 'hiding'. Haddock now has a complete implementation of the Haskell module system (more or less; I won't claim it's 100% correct).
* [haddock @ 2002-06-24 14:37:42 by simonmar]simonmar2002-06-243-50/+71
| | | | | | | | | | | | | | When reading an interface, allow a file path offset to be specified which represents the path to the HTML files for the modules specified by that interface. The path may be either relative (to the location of the HTML for this package), or absolute. The syntax is --read-interface=PATH,FILE where PATH is the path to the HTML, and FILE is the filename containing the interface.
* [haddock @ 2002-06-23 14:54:00 by panne]panne2002-06-232-3/+15
| | | | Make it compile with newer GHCs
* [haddock @ 2002-06-21 15:50:42 by simonmar]simonmar2002-06-214-9/+724
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* [haddock @ 2002-06-21 12:43:06 by simonmar]simonmar2002-06-211-0/+1
| | | | | | When we have a single code block paragraph, don't place it in <pre>..</pre>, just use <tt>..</tt> to avoid generating extra vertical white space in some browsers.
* [haddock @ 2002-06-20 12:39:01 by simonmar]simonmar2002-06-202-6/+33
| | | | | Add support for a "prologue" - a description for the whole library, placed on the contents page before the module list.
* [haddock @ 2002-06-20 12:38:07 by simonmar]simonmar2002-06-201-11/+7
| | | | Empty declaration fixes.
* [haddock @ 2002-06-11 09:23:25 by simonmar]simonmar2002-06-111-0/+3
| | | | portability nit
* [haddock @ 2002-06-08 14:03:36 by panne]panne2002-06-081-1/+1
| | | | | | | Tiny workaround for the fact that Haddock currently ignores HsImportSpecs: Let the local_orig_env take precedence. This is no real solution at all, but improves things sometimes, e.g. in my GLUT documentation. :-)
* [haddock @ 2002-06-05 09:12:02 by simonmar]simonmar2002-06-051-1/+1
| | | | | Identifiers in single quotes can be symbol names too (bug reported by Hal Daume).
* [haddock @ 2002-06-05 09:05:07 by simonmar]simonmar2002-06-051-6/+7
| | | | | Keep foreign imports when there is no export list (bug reported by Sven Panne).
* [haddock @ 2002-06-03 14:12:38 by simonmar]simonmar2002-06-031-11/+13
| | | | Render class names as proper binders
* [haddock @ 2002-06-03 13:46:48 by simonmar]simonmar2002-06-031-0/+6
| | | | Fix for exporting record selectors from a newtype declaration
* [haddock @ 2002-06-03 13:20:00 by simonmar]simonmar2002-06-031-1/+1
| | | | | Fix linking to qualified names again (thanks to Sven Panne for pointing out the bug).
* [haddock @ 2002-06-03 13:05:57 by simonmar]simonmar2002-06-037-57/+110
| | | | | | | Allow exporting of individual class methods and record selectors. For these we have to invent the correct type signature, which we do in the simplest possible way (i.e. no context reduction nonsense in the class case).
* [haddock @ 2002-05-29 15:27:18 by simonmar]simonmar2002-05-291-10/+8
| | | | Include the instances in abstract data types too
* [haddock @ 2002-05-29 13:19:06 by simonmar]simonmar2002-05-292-66/+73
| | | | | | | | | | | Make the markup syntax a little more friendly: - single quotes are now interpreted literally unless they surround a valid Haskell identifier. So for example now there's no need to escape a single quote used as an apostrophe. - text to the right of a bird track is now literal (if you want marked-up text in a code block, use @...@).
* [haddock @ 2002-05-29 09:09:49 by simonmar]simonmar2002-05-292-15/+3
| | | | Back out previous change until we can find a better way to do this.
* [haddock @ 2002-05-28 22:42:08 by sof]sof2002-05-282-3/+15
| | | | | | | | | Handle lone occurrences of '/', e.g., -- | This/that. [did this in the lexer rather than in the parser, as I couldn't see a way not to introduce an S/R conflict that way.]