aboutsummaryrefslogtreecommitdiff
path: root/haddock-api/src/Haddock/Backends
Commit message (Collapse)AuthorAgeFilesLines
* Output pattern synonyms in Hoogle backend (#947)Alec Theriault2018-10-161-8/+13
| | | | | | | | | | | * Output pattern synonyms in Hoogle backend We were previously weren't outputting _any_ pattern synonyms, bundled or not. Now, we output both. Fixes #946. * Update changelog
* Latex type families (#734)Alec Theriault2018-10-162-144/+209
| | | | | | | | | | | | | | | | | | | | * Support for type families in LaTeX The code is ported over from the XHTML backend. * Refactor XHTML and LaTeX family handling This is mostly a consolidation effort: stripping extra exports, inlining some short definitions, and trying to make the backends match. The LaTeX backend now has preliminary support for data families, although the only the data instance head is printed (not the actual constructors). Both backends also now use "newtype" for newtype data family instances. * Add some tests
* Update the ghc-8.6 branch (#889)Simon Jakobi2018-07-204-176/+124
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Revert "Bump GHC version to 8.6" This was applied to the wrong branch; there's now a `ghc-8.6` branch; ghc-head is always supposed to point to GHC HEAD, i.e. an odd major version. The next version bump to `ghc-head` is supposed to go from e.g. 8.5 to 8.7 This reverts commit 5e3cf5d8868323079ff5494a8225b0467404a5d1. * README updates (#856) * README: Remove mentions of master branch * README: Add instructions for using html-test * README: Change command to run _all_ the testsuites * README: Add project overview section (cherry picked from commit 61d6f935da97eb96685f07bf385102c2dbc2a33c) * Export more fixities for Hoogle (#871) This exports fixities for more things, including class methods and type-level operators. (cherry picked from commit 88316b972e3d47197b1019111bae0f7f87275fce) * Avoid line breaks due to line length in Hoogle (#868) * 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) * tyThingToLHsDecl: Preserve type synonyms that contain a forall (#880) * 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) * Fix HEAD html-test (#860) * Update tests for 'StarIsType' * Accept tests * Revert "Update tests for 'StarIsType'" This reverts commit 7f0c01383bbba6dc5af554ee82988d2cf44e407a. * Refactor handling of parens in types (#874) * 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 * Preserve docs on type family instances (#867) * 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) * Fix broken instance source links (#869) 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) * Add some more unicode related tests (#872) This has been fixed for sure ever since we switched from attoparsec to parsec. Parts of it may have been working before that, but there was a point where this would have failed (see #191). A regression test never hurt anyone. :) (cherry picked from commit 5ec7715d418bfac0f26aec6039792a99a6e89370) * Misc tests (#858) * More tests * spliced types * constructor/pattern argument docs * strictness marks on fields with argument docs * latex test cases need seperate directory * Accept tests * Additional tests for the identifier parser (#816) * Add tests for the identifier parser * docs: Clarify how to delimit identifiers (cherry picked from commit 0861affeca4d72938f05a2eceddfae2c19199071)
* Remove HsEqTy and XEqTyRyan Scott2018-06-192-9/+1
|
* Handle -XStarIsTypeVladislav Zavialov2018-06-143-13/+18
|
* Fix redundant import warningsSimon Jakobi2018-06-131-1/+1
|
* Complete FixitySig and FamilyDecl pattern matchesSimon Jakobi2018-06-132-0/+4
|
* 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
|
* 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
|
* DerivingVia changesRyan Scott2018-06-131-6/+1
|
* Remove ParallelArrays and Data Parallel HaskellBen Gamari2018-06-133-7/+0
|
* Account for refactoring of LitStringBen Gamari2018-06-131-9/+1
|
* Merge branch 'ghc-head' with 'ghc-8.4'Herbert Valerio Riedel2018-05-016-547/+710
|\
| * Match changes in GHC for TTGAlan Zimmerman2018-04-275-57/+76
| |
| * Match GHC for TTG implemented on HsBinds, D4581Alan Zimmerman2018-04-134-27/+27
| |
| * Match GHC changes for TTGAlan Zimmerman2018-04-094-88/+89
| |
| * Match changes in GHC for D4199Alan Zimmerman2018-04-071-1/+2
| | | | | | | | Removing HasSourceText and SourceTextX classes.
| * Use withBinaryFilealexbiehl2018-02-181-1/+1
| |
| * QuickJump: Mitigate encoding problems on Windowsalexbiehl2018-02-181-4/+5
| | | | | | | | (cherry picked from commit 86292c54bfee2343aee84559ec01f1fc68f52231)
| * Constructor and pattern synonym argument docs (#709)Alec Theriault2018-01-133-339/+549
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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-073-93/+26
| | | | | | | | This tracks the refactoring of HsDecl.ConDecl.
* | 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-274-172/+192
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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-213-15/+19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* | Hyperlinker: Links for TyOps, class methods and associated typesalexbiehl2018-03-051-1/+14
| |
* | Hoogle/Latex: Remove use of partial functionAlexander Biehl2018-02-192-7/+5
| |
* | 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!
* | Hyperlinker: Also link pattern synonym argumentsalexbiehl2018-02-061-2/+5
| |
* | Hyperlink pattern synonyms and 'module' imports (#744)Alec Theriault2018-02-051-4/+10
| | | | | | | | | | | | Links to pattern synonyms are now generated, as well as links from modules in import lists. Fixes #731.
* | Use withBinaryFilealexbiehl2018-02-041-1/+1
| |
* | QuickJump: Mitigate encoding problems on Windowsalexbiehl2018-02-031-4/+5
| |
* | Support the new 'ITcolumn_prag' tokenAlec Theriault2018-02-021-0/+2
| |
* | Properly color pragma contents in hyperlinkerAlec Theriault2018-02-021-13/+65
| | | | | | | | | | | | The hyperlinker backend now classifies the content of pragmas as 'TkPragma'. That means that in something like '{-# INLINE foo #-}', 'foo' still gets classified as a pragma token.
* | Warning free compilationAlexander Biehl2018-02-011-1/+0
| |
* | Hyperlinker: Adjust parser to new PFailed constructorAlexander Biehl2018-02-011-8/+8
| |
* | Grid Tables (#718)Oleg Grenrus2018-02-013-3/+24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* | Clickable anchors for headings (#716)Alec Theriault2018-02-011-1/+2
| | | | | | | | See #579. This just adds an <a> tag around the heading, pointing to the heading itself.
* | Use the GHC lexer for the Hyperlinker backend (#714)Alec Theriault2018-02-014-238/+362
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Start changing to use GHC lexer * better cpp * Change SrcSpan to RealSrcSpan * Remove error * Try to stop too many open files * wip * wip * Revert "wip" This reverts commit b605510a195f26315e3d8ca90e6d95a6737553e1. Conflicts: haddock-api/haddock-api.cabal haddock-api/src/Haddock/Interface.hs * Remove pointless 'caching' * Use dlist rather than lists when finding vars * Use a map rather than list * Delete bogus comment * Rebase followup Things now run using the GHC lexer. There are still - stray debug statements - unnecessary changes w.r.t. master * Cleaned up differences w.r.t. current Haddock HEAD Things are looking good. quasiquotes in particular look beautiful: the TH ones (with Haskell source inside) colour/link their contents too! Haven't yet begun to check for possible performance problems. * Support CPP and top-level pragmas The support for these is hackier - but no more hacky than the existing support. * Tests pass, CPP is better recognized The tests were in some cases altered: I consider the new output to be more correct than the old one.... * Fix shrinking of source without tabs in test * Replace 'Position'/'Span' with GHC counterparts Replaces 'Position' -> 'GHC.RealSrcLoc' and 'Span' -> 'GHC.RealSrcSpan'. * Nits * Forgot entry in .cabal * Update changelog
* Revert "Match changes for Trees that Grow in GHC"Ben Gamari2017-11-214-86/+85
| | | | This reverts commit 01eeeb048acd2dd05ff6471ae148a97cf0720547.
* Revert "Match Trees that Grow in GHC for HsExpr"Ben Gamari2017-11-211-2/+2
| | | | This reverts commit 9f054dc365379c66668de6719840918190ae6e44.
* Revert "Clean up use of PlaceHolder, to match TTG"Ben Gamari2017-11-213-6/+6
| | | | This reverts commit 134a7bb054ea730b13c8629a76232d73e3ace049.
* Clean up use of PlaceHolder, to match TTGAlan Zimmerman2017-11-143-6/+6
|
* Match Trees that Grow in GHC for HsExprAlan Zimmerman2017-11-111-2/+2
|
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-16 00:52:15 +0000