| Commit message (Collapse) | Author | Age | Files | Lines |
|
|
| |
Fixes parts 1 and 2 of #806.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
* 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.
|
|
|
|
|
|
|
|
|
| |
* 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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
* 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: Allow extraction of data family instance constructors
* extractDecl: extract data family instance constructors
|
| |
|
|
|
|
| |
Brought back some mistakenly deleted code for handling encoding and eager
reading of files from e0ada1743cb722d2f82498a95b201f3ffb303137.
|
| |
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
| |
* 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
|
|
|
| |
No more clicking to figure out whether your bytestring is strict or lazy!
|
|
|
|
|
|
|
|
| |
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.
|
| |
|
| |
|
| |
|
| |
|
|
|
|
|
|
|
|
| |
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.
|
|
|
|
|
|
|
| |
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.
|
|
|
|
|
|
| |
Links to pattern synonyms are now generated, as well as links from
modules in import lists.
Fixes #731.
|
|
|
|
|
|
|
|
|
|
|
| |
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
|
| |
|
| |
|
| |
|
|
|
|
|
|
| |
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.
|
| |
|
| |
|
| |
|
| |
|
|
|
| |
This fixes #666.
|
|
|
|
|
|
|
|
|
| |
* 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
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
* 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
|
|
|
|
| |
See #579. This just adds an <a> tag around the heading, pointing to the
heading itself.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
* 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
|
| |
|
|
|
|
|
| |
Without a complete environment, we will miss some instances that were
encountered during typechecking.
|
|
|
|
|
|
|
|
|
| |
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.
|
| |
|
| |
|
|
|
|
| |
This reverts commit 01eeeb048acd2dd05ff6471ae148a97cf0720547.
|
|
|
|
| |
This reverts commit 73a26af844ac50b8bec39de11d64452a6286b00c.
|
|
|
|
| |
This reverts commit 9f054dc365379c66668de6719840918190ae6e44.
|
|
|
|
| |
This reverts commit 134a7bb054ea730b13c8629a76232d73e3ace049.
|
| |
|
|
|
|
|
|
| |
* Actually render infix type operators as infix
* Account for things like `(f :*: g) p`, too
|
| |
|
| |
|
| |
|
|
|
|
|
|
|
| |
... event if they have no documentation (e.g. noDocForDecl)
By using the information in the AvailInfo we don't need additional
export checks.
|
| |
|