aboutsummaryrefslogtreecommitdiff
path: root/haddock-api/src/Haddock
Commit message (Collapse)AuthorAgeFilesLines
* outOfScope: Recommend qualifying the identifierSimon Jakobi2018-07-201-1/+3
| | | | (cherry picked from commit 73707ed58d879cc04cb644c5dab88c39ca1465b7)
* Fix broken instance source links (#869)Alec Theriault2018-07-202-19/+22
| | | | | | | | | | | | The problem manifests itself in instances that are defined in modules other than the module where the class is defined. The fix is just to thread through the 'Module' of the instance further along. Since orphan instances appear to already have been working, I didn't do anything there. (cherry picked from commit 2de7c2acf9b1ec85b09027a8bb58bf8512e91c05)
* Preserve docs on type family instances (#867)Alec Theriault2018-07-202-2/+8
| | | | | | | | | | | * Preserve docs on type family instances The only problem was that the instance location was slightly off for type family instances. * Accept output (cherry picked from commit 133e9c2c168db19c1135479f7ab144c4e33af2a4)
* tyThingToLHsDecl: Preserve type synonyms that contain a forall (#880)Simon Jakobi2018-07-201-2/+46
| | | | | | | | | | | | * tyThingToLHsDecls: Preserve type synonyms that contain a forall Fixes #879. * Add Note [Invariant: Never expand type synonyms] * Clarify Note [Invariant: Never expand type synonyms] (cherry picked from commit c3eb3f0581f69e816f9453b1747a9f2a3ba02bb9)
* Avoid line breaks due to line length in Hoogle (#868)Alec Theriault2018-07-201-3/+5
| | | | | | | | | | | | | | | * Avoid line breaks due to line length in Hoogle Hoogle operates in a line-oriented fashion, so we should avoid ever breaking due to long lines. One way of doing this non-intrusively is to modify the 'DynFlags' that are threaded through the 'Hoogle' module (note this is anyways only passed through for use in the various 'showSDoc' functions). * Amend test case (cherry picked from commit 657b1b3d519545f8d4ca048c06210d6cbf0f0da0)
* Export more fixities for Hoogle (#871)Alec Theriault2018-07-201-2/+2
| | | | | | | This exports fixities for more things, including class methods and type-level operators. (cherry picked from commit 88316b972e3d47197b1019111bae0f7f87275fce)
* Refactor handling of parens in types (#874)Alec Theriault2018-07-204-152/+191
| | | | | | | | | | | | | | | | | | | | | | | | * Fix type parenthesization in Hoogle backend Ported the logic in the HTML and LaTeX backends for adding in parens into something top-level in 'GhcUtil'. Calling that from the Hoogle backend fixes #873. * Remove parenthesizing logic from LaTeX and XHTML backends Now, the only times that parenthesis in types are added in any backend is through the explicit 'HsParTy' constructor. Precedence is also represented as its own datatype. * List out cases explicitly vs. catch-all * Fix printing of parens for QuantifiedConstraints The priority of printing 'forall' types was just one too high. Fixes #877. * Accept HTML output for quantified contexts test
* Match XFieldOcc rename in GHCAlan Zimmerman2018-07-151-1/+1
| | | | Trac #15386
* Bump GHC version to 8.7Ben Gamari2018-06-201-1/+1
|
* Remove HsEqTy and XEqTyRyan Scott2018-06-196-14/+6
|
* Match changes in GHC for #14259Alan Zimmerman2018-06-192-4/+4
|
* Revert unintentional reversion of fix of #548Ben Gamari2018-06-141-2/+23
|
* Handle -XStarIsTypeVladislav Zavialov2018-06-147-42/+27
|
* Fix redundant import warningsSimon Jakobi2018-06-135-6/+2
|
* Complete FixitySig and FamilyDecl pattern matchesSimon Jakobi2018-06-132-0/+4
|
* Renamer: Warn about ambiguous identifiers (#831)Simon Jakobi2018-06-132-5/+19
| | | | | | | | | | | | | | | | | | | * Renamer: Warn about ambiguous identifiers Example: Warning: 'elem' is ambiguous. It is defined * in ‘Data.Foldable’ * at /home/simon/tmp/hdk/src/Lib.hs:7:1 You may be able to disambiguate the identifier by qualifying it or by hiding some imports. Defaulting to 'elem' defined at /home/simon/tmp/hdk/src/Lib.hs:7:1 Fixes #830. * Deduplicate warnings Fixes #832.
* Improve hyperlinker's 'spanToNewline' (#846)Alec Theriault2018-06-131-7/+25
| | | | | | | | | | | | | | | | 'spanToNewline' is used to help break apart the source into lines which can then be partioned into CPP and non-CPP chunks. It is important that 'spanToNewline' not break apart tokens, so it needs to properly handle things like * block comments, possibly nested * string literals, possibly multi-line * CPP macros, possibly multi-line String literals in particular were not being properly handled. The fix is to to fall back in 'Text.Read.lex' to help lex things that are not comments. Fixes #837.
* Use `ClassOpSig` instead of `TypeSig` for class methods (#835)Alec Theriault2018-06-131-4/+4
| | | | | | | | * Fix minimal pragma handling Class declarations contain 'ClassOpSig' not 'Typesig'. This should fix #834. * Accept html-test output
* WibblesRyan Scott2018-06-131-3/+3
|
* Remove Hoogle backend hack that butchers infix datatype namesRyan Scott2018-06-131-2/+1
|
* Renamer: Warn about out of scope identifiers. (#819)Simon Jakobi2018-06-131-6/+11
|
* Remove 'TokenGroup' from Hyperlinker (#818)Alec Theriault2018-06-131-50/+14
| | | | | Since the hyperlinker backend now relies on the GHC tokenizer, something like 'Bar.Baz.foo' already gets bunched together into one token (as opposed to being spread across 'Bar', '.', 'Baz', '.', and 'foo').
* Filter out CRLFs in hyperlinker backend (#813)Alec Theriault2018-06-131-2/+7
| | | This prevents spurious lines from appearing in the final output.
* Remove `ITtildehsh` tokenSimon Jakobi2018-06-131-1/+0
|
* Extract docs from strict/unpacked constructor args (#839)Alec Theriault2018-06-131-0/+1
| | | This fixes #836.
* DerivingVia changesRyan Scott2018-06-133-8/+11
|
* Remove ParallelArrays and Data Parallel HaskellBen Gamari2018-06-136-10/+0
|
* Adjust to new HsDocString internalsSimon Jakobi2018-06-132-13/+12
|
* Account for refactoring of LitStringBen Gamari2018-06-131-9/+1
|
* Merge branch 'ghc-head' with 'ghc-8.4'Herbert Valerio Riedel2018-05-0115-1010/+1357
|\
| * Match changes in GHC for TTGAlan Zimmerman2018-04-2713-299/+386
| |
| * Match GHC for TTG implemented on HsBinds, D4581Alan Zimmerman2018-04-1311-79/+86
| |
| * Match GHC changes for TTGAlan Zimmerman2018-04-0911-269/+343
| |
| * Match changes in GHC for D4199Alan Zimmerman2018-04-072-2/+3
| | | | | | | | Removing HasSourceText and SourceTextX classes.
| * Updates for #13324Ryan Scott2018-03-061-1/+1
| |
| * Haddock: support splitted include paths. (#689)Tamar Christina2018-02-191-1/+3
| |
| * Use withBinaryFilealexbiehl2018-02-181-1/+1
| |
| * QuickJump: Mitigate encoding problems on Windowsalexbiehl2018-02-181-4/+5
| | | | | | | | (cherry picked from commit 86292c54bfee2343aee84559ec01f1fc68f52231)
| * Merge remote-tracking branch 'harpocrates/fix/missing-orphan-instances' into ↵Ben Gamari2018-01-262-1/+15
| |\ | | | | | | | | | ghc-head
| | * Update the GblRdrEnv when processing modulesAlec Theriault2018-01-151-0/+14
| | | | | | | | | | | | | | | Without a complete environment, we will miss some instances that were encountered during typechecking.
| | * Pass to GHC visible modules for instance filteringAlec Theriault2018-01-061-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | The GHC-side `getNameToInstancesIndex` filters out incorrectly some instances because it is not aware of what modules are visible. On the Haddock side, we need to pass in the modules we are processing. On the GHC side, we need to check against _those_ modules when checking if an instance is visible.
| * | Fix duplicate declarations and TypeFamilies specificsalexbiehl2018-01-201-17/+29
| | |
| * | extractDecl: Extract associated types correctly (#736)Alexander Biehl2018-01-191-11/+21
| | |
| * | Fix #732 (#733)Ryan Scott2018-01-191-2/+2
| | |
| * | Constructor and pattern synonym argument docs (#709)Alec Theriault2018-01-134-353/+578
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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-078-153/+105
| | | | | | | | This tracks the refactoring of HsDecl.ConDecl.
| * Bump GHC versionBen Gamari2017-12-041-1/+1
| |
* | Improve the Hoogle backend's treatment of type families (#808)Ryan Scott2018-04-241-6/+20
| | | | | | Fixes parts 1 and 2 of #806.
* | Don't treat fixity signatures like declarationsalexbiehl2018-04-201-1/+1
| |
* | @since includes package name (#749)Alec Theriault2018-03-2711-209/+290
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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.