aboutsummaryrefslogtreecommitdiff
path: root/src/Haddock/Utils.hs
Commit message (Collapse)AuthorAgeFilesLines
* Allow for headings inside function documentation.Mateusz Kowalczyk2014-01-121-1/+3
| | | | | | | | | | | | | LaTeX will treat the h3-h6 headings the same as we'd have to hack the style file heavily otherwise and it would make the headings tiny anyway. Hoogle upstream said they will put in the functionality on their end. Conflicts: src/Haddock/Interface/Rename.hs src/Haddock/Types.hs test/Haddock/ParserSpec.hs
* Support for bold.Mateusz Kowalczyk2014-01-121-5/+6
| | | | | | | Conflicts: src/Haddock/Backends/Hoogle.hs src/Haddock/Interface/Rename.hs src/Haddock/Parser.hs
* Merge branch 'ghc-7.6' into ghc-7.6-merge-2Kazu Yamamoto2013-02-011-2/+5
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: haddock.cabal src/Haddock/Interface/AttachInstances.hs src/Haddock/Interface/Create.hs src/Haddock/Interface/LexParseRn.hs src/Haddock/InterfaceFile.hs src/Haddock/Types.hs Only GHC HEAD can compile this. GHC 7.6.x cannot compile this. Some test fail.
| * Add markup support for propertiesKazu Yamamoto2012-10-091-0/+2
| |
| * Merge branch 'dev' of https://github.com/sol/haddock into ghc-7.6David Waern2012-07-231-2/+3
| |\ | | | | | | | | | | | | Conflicts: src/Haddock/InterfaceFile.hs
| | * Use LANGUAGE pragmas instead of default-extensions in cabal fileSimon Hengel2012-05-271-0/+1
| | |
| | * Add an optional label to URLsSimon Hengel2012-05-271-2/+2
| | |
* | | Implement overlapping type family instances.Richard Eisenberg2012-12-211-10/+8
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | An ordered, overlapping type family instance is introduced by 'type instance where', followed by equations. See the new section in the user manual (7.7.2.2) for details. The canonical example is Boolean equality at the type level: type family Equals (a :: k) (b :: k) :: Bool type instance where Equals a a = True Equals a b = False A branched family instance, such as this one, checks its equations in order and applies only the first the matches. As explained in the note [Instance checking within groups] in FamInstEnv.lhs, we must be careful not to simplify, say, (Equals Int b) to False, because b might later unify with Int. This commit includes all of the commits on the overlapping-tyfams branch. SPJ requested that I combine all my commits over the past several months into one monolithic commit. The following GHC repos are affected: ghc, testsuite, utils/haddock, libraries/template-haskell, and libraries/dph. Here are some details for the interested: - The definition of CoAxiom has been moved from TyCon.lhs to a new file CoAxiom.lhs. I made this decision because of the number of definitions necessary to support BranchList. - BranchList is a GADT whose type tracks whether it is a singleton list or not-necessarily-a-singleton-list. The reason I introduced this type is to increase static checking of places where GHC code assumes that a FamInst or CoAxiom is indeed a singleton. This assumption takes place roughly 10 times throughout the code. I was worried that a future change to GHC would invalidate the assumption, and GHC might subtly fail to do the right thing. By explicitly labeling CoAxioms and FamInsts as being Unbranched (singleton) or Branched (not-necessarily-singleton), we make this assumption explicit and checkable. Furthermore, to enforce the accuracy of this label, the list of branches of a CoAxiom or FamInst is stored using a BranchList, whose constructors constrain its type index appropriately. I think that the decision to use BranchList is probably the most controversial decision I made from a code design point of view. Although I provide conversions to/from ordinary lists, it is more efficient to use the brList... functions provided in CoAxiom than always to convert. The use of these functions does not wander far from the core CoAxiom/FamInst logic. BranchLists are motivated and explained in the note [Branched axioms] in CoAxiom.lhs. - The CoAxiom type has changed significantly. You can see the new type in CoAxiom.lhs. It uses a CoAxBranch type to track branches of the CoAxiom. Correspondingly various functions producing and consuming CoAxioms had to change, including the binary layout of interface files. - To get branched axioms to work correctly, it is important to have a notion of type "apartness": two types are apart if they cannot unify, and no substitution of variables can ever get them to unify, even after type family simplification. (This is different than the normal failure to unify because of the type family bit.) This notion in encoded in tcApartTys, in Unify.lhs. Because apartness is finer-grained than unification, the tcUnifyTys now calls tcApartTys. - CoreLinting axioms has been updated, both to reflect the new form of CoAxiom and to enforce the apartness rules of branch application. The formalization of the new rules is in docs/core-spec/core-spec.pdf. - The FamInst type (in types/FamInstEnv.lhs) has changed significantly, paralleling the changes to CoAxiom. Of course, this forced minor changes in many files. - There are several new Notes in FamInstEnv.lhs, including one discussing confluent overlap and why we're not doing it. - lookupFamInstEnv, lookupFamInstEnvConflicts, and lookup_fam_inst_env' (the function that actually does the work) have all been more-or-less completely rewritten. There is a Note [lookup_fam_inst_env' implementation] describing the implementation. One of the changes that affects other files is to change the type of matches from a pair of (FamInst, [Type]) to a new datatype (which now includes the index of the matching branch). This seemed a better design. - The TySynInstD constructor in Template Haskell was updated to use the new datatype TySynEqn. I also bumped the TH version number, requiring changes to DPH cabal files. (That's why the DPH repo has an overlapping-tyfams branch.) - As SPJ requested, I refactored some of the code in HsDecls: * splitting up TyDecl into SynDecl and DataDecl, correspondingly changing HsTyDefn to HsDataDefn (with only one constructor) * splitting FamInstD into TyFamInstD and DataFamInstD and splitting FamInstDecl into DataFamInstDecl and TyFamInstDecl * making the ClsInstD take a ClsInstDecl, for parallelism with InstDecl's other constructors * changing constructor TyFamily into FamDecl * creating a FamilyDecl type that stores the details for a family declaration; this is useful because FamilyDecls can appear in classes but other decls cannot * restricting the associated types and associated type defaults for a * class to be the new, more restrictive types * splitting cid_fam_insts into cid_tyfam_insts and cid_datafam_insts, according to the new types * perhaps one or two more that I'm overlooking None of these changes has far-reaching implications. - The user manual, section 7.7.2.2, is updated to describe the new type family instances.
* | Forward port changes from stable.Paolo Capriotti2012-07-191-5/+6
|\|
| * 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.
* | Follow changes in LHsTyVarBndrsSimon Peyton Jones2012-05-251-1/+7
| |
* | Follow refactoring of TyClDecl/HsTyDefnSimon Peyton Jones2012-03-261-7/+13
|/
* 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
|
generated by cgit v1.2.3 (git 2.39.1) at 2024-09-21 17:06:47 +0000