aboutsummaryrefslogtreecommitdiff
path: root/src/Haddock
Commit message (Collapse)AuthorAgeFilesLines
...
* Follow change to ExportDecl in frames codeDavid Waern2008-11-041-1/+1
|
* Enable framed view of the HTML documentation.Thomas Schilling2008-10-242-9/+128
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* Make named doc comments into ExportDoc instead of ExportDeclDavid Waern2008-10-271-0/+1
| | | | | Fixes a crash when processing modules without export lists containing named docs.
* WibbleDavid Waern2008-10-221-0/+1
|
* Fix warnings in H.UtilsDavid Waern2008-10-221-12/+10
|
* Fix warnings in H.GHC.UtilsDavid Waern2008-10-221-0/+5
|
* Tidy up code in H.I.Create a littleDavid Waern2008-10-221-38/+3
| | | | | Remove commented out half-done type instance support, and remove DeclWithDoc synonym.
* Remove subordinate map and its usageDavid Waern2008-10-222-23/+17
| | | | It is not needed now that we store subordinate names in the DeclInfo map.
* Make renamer consistentDavid Waern2008-10-201-9/+12
| | | | | Instead of explicitly making some binders Undocumented, treat all names the same way (that is, try to find a Documented name).
* Force interface more aggressively.Thomas Schilling2008-10-201-0/+2
| | | | | | | For running Haddock on GHC this reduces memory usage by about 50 MB on a 32 bit system. A heap profile shows total memory usage peak at about 100 MB, but actual usage is at around 300 MB even with compacting GC (+RTS -c).
* Document function and improve its layoutDavid Waern2008-10-161-5/+4
|
* Fix #61David Waern2008-10-167-66/+89
| | | | | | | | | | | | | | | | | | | 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.
* WibbleDavid Waern2008-10-161-3/+2
|
* Add subordinates with docs to the declaration mapDavid Waern2008-10-153-12/+14
| | | | | | | | | | | The only place in the code where we want the subordinates for a declaration is right after having looked up the declaration in the map. And since we include subordinates in the map, we might as well take the opportunity to store those subordinates that belong to a particular declaration together with that declaration. We also store the documentation for each subordinate.
* Add DeclInfo to H.TypesDavid Waern2008-10-152-1/+6
|
* Move convenient type synonym to H.TypesDavid Waern2008-10-152-5/+5
|
* WibbleDavid Waern2008-10-151-5/+2
|
* Comment out unused type family stuff completelyDavid Waern2008-10-151-7/+6
|
* Use type synonyms for declarations and docs in H.I.CreateDavid Waern2008-10-151-13/+19
|
* WibbleDavid 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-105-3/+9
| | | | | | 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!
* Add back .haddock file versioning based on GHC versionDavid Waern2008-10-101-0/+9
| | | | It was accidentally removed in the patch for GHC 6.8.2 compatibility
* Fix documentation for createInterfacesDavid Waern2008-10-101-1/+1
|
* Make Haddock build with GHC 6.8.2David Waern2008-10-105-20/+81
|
* Remove typecheckFiles and MonadUtils import from H.GHC.TypeccheckDavid Waern2008-10-101-31/+0
|
* Add some strictness annotations in InterfaceDavid Waern2008-10-091-9/+9
| | | | | We add some strictness annotations to the fields of Interface, so that less GHC data is hold on to during processing.
* Interleave typechecking with interface creationDavid Waern2008-10-092-30/+94
| | | | | | At the same time, we fix a bug where the list of interfaces were processed in the wrong order, when building the links and renaming the interfaces.
* Only load modules once when typechecking with GHC.Thomas Schilling2008-10-081-33/+27
| | | | | | This still doesn't fix the memory leak since the typechecked source is retained and then processed separately. To fix the leak, modules must be processed directly after typechecking.
* Follow GHC API change of parseModule.Thomas Schilling2008-10-031-1/+1
|
* Write a comment about source links for type instance declarationsDavid Waern2008-10-021-0/+3
|
* Remove ifaceEnv from Interface - it's no longer usedDavid Waern2008-10-022-5/+0
|
* 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).
* Add PatternSignatures LANGUAGE pragma to Main and UtilsDavid Waern2008-09-241-0/+2
|
* Do not wrap __ in bracketsNeil Mitchell2008-09-111-1/+1
|
* Port Haddock.GHC to new GHC API.Thomas Schilling2008-09-151-13/+13
|
* Port Haddock.GHC.Typecheck to new GHC API.Thomas Schilling2008-09-151-11/+17
|
* Reflect GHC API changes.Thomas Schilling2008-09-151-1/+1
|
* Port Haddock.Interface to new GHC API.Thomas Schilling2008-09-151-42/+60
| | | | | | | | | | | | | | | | This required one bigger change: 'readInterfaceFile' used to take an optional 'Session' argument. This was used to optionally update the name cache of an existing GHC session. This does not work with the new GHC API, because an active session requires the function to return a 'GhcMonad' action, but this is not possible if no session is provided. The solution is to use an argument of functions for reading and updating the name cache and to make the function work for any monad that embeds IO, so it's result type can adapt to the calling context. While refactoring, I tried to make the code a little more self-documenting, mostly turning comments into function names.
* Fixes for using haddock in a GHC build treeIan Lynagh2008-08-281-1/+2
|
* Fix some warningsIan Lynagh2008-08-276-72/+65
|
* 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 changes to Binary in GHC 6.9David Waern2008-08-131-1/+78
|
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-15 03:12:46 +0000