aboutsummaryrefslogtreecommitdiff
path: root/haddock-api/src/Haddock/Backends/Xhtml/Decl.hs
Commit message (Collapse)AuthorAgeFilesLines
* Constructor and pattern synonym argument docs (#709)Alec Theriault2018-01-131-131/+270
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Support Haddocks on constructor arguments This is in conjunction with https://phabricator.haskell.org/D4094. Adds support for rendering Haddock's on (non-record) constructor arguments, both for regular and GADT constructors. * Support haddocks on pattern synonym arguments It appears that GHC already parsed these - we just weren't using them. In the process of doing this, I tried to deduplicate some code around handling patterns. * Update the markup guide Add some information about the new support for commenting constructor arguments, and mention pattern synonyms and GADT-style constructors. * Overhaul LaTeX support for data/pattern decls This includes at least * fixing several bugs that resulted in invalid LaTeX * fixing GADT data declaration headers * overhaul handling of record fields * overhaul handling of GADT constructors * overhaul handling of bundled patterns * add support for constructor argument docs * Support GADT record constructors This means changes what existing HTML docs look like. As for LaTeX, looks like GADT records were never even supported. Now they are. * Clean up code/comments Made code/comments consistent between the LaTeX and XHTML backend when possible. * Update changelog * Patch post-rebase regressions * Another post-rebase change We want return values to be documentable on record GADT constructors.
* Track changes to follow Trac #14529Simon Peyton Jones2017-12-071-19/+19
| | | | This tracks the refactoring of HsDecl.ConDecl.
* Revert "Match changes for Trees that Grow in GHC"Ben Gamari2017-11-211-35/+34
| | | | This reverts commit 01eeeb048acd2dd05ff6471ae148a97cf0720547.
* Revert "Clean up use of PlaceHolder, to match TTG"Ben Gamari2017-11-211-2/+2
| | | | This reverts commit 134a7bb054ea730b13c8629a76232d73e3ace049.
* Clean up use of PlaceHolder, to match TTGAlan Zimmerman2017-11-141-2/+2
|
* Match changes for Trees that Grow in GHCAlan Zimmerman2017-11-071-34/+35
|
* Overhaul Haddock's rendering of kind signatures (#681)Ryan Scott2017-10-241-12/+11
| | | | | | | | | | | | | | | * Overhaul Haddock's rendering of kind signatures * Strip off kind signatures when specializing As an added bonus, this lets us remove an ugly hack specifically for `(->)`. Yay! * Update due to 0390e4a0f61e37bd1dcc24a36d499e92f2561b67 * @alexbiehl's suggestions * Import injectiveVarsOfBinder from GHC
* Update for #14131Ryan Scott2017-08-231-2/+3
|
* Merge remote-tracking branch 'origin/master' into ghc-headalexbiehl2017-08-211-148/+193
|\
| * Fix: Generate pattern signatures for constructors exported as patterns (#663)Tim Baumann2017-08-061-107/+135
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Fix pretty-printing of pattern signatures Pattern synonyms can have up to two contexts, both having a different semantic meaning: The first holds the constraints required to perform the matching, the second contains the constraints provided by a successful pattern match. When the first context is empty but the second is not it is necessary to render the first, empty context. * Generate pattern synonym signatures for ctors exported as patterns This fixes #653. * Simplify extractPatternSyn It is not necessary to generate the simplest type signature since it will be simplified when pretty-printed. * Add changelog entries for PR #663 * Fix extractPatternSyn error message
| * Fix haddock: internal error: links: UnhelpfulSpan (#561)Bartosz Nitka2017-07-021-2/+4
| | | | | | | | | | | | | | | | | | * Fix haddock: internal error: links: UnhelpfulSpan This fixes #554 for me. I believe this is another fall out of `wildcard-refactor`, like #549. * Comment to clarify why we take the methods name location
| * Haddock support for bundled pattern synonyms (#627)Christiaan Baaij2017-06-091-15/+41
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Haddock support for bundled pattern synonyms * Add fixities to bundled pattern synonyms * Add bundled pattern synonyms to the synopsis * Store bundled pattern fixities in expItemFixities * Add test for bundled pattern synonyms * Stop threading fixities * Include bundled pattern synonyms for re-exported data types Sadly, fixity information isn't found for re-exported data types * Support for pattern synonyms * Modify tests after #631 * Test some reexport variations * Also lookup bundled pattern synonyms from `InstalledInterface`s * Check isExported for bundled pattern synonyms * Pattern synonym is exported check * Always look for pattern synonyms in the current module Another overlooked cornercase * Account for types named twice in export lists Also introduce a fast function for nubbing on a `Name` and use it throughout the code base. * correct fixities for reexported pattern synonyms * Fuse concatMap and map * Remove obsolete import * Add pattern synonyms to visible exports * Fix test * Remove corner case
| * Clear fixme comment (#625)Alex Biehl2017-05-301-3/+2
| |
| * Print any user-supplied kind signatures on type parameters.Brian Huffman2017-03-231-23/+14
| | | | | | | | | | This applies to type parameters on data, newtype, type, and class declarations, and also to forall-bound type vars in type signatures.
* | Match new AST as per GHC wip/new-tree-one-paramAlan Zimmerman2017-06-051-67/+67
|/ | | | See https://ghc.haskell.org/trac/ghc/wiki/ImplementingTreesThatGrow
* HsIParamTy now has a Located nameAlan Zimmerman2017-01-101-1/+1
|
* Matching changes for GHC wip/T12942Alan Zimmerman2016-12-121-1/+1
|
* Match changes in GHC wip/T3384 branchAlan Zimmerman2016-12-071-3/+4
|
* Add support for unboxed sumsÖmer Sinan Ağacan2016-07-211-0/+4
|
* GhcUtils: Changes for multi-pattern signaturesBen Gamari2016-07-011-16/+14
|
* Follow changes to LHsSigWcTypeSimon Peyton Jones2016-06-131-3/+1
|
* Matching changes for #12105Alan Zimmerman2016-05-291-1/+1
|
* Render Haddocks for derived instancesRyan Scott2016-05-041-0/+1
| | | | | | | | | | Currently, one can document top-level instance declarations, but derived instances (both those in `deriving` clauses and standalone `deriving` instances) do not enjoy the same privilege. This makes the necessary changes to the Haddock API to enable rendering Haddock comments for derived instances. This is part of a fix for Trac #11768.
* Merge pull request #482 from RyanGlScott/ghc-headBen Gamari2016-04-161-7/+13
|\ | | | | Collapse type/data family instances by default
| * Ensure expanded family instances render correctlyRyanGlScott2016-02-111-2/+3
| |
| * Collapse type/data family instances by defaultRyanGlScott2016-02-111-5/+10
| |
| * Update to match wip/T11430 in GHCAlan Zimmerman2016-01-151-1/+1
| |
* | Changes due to fix for GHC#11648.Richard Eisenberg2016-03-141-2/+2
| |
* | Xhtml.Decl: Show 'where ...' after closed type familyBen Gamari2016-02-181-0/+5
| | | | | | | | | | Seems like we should ideally show the actual equations as well but that seems like it would be a fair amount of work
* | Xhtml.Decl: Show kind signatures for type family variablesBen Gamari2016-02-181-4/+11
| | | | | | | | Addresses GHC #11588.
* | Xhtml.Decl: Various cleanupsBen Gamari2016-02-181-5/+6
| |
* | Update to match wip/T11430 in GHCAlan Zimmerman2016-01-161-1/+1
|/
* Merge remote-tracking branch 'origin/ghc-head' into ghc-headBen Gamari2015-12-231-5/+2
|\
| * Follow removal of NamedWildCard from HsTypeSimon Peyton Jones2015-12-221-3/+0
| |
| * Update for GHC trac#11258Alan Zimmerman2015-12-201-2/+2
| | | | | | | | Adding locations to RdrName in FieldOcc and AmbiguousFieldOcc
* | Merge remote-tracking branch 'phadej/orphans' into ghc-headBen Gamari2015-12-201-7/+26
|\ \ | |/ |/|
| * Fix orphan instance collapsingOleg Grenrus2015-09-281-7/+11
| |
| * Generate docs for orphan instancesOleg Grenrus2015-09-271-1/+16
| |
* | Fix fallout from wildcards refactoringBen Gamari2015-12-161-2/+2
| | | | | | | | | | | | | | | | | | | | | | The wildcard refactoring was introduced a new type of signature, `ClassOpSig`, which is carried by typeclasses. The original patch adapting Haddock for this change missed a few places where this constructor needed to be handled, resulting in no class methods in documentation produced by Haddock. Additionally, this moves and renames the `isVanillaLSig` helper from GHC's HsBinds module into GhcUtils, since it is only used by Haddock.
* | WarningsMatthew Pickering2015-12-141-8/+1
| |
* | Changes to compile with 8.0Matthew Pickering2015-12-141-10/+14
| |
* | Update for type=kindsRichard Eisenberg2015-12-141-8/+6
| |
* | Placeholder for record style GADT declarationAlan Zimmerman2015-12-141-3/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | A GADT Declaration is now presented as CmmCondBranch :: {..} -> CmmNode O C cml_pred :: CmmExpr cml_true, cml_false :: !Label cml_likely :: Maybe Bool for CmmCondBranch :: { -- conditional branch cml_pred :: CmmExpr, cml_true, cml_false :: ULabel, cml_likely :: Maybe Bool -- likely result of the conditional, -- if known } -> CmmNode O C
* | Matching changes for #11028Alan Zimmerman2015-12-141-78/+38
| |
* | Update to match GHC wip/T11019Alan Zimmerman2015-12-141-4/+4
| |
* | Matching change GHC #11017 BooleanFormula locatedAlan Zimmerman2015-12-141-5/+6
| |
* | More adaption to wildcard-refactorSimon Peyton Jones2015-12-141-79/+83
| |
* | Work on updating Haddock to wip/spj-wildard-recactorSimon Peyton Jones2015-12-141-11/+6
| | | | | | | | Still incomplete
* | Roughly fix up haddock for DuplicateRecordFields changesAdam Gundry2015-12-141-4/+7
| | | | | | | | | | This compiles, but will probably need more work to produce good documentation when the DuplicateRecordFields extension is used.
* | Follow changes from #6018Jan Stolarek2015-12-141-5/+37
| |
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-23 06:31:37 +0000