aboutsummaryrefslogtreecommitdiff
path: root/src/Haddock/Backends
Commit message (Collapse)AuthorAgeFilesLines
* Fix warnings in H.B.DevHelpDavid Waern2009-03-241-9/+9
|
* Fix small bugDavid Waern2009-02-241-6/+17
| | | | | | | | The rule is to prefer type constructors to other things when an identifier in a doc string can refer to multiple things. This stopped working with newer GHC versions (due to a tiny change in the GHC renamer). We implement this rule in the HTML backend for now, instead of fixing it in GHC, since we will move renaming of doc strings to Haddock in the future anyway.
* Do not indicate that a constructor argument is unboxedDavid Waern2009-01-211-1/+2
| | | | | | We only show the strictness annotation for an unboxed constructor argument. The fact that it is unboxed is an implementation detail and should not be part of the module interface.
* Show re-exported names from external packages againDavid Waern2009-01-021-3/+3
| | | | | | | This fixes GHC ticket 2746. In order to also link to the exported subordinate names of a declaration, we need to re-introduce the sub map in the .haddock files.
* Make visible names from ExportItemsDavid Waern2008-12-081-8/+8
| | | | | | | | | | | | | | Instead of a complicated calculation of visible names out of GHC's export items, we can get them straight out of the already calculated ExportItems. The ExportItems should represent exactly those items that are visible in an interface. If store all the exported sub-names in ExportDecl instead of only those with documentation, the calculation becomes very simple. So we do this change as well (should perhaps have been a separate patch). This should fix the problem with names from ghc-prim not appearing in the link environment.
* Make forall's in constructors explicit, i.e. data Foo = Foo {foo :: Eq a => a}Neil Mitchell2008-12-151-2/+8
|
* Allow referring to a specific section within a module in a module linkRoman Cheplyaka2008-11-271-1/+1
| | | | Fixes #65
* Drop HsDocTy annotations, they mess up pretty printing and also have a ↵Neil Mitchell2008-11-271-9/+29
| | | | bracketing bug (#2584)
* FIX #45: generate two anchors for each nameDavid Waern2008-11-231-1/+9
| | | | | | We generate two anchor tags for each name, one where we don't escape the name and one where we URI-encode it. This is for compatibility between IE and Opera. Test output is updated.
* Fix warnings in H.B.HH and H.B.HH2David Waern2008-11-062-0/+2
|
* Follow change to ExportDecl in frames codeDavid Waern2008-11-041-1/+1
|
* Enable framed view of the HTML documentation.Thomas Schilling2008-10-241-6/+110
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch introduces: - A page that displays the documentation in a framed view. The left side will show a full module index. Clicking a module name will show it in the right frame. If Javascript is enabled, the left side is split again to show the modules at the top and a very short synopsis for the module currently displayed on the right. - Code to generate the mini-synopsis for each module and the mini module index ("index-frames.html"). - CSS rules for the mini-synopsis. - A very small amount of javascript to update the mini-synopsis (but only if inside a frame.) Some perhaps controversial things: - Sharing code was very difficult, so there is a small amount of code duplication. - The amount of generated pages has been doubled, since every module now also gets a mini-synopsis. The overhead should not be too much, but I haven't checked. Alternatively, the mini-synopsis could also be generated using Javascript if we properly annotate the actual synopsis.
* Fix #61David Waern2008-10-162-22/+22
| | | | | | | | | | | | | | | | | | | We were not getting docs for re-exported class methods. This was because we were looking up the docs in a map made from the declarations in the current module being rendered. Obviously, re-exported class methods come from another module. Class methods and ATs were the only thing we were looking up using the doc map, everything else we found in the ExporItems. So now I've put subordinate docs in the ExportItem's directly, to make things a bit more consistent. To do this, I added subordinates to the the declarations in the declaration map. This was easy since we were computing subordinates anyway, to store stand-alone in the map. I added a new type synonym 'DeclInfo', which is what we call what is now stored in the map. This little refactoring removes duplicate code to retrieve subordinates and documentation from the HsGroup.
* Add DeclInfo to H.TypesDavid Waern2008-10-151-1/+1
|
* Remove interface from LinksInfoDavid Waern2008-10-111-49/+49
| | | | | It was there to know the documentation home module when creating a wiki link, but we already know this since we have the DocName.
* Add support for DocPicDavid Waern2008-10-102-0/+2
| | | | | | The support for DocPic was merged into the GHC source long ago, but the support in Haddock was forgotten. Thanks Peter Gavin for submitting this fix!
* Make Haddock build with GHC 6.8.2David Waern2008-10-101-0/+4
|
* Write a comment about source links for type instance declarationsDavid Waern2008-10-021-0/+3
|
* For source links, get original module from declaration name instead of ↵David Waern2008-10-021-7/+3
| | | | | | | environment. Getting it from the environment must have been a remnant from the times when we were using unqualified names (versions 0.x).
* Do not wrap __ in bracketsNeil Mitchell2008-09-111-1/+1
|
* Reflect GHC API changes.Thomas Schilling2008-09-151-1/+1
|
* In the hoogle back end, markup definition lists using <i>, not <b>Neil Mitchell2008-08-211-1/+1
|
* Simplify the code by removing not-to-important use of <.> in the Hoogle back endNeil Mitchell2008-08-201-5/+1
|
* Remove Explicit top-level forall's when pretty-printing signaturesNeil Mitchell2008-08-181-1/+5
|
* Use the same method to put out signatures as class methods in the Hoogle backendNeil Mitchell2008-08-181-1/+1
|
* Make Hoogle add documentation to a packageNeil Mitchell2008-08-131-2/+3
|
* Generalise Hoogle.doc and add a docWithNeil Mitchell2008-08-131-5/+11
|
* Add support for type synonyms to Hoogle, was accidentally missing before ↵Neil Mitchell2008-08-121-0/+5
| | | | (woops!)
* Output all items, even if they are not defined in this module - ensures map ↵Neil Mitchell2008-08-121-8/+1
| | | | comes from Prelude, not just GHC.Base
* Follow move of package string functions from PackageConfig to ModuleDavid Waern2008-08-132-3/+5
|
* Hide <.> from GHC import in Hoogle only for ghc <= 6.8.3David Waern2008-08-121-0/+4
|
* Move reL to H.GHC.Utils so we can use it everywhereDavid Waern2008-08-031-2/+0
|
* Move unL from H.B.Hoogle to H.GHC.UtilsDavid Waern2008-07-291-1/+0
| | | | I like Neil's shorter unL better than unLoc from the GHC API.
* Print parenthesis around non-atomic banged typesDavid Waern2008-07-241-1/+1
| | | | Fixes half of #44
* Drop unnecessary parenthesis in types, put in by the userDavid Waern2008-07-241-9/+9
| | | | | | | | | | | | | We were putting in parenthesis were the user did. Let's remove this since it just clutters up the types. The types are readable anyway since we print parens around infix operators and do not rely on fixity levels. When doing this I discovered that we were relying on user parenthesis when printin types like (a `O` b) c. This patchs fixes this problem so that parenthesis are always inserted around an infix op application in case it is applied to further arguments, or if it's an arguments to a type constructor. Tests are updated.
* FIX #44: Propagate parenthesis level when printing documented typesDavid Waern2008-07-241-1/+1
|
* Resolve conflicts in H.B.HoogleDavid Waern2008-07-201-0/+3
|
* Print type signatures with brackets around the nameNeil Mitchell2008-07-101-3/+9
|
* Put brackets round operators in more places in the Hoogle outputNeil Mitchell2008-07-101-3/+13
|
* Remove the TODO in the Hoogle HTML generation, was already doneNeil Mitchell2008-07-101-1/+0
|
* Remove any white space around a <li> elementNeil Mitchell2008-06-261-1/+3
|
* Fix a bug in the Hoogle backend, unordered lists were being written out ↵Neil Mitchell2008-06-261-1/+1
| | | | <ul>...</u>
* Flesh out the Hoogle code to render documentationNeil Mitchell2008-06-261-4/+100
|
* Add support for Hoogle writing ForeignImport/ForeignExport properlyNeil Mitchell2008-06-261-0/+2
|
* Remove the indent utility function from Hoogle backendNeil Mitchell2008-06-261-1/+0
|
* Change how the Hoogle backend outputs classes, adding the context inNeil Mitchell2008-06-261-1/+12
|
* Follow changes to ExportDecl in HoogleDavid Waern2008-07-201-2/+6
|
* Preparation for rendering instances as separate declarationsDavid Waern2008-07-202-39/+88
| | | | | | | | | We want to be able to render instances as separate declarations. So we remove the Name argument of ExportDecl, since instances are nameless. This patch also contains the first steps needed to gather type family instances and display them in the backend, but the implementation is far from complete. Because of this, we don't actually show the instances yet.
* More support for type families and associated typesDavid Waern2008-07-021-49/+70
| | | | Now we just need to render the instances
* Remove redundant check for summary when rendering data typesDavid Waern2008-07-021-4/+3
|
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-28 12:11:48 +0000