aboutsummaryrefslogtreecommitdiff
path: root/src/Haddock/Backends/LaTeX.hs
Commit message (Collapse)AuthorAgeFilesLines
* Move sources under haddock-api/srcMateusz Kowalczyk2014-08-231-1221/+0
|
* Display minimal complete definitions for type classesNiklas Haas2014-03-131-3/+3
| | | | | | | | | This corresponds to the new {-# MINIMAL #-} pragma present in GHC 7.8+. I also cleaned up some of the places in which ExportDecl is used to make adding fields easier in the future. Lots of test cases have been updated since they now render with minimality information.
* Hide RHS of TFs with non-exported right hand sidesNiklas Haas2014-03-131-1/+2
| | | | | | Not sure what to do about data families yet, since technically it would not make a lot of sense to display constructors that cannot be used by the user.
* Differentiate between TH splices (line-links) and regular namesNiklas Haas2014-03-091-3/+3
| | | | | | | | | | | | | | | | | This adds a new type of source code link, to a specific line rather than a specific declaration/name - this is used to link to the location of a TH splice that defines a certain name. Rather hefty changes throughout and still one unresolved issue (the line URLs aren't parsed from the third form of --read-interface which means they're currently restricted to same-interface links). Not sure if this issue is really worth all the hassle, especially since we could just use line links in general. This commit also contains some cleanup/clarification of the types in Haddock.Backends.Xhtml.Decl and shortens some overlong lines in the process. Notably, the Bool parameter was replaced by a Unicode type synonym to help clarify its presence in type signatures.
* Render fixity informationNiklas Haas2014-03-081-5/+6
| | | | | | Affects functions, type synonyms, type families, class names, data type names, constructors, data families, associated TFs/DFs, type synonyms, pattern synonyms and everything else I could think of.
* Improve display of poly-kinded type operatorsnand2014-02-111-11/+11
| | | | | | | This now displays them as (==) k a b c ... to mirror GHC's behavior, instead of the old (k == a) b c ... which was just wrong. Signed-off-by: Mateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk>
* Add support for type/data familiesnand2014-02-111-7/+9
| | | | | | | | This adds support for type/data families with their respective instances, as well as closed type families and associated type/data families. Signed-off-by: Mateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk>
* Support for -XPatternSynonymsDr. ERDI Gergo2014-01-191-2/+42
| | | | Signed-off-by: Austin Seipp <austin@well-typed.com>
* Per-module extension flags and language listing.Mateusz Kowalczyk2014-01-121-1/+2
| | | | | | | | | | | | | Any extensions that are not enabled by a used language (Haskell2010 &c) will be shown. Furthermore, any implicitly enabled are also going to be shown. While we could eliminate this either by using the GHC API or a dirty hack, I opted not to: if a user doesn't want the implied flags to show, they are recommended to use enable extensions more carefully or individually. Perhaps this will encourage users to not enable the most powerful flags needlessly. Enabled with show-extensions. Conflicts: src/Haddock/InterfaceFile.hs
* Allow for headings inside function documentation.Mateusz Kowalczyk2014-01-121-1/+8
| | | | | | | | | | | | | 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-0/+3
| | | | | | | Conflicts: src/Haddock/Backends/Hoogle.hs src/Haddock/Interface/Rename.hs src/Haddock/Parser.hs
* One pass parser and tests.Mateusz Kowalczyk2014-01-121-18/+29
| | | | | | | | We remove the HTML test as it is no longer necessary. We cover the test case in spec tests and other HTML tests but keeping this around fails: this is because the new parser has different semantics there. In fact, I suspect the original behaviour was a bug that wasn't caught/fixed but simply included as-is during the testing.
* Adapt to small change in Pretty's exportsSimon Peyton Jones2014-01-101-3/+3
|
* Revision to reflect new role annotation syntax in GHC.Richard Eisenberg2013-09-171-1/+0
|
* Fix ticket #247.Mateusz Kowalczyk2013-08-271-2/+6
| | | | | I do the same thing that the XHTML backend does: give these no special treatment and just act as if they are regular functions.
* Changes to reflect changes in GHC's type HsTyVarBndrRichard Eisenberg2013-08-021-0/+1
|
* Merge branch 'ghc-7.6' into ghc-7.6-merge-2Kazu Yamamoto2013-02-011-1/+6
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | 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/+1
| |
| * Merge branch 'dev' of https://github.com/sol/haddock into ghc-7.6David Waern2012-07-231-1/+5
| |\ | | | | | | | | | | | | Conflicts: src/Haddock/InterfaceFile.hs
| | * Add an optional label to URLsSimon Hengel2012-05-271-1/+5
| | |
* | | Implement overlapping type family instances.Richard Eisenberg2012-12-211-10/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* | | Merge branch 'master' of darcs.haskell.org:/srv/darcs//haddockIan Lynagh2012-07-191-27/+28
|\| |
| * | Forward port changes from stable.Paolo Capriotti2012-07-191-27/+28
| |\|
| | * Attach warnings to `Documentation` typeSimon Hengel2012-05-171-4/+4
| | |
| | * newtype-wrap Doc nodes for things that may have warnings attachedSimon Hengel2012-05-171-27/+29
| | |
| | * Use >>= instead of fmap and joinSimon Hengel2012-05-171-3/+2
| | |
| | * Add DocWarning to DocSimon Hengel2012-02-041-0/+1
| | | | | | | | | | | | | | | The Xhtml backend has special markup for that, Hoogle and LaTeX reuse what we have for DocEmphasis.
* | | Follow changes in GHCIan Lynagh2012-07-151-1/+2
|/ /
* | Follow changes for the implementation of implicit parametersSimon Peyton Jones2012-06-131-2/+3
| |
* | Follow changes to LHsTyVarBndrsSimon Peyton Jones2012-05-111-6/+6
| |
* | Track changes in HsSynSimon Peyton Jones2012-04-201-1/+2
| |
* | Merge branch 'master' of http://darcs.haskell.org//haddockSimon Peyton Jones2012-03-261-0/+9
|\ \
| * | Add support for type-level literals.Iavor S. Diatchki2012-03-151-0/+9
| | |
* | | Follow refactoring of TyClDecl/HsTyDefnSimon Peyton Jones2012-03-261-38/+18
|/ /
* | Follow changes in data representation from the big PolyKinds commitSimon Peyton Jones2012-03-021-1/+1
| |
* | Follow changes in GHCIan Lynagh2012-02-221-1/+1
| |
* | Follow changes in GHC caused by the CAPI CTYPE pragmaIan Lynagh2012-02-161-1/+1
|/
* Allow doc comments to link to out-of-scope things (#78).David Waern2011-11-261-18/+19
| | | | (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-19/+7
| | | | | | | | | | | 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.
* Follow changes to tuple sorts in masterJose Pedro Magalhaes2011-11-161-2/+2
|
* New kind-polymorphic coreJose Pedro Magalhaes2011-11-111-8/+12
| | | | | | | | | This big patch implements a kind-polymorphic core for GHC. The current implementation focuses on making sure that all kind-monomorphic programs still work in the new core; it is not yet guaranteed that kind-polymorphic programs (using the new -XPolyKinds flag) will work. For more information, see http://haskell.org/haskellwiki/GHC/Kinds
* Merge branch 'no-pred-ty'Max Bolingbroke2011-09-091-17/+14
|\ | | | | | | | | Conflicts: src/Haddock/Convert.hs
| * Adapt Haddock for the ConstraintKind extension changesMax Bolingbroke2011-09-061-17/+14
| |
* | Ignore associated type defaults (just as we ignore default methods)Max Bolingbroke2011-09-091-3/+3
|/
* * Merge in git patch from Michal TerepetaDavid Waern2011-06-111-30/+35
| | | | | | | | | | | | | | | | 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.
* Add git commits since switchover:David Waern2011-06-101-1/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | darcs format (followed by a conflict resolution): commit 6f92cdd12d1354dfbd80f8323ca333bea700896a Merge: f420cc4 28df3a1 Author: Simon Peyton Jones <simonpj@microsoft.com> Date: Thu May 19 17:54:34 2011 +0100 Merge remote branch 'origin/master' into ghc-generics commit 28df3a119f770fdfe85c687dd73d5f6712b8e7d0 Author: Max Bolingbroke <batterseapower@hotmail.com> Date: Sat May 14 22:37:02 2011 +0100 Unicode fix for getExecDir on Windows commit 89813e729be8bce26765b95419a171a7826f6d70 Merge: 6df3a04 797ab27 Author: Simon Peyton Jones <simonpj@microsoft.com> Date: Mon May 9 11:55:17 2011 +0100 Merge branch 'ghc-new-co' commit 6df3a040da3dbddee67c6e30a892f87e6b164383 Author: Ian Lynagh <igloo@earth.li> Date: Sun May 8 17:05:50 2011 +0100 Follow changes in SDoc commit f420cc48b9259f0b1afd2438b12f9a2bde57053d Author: Jose Pedro Magalhaes <jpm@cs.uu.nl> Date: Wed May 4 17:31:52 2011 +0200 Adapt haddock to the removal of HsNumTy and TypePat. commit 797ab27bdccf39c73ccad374fea265f124cb52ea Merge: 1d81436 5a91450 Author: Simon Peyton Jones <simonpj@microsoft.com> Date: Mon May 2 12:05:03 2011 +0100 Merge remote branch 'origin/master' into ghc-new-co commit 1d8143659a81cf9611668348e33fd0775c7ab1d2 Author: Simon Peyton Jones <simonpj@microsoft.com> Date: Mon May 2 12:03:46 2011 +0100 Wibbles for ghc-new-co branch commit 5a91450e2ea5a93c70bd3904b022445c9cc82488 Author: Ian Lynagh <igloo@earth.li> Date: Fri Apr 22 00:51:56 2011 +0100 Follow defaultDynFlags change in GHC
* Remove docNameOcc under the motto "don't name compositions"David Waern2010-11-151-7/+7
|
* Remove code for ghc < 7David Waern2010-11-151-12/+0
|
* Adapt to minor changes in internal GHC functionssimonpj2010-09-131-0/+1
|
* Remove conflict left-overDavid Waern2010-07-241-1/+1
|
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-11 08:58:57 +0000