aboutsummaryrefslogtreecommitdiff
path: root/haddock-api/src/Haddock/Backends/Xhtml
Commit message (Collapse)AuthorAgeFilesLines
* Merge branch 'ghc-head' with 'ghc-8.4'Herbert Valerio Riedel2018-05-012-190/+342
|\
| * Match changes in GHC for TTGAlan Zimmerman2018-04-271-18/+31
| |
| * Match GHC for TTG implemented on HsBinds, D4581Alan Zimmerman2018-04-131-10/+10
| |
| * Match GHC changes for TTGAlan Zimmerman2018-04-091-35/+36
| |
| * Constructor and pattern synonym argument docs (#709)Alec Theriault2018-01-132-133/+272
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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.
* | @since includes package name (#749)Alec Theriault2018-03-273-119/+135
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Metadoc stores a package name This means that '@since' annotations can be package aware. * Get the package name the right way This should extract the package name for `@since` annotations the right way. I had to move `modulePackageInfo` around to do this and, in the process, I took the liberty to update it. Since it appears that finding the package name is something that can fail, I added a warning for this case. * Silence warnings * Hide package for local 'since' annotations As discussed, this is still the usual case (and we should avoid being noisy for it). Although this commit is large, it is basically only about threading a 'Maybe Package' from 'Haddock.render' all the way to 'Haddock.Backends.Xhtml.DocMarkup.renderMeta'. * Bump binary interface version * Add a '--since-qual' option This controls when to qualify since annotations with the package they come from. The default is always, but I've left an 'external' variant where only those annotations coming from outside of the current package are qualified. * Make ParserSpec work * Make Fixtures work * Use package name even if package version is not available The @since stuff needs only the package name passed in, so it makes sense to not be forced to pass in a version too.
* | Show where instances are defined (#748)Alec Theriault2018-03-212-13/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | * Indicate source module of instances Above instance, we now also display a link to the module where the instance was defined. This is sometimes helpful in figuring out what to import. * Source module for type/data families too * Remove parens * Accept tests
* | Teach the HTML backend how to render methods with multiple namesalexbiehl2018-02-191-6/+6
| |
* | Add module tooltips to linked identifiers (#753)Alec Theriault2018-02-111-3/+5
| | | | | | No more clicking to figure out whether your bytestring is strict or lazy!
* | Grid Tables (#718)Oleg Grenrus2018-02-011-1/+18
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add table examples * Add table types and adopt simple parser Simple parser is done by Giovanni Cappellotto (@potomak) in https://github.com/haskell/haddock/pull/577 It seems to support single fine full tables, so far from full RST-grid tables, but it's good start. Table type support row- and colspans, but obviously parser is lacking. Still TODO: - Latex backend. Should we use multirow package https://ctan.org/pkg/multirow?lang=en? - Hoogle backend: ? * Implement grid-tables * Refactor table parser * Add two ill-examples * Update CHANGES.md * Basic documentation for tables * Fix documentation example
* 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
|
* Merge remote-tracking branch 'origin/master' into ghc-headalexbiehl2017-10-314-28/+55
|\
| * Put Quickjump behind --quickjump flag (#697)Alexander Biehl2017-10-301-7/+7
| |
| * Add QuickJump version to meta.json (#696)Alexander Biehl2017-10-301-0/+28
| |
| * Use <details> element for collapsibles (#690)Tim Baumann2017-10-093-28/+27
| | | | | | | | | | | | | | | | | | | | | | * Remove unnecessary call to 'collapseSection' The call is unnecessary since there is no corresponding toggle for hiding the section of orphan instances. * Use <details> for collapsibles This makes them work even when JS is disabled. Closes #560.
* | 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-213-148/+198
|\|
| * 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
| * Move `DocMarkup` from haddock-api to haddock-library (#659)Alexander Biehl2017-07-311-0/+1
| | | | | | | | | | | | | | | | | | | | * Move `DocMarkup` from haddock-api to haddock-library * Move more markup related functions * Markup module * CHANGELOG
| * 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-092-15/+45
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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-122-2/+2
|
* Match changes in GHC wip/T3384 branchAlan Zimmerman2016-12-071-3/+4
|
* Add support for unboxed sumsÖmer Sinan Ağacan2016-07-212-1/+9
|
* GhcUtils: Changes for multi-pattern signaturesBen Gamari2016-07-011-16/+14
|
* Follow changes to LHsSigWcTypeSimon Peyton Jones2016-06-131-3/+1
|
* Merge pull request #512 from phadej/oleg-fixesSebastian Méric de Bellefon2016-06-061-2/+1
|\ | | | | Fixes for #508 and #510
| * UnfelpfulSpan line number omittedOleg Grenrus2016-05-241-2/+1
| | | | | | | | Kind of resolves https://github.com/haskell/haddock/issues/508
| * Ensure expanded family instances render correctlyRyanGlScott2016-04-162-3/+4
| | | | | | | | (cherry picked from commit 1338b5d7c32939de6bbc31af0049477e4f847103)
| * Collapse type/data family instances by defaultRyanGlScott2016-04-162-10/+23
| | | | | | | | (cherry picked from commit 2da130a8db8f995c119b544fad807533236cf088)
| * Changes due to fix for GHC#11648.Richard Eisenberg2016-03-151-2/+2
| | | | | | | | (cherry picked from commit bb994de1ab0c76d1aaf1e39c54158db2526d31f1)
* | Matching changes for #12105Alan Zimmerman2016-05-292-2/+2
| |
* | 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-162-12/+26
|\ \ | | | | | | Collapse type/data family instances by default
| * | Ensure expanded family instances render correctlyRyanGlScott2016-02-112-3/+4
| | |
| * | Collapse type/data family instances by defaultRyanGlScott2016-02-112-10/+23
| | |
| * | 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
| |
generated by cgit v1.2.3 (git 2.39.1) at 2024-09-21 20:31:33 +0000