aboutsummaryrefslogtreecommitdiff
path: root/haddock-api/src/Haddock
Commit message (Collapse)AuthorAgeFilesLines
...
* | 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.
* | Useful cost centres, timers and allocation counters (#785)Alexander Biehl2018-03-231-7/+14
| | | | | | | | | | | | | | | | | | * Add some useful cost-centres for profiling * Add withTiming for each haddock phase Invoking haddock with `--optghc=-ddump-timings` now shows the amount of time spent and the number of allocated bytes for each phase.
* | Show where instances are defined (#748)Alec Theriault2018-03-216-23/+35
| | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* | extractDecl: Extract constructor patterns from data family instances (#776)Alexander Biehl2018-03-131-13/+26
| | | | | | | | | | | | * extractDecl: Allow extraction of data family instance constructors * extractDecl: extract data family instance constructors
* | Hyperlinker: Links for TyOps, class methods and associated typesalexbiehl2018-03-051-1/+14
| |
* | Fix file handle leak (#763) (#764)Alec Theriault2018-02-251-3/+6
| | | | | | | | Brought back some mistakenly deleted code for handling encoding and eager reading of files from e0ada1743cb722d2f82498a95b201f3ffb303137.
* | Hoogle/Latex: Remove use of partial functionAlexander Biehl2018-02-192-7/+5
| |
* | Teach the HTML backend how to render methods with multiple namesalexbiehl2018-02-192-31/+7
| |
* | Add 'show' option to complement 'hide' (#752)Alec Theriault2018-02-112-10/+17
| | | | | | | | | | | | | | | | | | | | | | | | * Add 'show' option to complement 'hide' The behaviour is for flags passed in the command line to override flags in file headers. In the command line, later flags override earlier ones. Fixes #751 and #266. * Add a '--show-all' option
* | 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!
* | Expand SigD in a better placealexbiehl2018-02-091-2/+2
| | | | | | | | | | | | | | | | In https://github.com/haskell/haddock/issues/287 we found that haddock-2.19.0 would miss documentation on class methods with multiples names. This patch uses expandSigDecls in a more sensible place.
* | Hyperlinker: Also link pattern synonym argumentsalexbiehl2018-02-061-2/+5
| |
* | fullModuleContents: support named docsalexbiehl2018-02-061-16/+24
| |
* | Expand SigDsalexbiehl2018-02-061-2/+26
| |
* | Rename: renameHsSpliceTy ttgalexbiehl2018-02-061-1/+1
| |
* | Don't barf on 'HsSpliceTy' (#745)Alec Theriault2018-02-061-1/+12
| | | | | | | | | | | | | | | | This handles 'HsSpliceTy's by replacing them with what they expand to. IIUC everything that is happening, 'renameHsSpliceTy' should not be able to fail for the inputs we feed it from GHC. This fixes #574.
* | Don't warn about missing '~' (#746)Alec Theriault2018-02-061-5/+14
| | | | | | | | | | | | | | This manually filters out '~' from the list of things to warn about. It truly makes no sense to warn on this since '~' has nothing it could link to - it is magical. This fixes #532.
* | 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.
* | Add `SPDX-License-Identifier` as alised for "license" module header tokensHerbert Valerio Riedel2018-02-051-5/+6
| | | | | | | | | | | | | | | | | | | | | | C.f. SPDX 2.1 - Appendix V https://spdx.org/spdx-specification-21-web-version#h.twlc0ztnng3b The tag should appear on its own line in the source file, generally as part of a comment. SPDX-License-Identifier: <SPDX License Expression> Cherry-picked from #743
* | 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-014-4/+1
| |
* | Convert: Correct pass typeAlexander Biehl2018-02-011-2/+1
| |
* | Specialize: Add missing IdP annotationsAlexander Biehl2018-02-011-2/+2
| |
* | Hyperlinker: Adjust parser to new PFailed constructorAlexander Biehl2018-02-011-8/+8
| |
* | Fix infinite loop when specializing instance heads (#723)Alec Theriault2018-02-011-10/+10
| | | | | | | | | | | | | | | | | | * Fix infinite loop when specializing instance heads The bug can only be triggered from TH, hence why it went un-noticed for so long. * Add test for #679 and #710
* | Grid Tables (#718)Oleg Grenrus2018-02-016-3/+66
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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-015-250/+374
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* | Fix #548 by rendering datatype kinds more carefully (#702)Ryan Scott2018-02-011-3/+24
| |
* | Update the GblRdrEnv when processing modulesAlec Theriault2018-02-011-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-02-011-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
|/
* Revert "Match changes for Trees that Grow in GHC"Ben Gamari2017-11-2111-300/+262
| | | | This reverts commit 01eeeb048acd2dd05ff6471ae148a97cf0720547.
* Revert "Match Trees That Grow"Ben Gamari2017-11-213-7/+5
| | | | This reverts commit 73a26af844ac50b8bec39de11d64452a6286b00c.
* 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-218-49/+46
| | | | This reverts commit 134a7bb054ea730b13c8629a76232d73e3ace049.
* Clean up use of PlaceHolder, to match TTGAlan Zimmerman2017-11-148-46/+49
|
* Actually render infix type operators as infix (#703)Ryan Scott2017-11-141-6/+17
| | | | | | * Actually render infix type operators as infix * Account for things like `(f :*: g) p`, too
* Match Trees that Grow in GHC for HsExprAlan Zimmerman2017-11-111-2/+2
|
* Match Trees That GrowAlan Zimmerman2017-11-083-5/+7
|
* Match changes for Trees that Grow in GHCAlan Zimmerman2017-11-0711-258/+296
|
* Always return documentation for exported subordinatesalexbiehl2017-11-021-12/+17
| | | | | | | ... event if they have no documentation (e.g. noDocForDecl) By using the information in the AvailInfo we don't need additional export checks.
* Make better use of AvailInfoalexbiehl2017-11-011-57/+72
|
* Remove excessive use of list comprehensionsalexbiehl2017-10-311-12/+7
|
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-11 23:41:38 +0000