aboutsummaryrefslogtreecommitdiff
Commit message (Collapse)AuthorAgeFilesLines
...
* | | Constructor and pattern synonym argument docs (#709)Alec Theriault2018-01-136-353/+595
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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.
* | Update changelogAlexander Biehl2017-12-061-1/+1
| |
* | Bump GHC versionBen Gamari2017-12-042-2/+2
| |
| * Replace 'attoparsec' with 'parsec' (#799)Alec Theriault2018-04-2517-2796/+363
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Remove attoparsec with parsec and start fixing failed parses * Make tests pass * Fix encoding issues The Haddock parser no longer needs to worry about bytestrings. All the internal parsing work in haddock-library happens over 'Text'. * Remove attoparsec vendor * Fix stuff broken in 'attoparsec' -> 'parsec' * hyperlinks * codeblocks * examples Pretty much all issues are due to attoparsec's backtracking failure behaviour vs. parsec's non-backtracking failure behaviour. * Fix small TODOs * Missing quote + Haddocks * Better handle spaces before/after paragraphs * Address review comments
| * Improve the Hoogle backend's treatment of type families (#808)Ryan Scott2018-04-243-6/+67
| | | | | | Fixes parts 1 and 2 of #806.
| * Add regression test for #413Ryan Scott2018-04-243-0/+22
| | | | | | | | Fixes #413.
| * Don't treat fixity signatures like declarationsalexbiehl2018-04-201-1/+1
| |
| * Travis: Build with ghc-8.4.2 (#793)Alexander Biehl2018-04-034-9/+9
| |
| * Clear search string on hide for #781 (#789)Jack Henahan2018-04-033-4/+4
| |
| * Bump haddock and haddock-api to 2.20.0alexbiehl2018-03-282-3/+3
| |
| * haddock-2.19.1, haddock-api-2.19.1, haddock-library-1.6.0alexbiehl2018-03-274-4/+10
| |
| * @since includes package name (#749)Alec Theriault2018-03-2717-266/+346
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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-232-27/+53
| | | | | | | | | | | | | | | | | | * 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.
| * Prepare changelog for next releasealexbiehl2018-03-211-0/+4
| |
| * Show where instances are defined (#748)Alec Theriault2018-03-2124-112/+530
| | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
| * Make a proper definition for the <link> parserSimon Jakobi2018-03-141-4/+6
| |
| * haddock-library.cabal: Clean up GHC optionsSimon Jakobi2018-03-141-6/+3
| |
| * fixtures: Prevent stdout bufferingSimon Jakobi2018-03-141-1/+4
| |
| * fixtures: Slightly unmangle outputSimon Jakobi2018-03-141-1/+1
| |
| * Add fixture test for inline linksSimon Jakobi2018-03-142-0/+7
| |
| * Add fixture test for linksSimon Jakobi2018-03-142-0/+6
| |
| * Add fixture test for definition listsSimon Jakobi2018-03-142-0/+2
| |
| * Readme: Update GHC version (#778)Simon Jakobi2018-03-141-2/+2
| |
| * 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
| * Haddock: Straighten out base boundalexbiehl2018-03-101-1/+1
| |
| * Bump lower bound for haddock-libraryalexbiehl2018-03-101-1/+1
| |
| * Restore backward-compat with base-4.5 through base-4.8Herbert Valerio Riedel2018-03-102-2/+28
| |
| * Update to QC 2.11Herbert Valerio Riedel2018-03-102-2/+2
| |
| * Update changelogs for haddock-2.19.0.1 and haddock-library-1.5.0.1alexbiehl2018-03-102-0/+10
| |
| * Bump haddock-2.19.0.1, haddock-api-2.19.0.1, haddock-library-1.5.0.1alexbiehl2018-03-103-9/+9
| |
| * Hyperlinker: Links for TyOps, class methods and associated typesalexbiehl2018-03-052-11/+44
| |
| * Fix Bug548 for realalexbiehl2018-03-021-1/+1
| |
| * Revert "fix test"alexbiehl2018-03-021-1/+5
| | | | | | | | This reverts commit 1ac2f9569242f6cb074ba6e577285a4c33ae1197.
| * haddock-test: Be more explicit which packages to passalexbiehl2018-03-024-7/+34
| | | | | | | | | | | | We now pass `-hide-all-packages` to haddock when invoking the testsuite. This ensures we don't accidentally pick up any dependencies up through ghc.env files.
| * fix testalexbiehl2018-03-021-5/+1
| |
| * Remove bang patternAlec Theriault2018-03-021-3/+3
| |
| * Support unicode operators, proper modulesAlec Theriault2018-03-025-25/+122
| | | | | | | | | | | | | | | | Unicode operators are a pretty big thing in Haskell, so supporting linking them seems like it outweighs the cost of the extra machinery to force Attoparsec to look for unicode. Fixes #458.
| * Make testsuite work with haddock-1.19.0 release (#766)Alexander Biehl2018-03-0274-1536/+1687
| |
| * Enable running test suite with stock haddock and ghc usingalexbiehl2018-03-021-2/+10
| | | | | | | | | | | | ``` $ cabal new-run -- html-test --haddock-path=$(which haddock) --ghc-path=$(which ghc) ```
| * 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
| |
generated by cgit v1.2.3 (git 2.39.1) at 2024-09-21 23:17:08 +0000