aboutsummaryrefslogtreecommitdiff
path: root/src/Haddock/Backends/Xhtml.hs
Commit message (Collapse)AuthorAgeFilesLines
* Move sources under haddock-api/srcMateusz Kowalczyk2014-08-231-690/+0
|
* Revert "Track GHC PackageId to PackageKey renaming."Mateusz Kowalczyk2014-08-141-1/+1
| | | | This reverts commit 8ac42d3327473939c013551750425cac191ff0fd.
* Track GHC PackageId to PackageKey renaming.Edward Z. Yang2014-07-211-1/+1
| | | | | | | Signed-off-by: Edward Z. Yang <ezyang@cs.stanford.edu> Conflicts: src/Haddock/Interface/Create.hs
* 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.
* Differentiate between TH splices (line-links) and regular namesNiklas Haas2014-03-091-7/+7
| | | | | | | | | | | | | | | | | 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/+5
| | | | | | 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.
* Fix rendering of Contents when links are presentMateusz Kowalczyk2014-02-241-4/+5
| | | | Fixes Haddock Trac #267.
* Use a bespoke data type to indicate fixityMateusz Kowalczyk2014-02-191-6/+6
| | | | | | This deals with what I imagine was an ancient TODO and makes it much clearer what the argument actually does rather than having the user chase down the comment.
* Improve display of poly-kinded type operatorsnand2014-02-111-1/+1
| | | | | | | 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-0/+1
| | | | | | | | 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>
* Insert a space between module link and descriptionMateusz Kowalczyk2014-02-101-1/+1
| | | | Fixes Haddock Trac #277.
* Handle infix vs prefix names correctly everywhere, by explicitly specifying ↵Dr. ERDI Gergo2014-01-311-7/+7
| | | | | | the context The basic idea is that "a" and "+" are either pretty-printed as "a" and "(+)" or "`a`" and "+"
* Support for -XPatternSynonymsDr. ERDI Gergo2014-01-191-1/+1
| | | | Signed-off-by: Austin Seipp <austin@well-typed.com>
* Fixes #271Mateusz Kowalczyk2014-01-131-1/+1
| | | | Signed-off-by: Austin Seipp <austin@well-typed.com>
* Per-module extension flags and language listing.Mateusz Kowalczyk2014-01-121-13/+31
| | | | | | | | | | | | | 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
* Output Copright and License keys in Xhtml backend.Mathieu Boespflug2013-08-041-5/+7
| | | | | | | This information is as relevant in the documentation as it is in the source files themselves. Signed-off-by: David Waern <david.waern@gmail.com>
* Follow changes in baseIan Lynagh2013-02-161-0/+3
|
* Implement overlapping type family instances.Richard Eisenberg2012-12-211-6/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-20/+15
|\
| * Attach warnings to `Documentation` typeSimon Hengel2012-05-171-1/+1
| |
| * newtype-wrap Doc nodes for things that may have warnings attachedSimon Hengel2012-05-171-7/+5
| |
| * qualification style 'abbreviated' -> 'aliased'Henning Thielemann2012-04-021-2/+2
| |
| * 'abbreviate' qualification style - basic supportHenning Thielemann2012-04-011-1/+2
| | | | | | | | | | Currently we ignore the package a module is imported from. This means that a module import would shadow another one with the same module name from a different package.
| * add QualOption type for distinction between qualification argument given by ↵Henning Thielemann2012-04-011-9/+5
| | | | | | | | | | the user and the actual qualification for a concrete module
| * Mostly hlint-inspired cleanup.David Waern2012-02-041-3/+3
| |
| * Make sure that generated xhtml is valid (close #186)Simon Hengel2012-01-121-1/+1
| | | | | | | | Thanks to Phyx.
* | Follow refactoring of TyClDecl/HsTyDefnSimon Peyton Jones2012-03-261-6/+2
|/
* Allow doc comments to link to out-of-scope things (#78).David Waern2011-11-261-19/+19
| | | | (A bug that should have been fixed long ago.)
* New kind-polymorphic coreJose Pedro Magalhaes2011-11-111-2/+2
| | | | | | | | | 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
* Add safe haskell indication to haddock outputDavid Terei2011-10-121-1/+2
|
* Merge in darcs patch:David Waern2011-10-011-2/+5
| | | | | | | | | | Joachim Breitner <mail@joachim-breitner.de>**20110619201645 Ignore-this: f6c51228205b0902ad5bfad5040b989a As reported on http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=578301, generating the global index takes much too long if type-level (with lots of auto-generated types) is installed. The patch avoids a quadratic runtime in the subfunction getIfaceIndex of ppHtmlIndex by using a temporary set. Runtime improvement observed here from 25.36s to 2.86s.
* Fix buildIan Lynagh2011-06-171-1/+1
|
* * Merge in git patch from Michal TerepetaDavid Waern2011-06-111-14/+14
| | | | | | | | | | | | | | | | 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.
* Put title outside doc div when HTML:fying title+prologueDavid Waern2011-01-221-1/+1
| | | | | Avoids indenting the title, and makes more sense since the title is not a doc string anyway.
* Haddockify ppHtml commentsDavid Waern2010-12-061-11/+11
|
* Add a flag --pretty-html for rendering indented html with newlinesDavid Waern2010-12-061-20/+24
|
* hlint policeDavid Waern2010-11-161-19/+17
|
* Remove docNameOcc under the motto "don't name compositions"David Waern2010-11-151-2/+2
|
* Change to index pages: include an 'All' option even when subdividing A-Z.rrnewton2010-10-241-5/+10
|
* Use "qual" as an abbreviation for qualification instead of "quali" for ↵David Waern2010-10-161-32/+32
| | | | consistency
* Solve conflictsDavid Waern2010-10-161-13/+15
|
* adding support for local and relative name qualificationTobias Brandt2010-08-271-1/+5
|
* adding the option to fully qualify identifiersTobias Brandt2010-08-271-28/+30
|
* make TOC group header identifiers validateMark Lentczner2010-09-041-2/+5
|
* make portability block be a table - solves layout issuesMark Lentczner2010-08-291-4/+5
|
* don't collapse entries in module list when clicking on linksMark Lentczner2010-08-171-6/+13
|
* clean up collapser logicsMark Lentczner2010-08-171-4/+4
| | | | | | | | javascript code for collapasble sections cleaned up rewrote class utilities in javascript to be more robust refactored utilities for generating collapsable sections made toc be same color as synopsis module list has needed clear attribute in CSS
* build style menu in javascriptMark Lentczner2010-08-141-10/+9
| | | | | | | | moved to javascript, so as to not polute the content with the style menu removed menu building code in Themes.hs removed onclick in Utils.hs changed text of button in header from "Source code" to "Source" more consistent with links in rest of page
* move frames button to js Mark Lentczner2010-08-131-4/+3
|
* add Frames button and clean up frames.htmlMark Lentczner2010-08-131-1/+3
|
generated by cgit v1.2.3 (git 2.39.1) at 2024-09-21 12:26:49 +0000