aboutsummaryrefslogtreecommitdiff
path: root/src/Haddock/Utils.hs
Commit message (Collapse)AuthorAgeFilesLines
* Add an optional label to URLsSimon Hengel2012-05-271-2/+2
|
* Mostly hlint-inspired cleanup.David Waern2012-02-041-5/+4
|
* Add DocWarning to DocSimon Hengel2012-02-041-0/+2
| | | | | The Xhtml backend has special markup for that, Hoogle and LaTeX reuse what we have for DocEmphasis.
* Allow doc comments to link to out-of-scope things (#78).David Waern2011-11-261-39/+64
| | | | (A bug that should have been fixed long ago.)
* Give preference to type over data constructors for doc comment links at ↵David Waern2011-11-261-1/+1
| | | | | | | | | | | renaming time. Previously this was done in the backends. Also, warn when a doc comment refers to something that is in scope but which we don't have the .haddock file for. These changes mean we can make DocIdentifier [a] into DocIdentifier a.
* * Merge in git patch from Michal TerepetaDavid Waern2011-06-111-4/+2
| | | | | | | | | | | | | | | | From 6fc71d067738ef4b7de159327bb6dc3d0596be29 Mon Sep 17 00:00:00 2001 From: Michal Terepeta <michal.terepeta@gmail.com> Date: Sat, 14 May 2011 19:18:22 +0200 Subject: [PATCH] Follow the change of TypeSig in GHC. This follows the change in GHC to make TypeSig take a list of names (instead of just one); GHC ticket #1595. This should also improve the Haddock output in case the user writes a type signature that refers to many names: -- | Some comment.. foo, bar :: ... will now generate the expected output with one signature for both names.
* hlint policeDavid Waern2010-11-161-2/+2
|
* Remove LANGUAGE ForeignFunctionInterface pragmasDavid Waern2010-11-161-1/+0
|
* Fix URL creation on Windows: Use / not \ in URLs. Fixes #4353Ian Lynagh2010-09-291-2/+2
|
* Change to index pages: include an 'All' option even when subdividing A-Z.rrnewton2010-10-241-4/+4
|
* H.Utils needs FFI on Win+MinGW David Waern2010-09-021-0/+1
|
* reorganize files in the html lib data dirMark Lentczner2010-07-261-4/+2
|
* command like processing for theme selectionMark Lentczner2010-07-231-4/+2
| | | | | | | The bulk of the change is threadnig the selected theme set through functions in Xhtml.hs so that the selected themes can be used when generating the page output. There isn't much going on in most of these changes, just passing it along. The real work is all done in Themes.hs.
* Solve conflictDavid Waern2010-07-221-1/+2
|
* fix warningSimon Marlow2010-06-301-1/+1
|
* Style police in Haddock.UtilsDavid Waern2010-07-211-41/+57
|
* refactoring of anchor ID and fragment handlingMark Lentczner2010-07-191-11/+44
|
* Warning policeDavid Waern2010-07-011-1/+1
|
* LaTeX backend (new options: --latex, --latex-style=<style>)Simon Marlow2010-06-301-0/+6
|
* Remove redundant importsIan Lynagh2010-06-131-3/+0
|
* HLint policeDavid Waern2010-05-181-2/+2
|
* Re-direct compilation output to a temporary directoryDavid Waern2010-05-141-31/+19
| | | | | Also add a flag --no-tmp-comp-dir that can be used to get the old behaviour of writing compilation files to GHC's output directory (default ".").
* Remove unused modulesDavid Waern2010-05-141-3/+0
|
* Get rid of H.Utils.pathJoin and use System.FilePath.joinPath insteadDavid Waern2010-05-131-12/+2
|
* Fix stylistic issues in H.UtilsDavid Waern2010-05-131-5/+38
|
* Position the module header the same way everywhereDavid Waern2010-05-131-2/+0
| | | | Silly, but nice with some consistency :-)
* Add markup support for interactive examplessimon.hengel2010-04-021-1/+3
|
* Rename HsDoc back into DocDavid Waern2009-11-281-6/+6
|
* Utils: ghc >= 6.10Isaac Dupree2009-08-231-6/+0
|
* Fix unused import warningsIan Lynagh2009-07-071-3/+0
|
* Remove unused functions from Haddock.UtilsDavid Waern2009-07-061-43/+1
|
* Add Haddock module headersDavid Waern2009-06-241-5/+11
| | | | | | | | | Add a proper Haddock module header to each module, with a more finegrained copyright. If you feel mis-accreditted, please correct any copyright notice! The maintainer field is set to haddock@projects.haskell.org. Next step is to add a brief description to each module.
* Move H.GHC.Utils to H.GhcUtilsDavid Waern2009-04-051-1/+1
|
* hlint policeDavid Waern2009-04-011-8/+8
|
* Add verbosity flag and utils, remove "verbose" flagDavid Waern2008-12-071-1/+26
|
* Remove unnecessary LANGUAGE pragmaDavid Waern2009-03-241-2/+0
|
* Enable framed view of the HTML documentation.Thomas Schilling2008-10-241-3/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 warnings in H.UtilsDavid Waern2008-10-221-12/+10
|
* Add support for DocPicDavid Waern2008-10-101-2/+4
| | | | | | 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/+11
|
* Add PatternSignatures LANGUAGE pragma to Main and UtilsDavid Waern2008-09-241-0/+2
|
* Fix some warningsIan Lynagh2008-08-271-3/+0
|
* Follow move of package string functions from PackageConfig to ModuleDavid Waern2008-08-131-1/+1
|
* Do not export ATs when not in list of subitemsDavid Waern2008-07-291-1/+8
|
* Add LANGUAGE pragmas to source filesDavid Waern2008-05-011-0/+4
|
* Change the representation of DocNamesDavid Waern2008-02-091-6/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Ross Paterson reported a bug where links would point to the defining module instead of the "best" module for an identifier (e.g Int pointing to GHC.Base instead of Data.Int). This patch fixes this problem by refactoring the way renamed names are represented. Instead of representing them by: > data DocName = Link Name | NoLink Name they are now represented as such: > data DocName = Documented Name Module | Undocumented Name and the the link-env looks like this: > type LinkEnv = Map Name Module There are several reasons for this. First of all, the bug was caused by changing the module part of Names during the renaming process, without changing the Unique field. This caused names to be overwritten during the loading of .haddock files (which caches names using the NameCache of the GHC session). So we might create new Uniques during renaming to fix this (but I'm not sure that would be problem-free). Instead, we just keep the Name and add the Module where the name is best documented, since it can be useful to keep the original Name around (for e.g. source-code location info and for users of the Haddock API). Also, the names Link/NoLink don't really make sense, since wether to use links or not is entirely up to the users of DocName. In the process of following this change into H.Backends.Html I removed the assumption that binder names are Undocumented (which was just an unnecessary assumption, the OccName is the only thing needed to render these). This will probably make it possible to get rid of the renamer and replace it with a traversal from SYB or Uniplate. Since DocName has changed, InterfaceFile has changed so this patch also increments the file-format version. No backwards-compatibility is implemented.
* Rename haddock.js to haddock-util.jsSimon Marlow2006-10-111-1/+1
| | | | | | haddock.js will be run automatically by Windows when you type 'haddock' if it is found on the PATH, so rename to avoid confusion. Spotted by Adrian Hey.
* Fix conflictsDavid Waern2007-11-111-3/+7
|
* Eliminate dep on network by doing a little cut'n'pasteDuncan Coutts2006-09-081-10/+31
| | | | | haddock depending on the network causes a circular dependency at least if you want to build the network lib with haddock docs.
* Introduce InstalledInterface structure and add more stuff to the .haddock filesDavid Waern2007-11-101-1/+7
| | | | | | | We introduce InstalledInterface capturing the part of Interface that is stored in the interface files. We change the ppHtmlContents and ppHtmllIndex to take this structure instead of a partial Interface. We add stuff like the doc map and exported names to the .haddock file (via InstalledInterface).
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-28 12:28:35 +0000