haskell - Haddock - 链接到外部模块中的功能(导入整个模块)

Question

假设我有一个名为 MyModule 的 Haskell 模块导入 外部 像这样的模块:

import ModuleA hiding (a, b, c)

而我 不能修改此导入语句，因为该程序不完全是我的。

我想链接到 ModuleA.external_function在 ModuleA 的文档中，在上面的注释中，一个名为 my_function 的函数.所以代码看起来像这样:

-- | my_function makes use of 'ModuleA.external_function'
my_function :: Int -> Int

使用黑线鳕 2.10.0，并运行 cabal haddock ，链接到 ModuleA.external_function生成为 dist/doc/html/MyModule/ModuleA.html#v:external_function .但是，问题在于 dist/doc/html/MyModule/ModuleA.html文件不存在。

如何生成指向 ModuleA 的文档的链接相反，如 module-A-package/docs/ModuleA.html#v:external_function .换句话说，类似于 http://hackage.haskell.org/package/text-0.11.2.0/docs/Data-Text.html有链接到 String类型(它们链接到 http://hackage.haskell.org/package/base-4.5.0.0/docs/Data-String.html#t:String )？请记住，我 不能修改 import陈述。

谢谢你。

Answer 1

要在 Haddock 文档中链接到外部包，您需要 指示它在哪里可以找到文档 对于那些包。

它是通过使用 --read-interface 来完成的。黑线鳕命令行选项。

使用您的示例，它将是:

haddock --read-interface module-A-package/docs/,module-A-package/docs/module-A-package.haddock

.黑线鳕文件是在为包生成文档时创建的 模块 A 包 使用 ----dump-interface黑线鳕命令行选项。

更多信息请访问 the Haddock documentation或 this HaskellWiki page .