Although we do not really need it in the interface file serialisation,
as the deserialisation uses `getWithUserData`, we need to mirror the
structure `getWithUserData` expects. Thus, we write essentially an empty
`IfaceType` table at the end of the file, as the interface file doesn't
reference `IfaceType`.

The accompanies haddoc PR with GHC PR ghc/ghc!12153
Two things have been done:
1. Link is introduced to every `X` in `module X where`, since we introduce the module name to HieAst,
2. `{-# LINE 4 "hypsrc-test/src/PositionPragmas.hs" #-}` is added before the `module PositionPragmas where` in ` hypsrc-test/ref/src/PositionPragmas.html `.It ensures only a single hieAst for file `hypsrc-test/src/PositionPragmas.hs` is generated.

Previously many declarations (e.g. `Int`) were declared to have a "home"
in `Prelude`. However, now Haddock instead chooses to put these in
more specific homes (e.g. `Data.Int`). Given that the "home" decision is
driven by heuristics and in general these changes seem
quite reasonable I am accepting them:

 * `Int` moved from `Prelude` to `Data.Int`
 * `(~)` moved from `Prelude` to `Data.Type.Equality`
 * `Type` moved from `GHC.Types` to `Data.Kind`
 * `Maybe` moved from `Prelude` to `Data.Maybe`
 * `Bool` moved from `Prelude` to `Data.Bool`
 * `Ordering` moved from `Prelude` to `Data.Ord`

As well, more identifiers are now hyperlinked; it's not immediately
clear *why*, but it is an improvement nevertheless.

Here we extend Haddock to admit `@since` annotations in export lists.
These can be attached to most export list items (although not
subordinate lists). These annotations supercede the declaration's
`@since` annotation in produced Haddocks.

Match GHC

- EPA: Comments in AnchorOperation
- EPA: Remove EpaEofComment

This prevents `data FUN` from being shown at the top of the Prelude docs. Fixes
\#23920 on GHC.

Matthew Pickering authored 1 year ago and sheaf committed 1 year ago

When a class method was reexported, it's default methods were also
showing up in the generated html page.

The simplest and most non-invasive fix is to not look for the default
method if we are just exporting the class method.. because the backends
are just showing default methods when the whole class is exported.

In general it would be worthwhile to rewrite this bit of code I think as
the logic and what gets included is split over `lookupDocs` and
`availExportDecl` it would be clearer to combine the two. The result of
lookupDocs is always just passed to availExportDecl so it seems simpler
and more obvious to just write the function directly.

Vladislav Zavialov authored 1 year ago and sheaf committed 1 year ago

The old reasoning no longer applies, nowadays those names can be
mentioned in export lists.