New annotation request: @include

[yaitskov]

New annotation request: @include

[Kleidukos]

Thanks a lot for the suggestion. :)

[yaitskov]

In GHC9 a workaround with TH is available, but it is limited to source functions defined in the same package, at least I have such experience with GHC-9.2.5 and cabal haddock --haddock-all:

appendHaddocksFrom ::
  Name -> -- ^ sourceName
  Name -> -- ^ targetName
  Q [Dec]
appendHaddocksFrom sourceName targetName = do
  addModFinalizer $ do
    srcDocsM <- getDoc $ DeclDoc sourceName
    case srcDocsM of
      Nothing -> do
        runIO (putStrLn $ "no src docs (" <> show sourceName <> ")")
        pure ()
      Just sd -> do
        targetDocs <- fromMaybe "" <$> getDoc target
        runIO (putStrLn $ "target docs: (" <> show target <> "):\n" <> targetDocs)
        putDoc target $ targetDocs <>
          "\n\n### __Following snippet is included from__ " <>
          nameRef sourceName <> "\n\n" <> sd
  pure []
  where
    target = DeclDoc targetName

module SupModule where
-- | 'foo' has haddocks in public domain
foo :: Int
foo = 3

module Module where
import SupModule
bar :: Int
bar = foo
$(appendHaddocksFrom 'foo 'bar)