问题标签 [haddock]

我正在使用 hsc2hs 从 C 标头导入一堆枚举值。我的代码（简化）如下所示：

当我在我的项目上运行时，它会为声明和类型cabal haddock创建空文档块。现在我想要这些文档。只需使用黑线鳕风格的评论，如securityObjectUnknownsecurityObjectFileSecurityObjectType

干扰 hsc2hs 并使构建失败。但我想记录这些声明。我怎么能那样做？

UPD：如果我有评论，这是在构建期间生成的错误消息：

行号实际上并不匹配，因为示例已简化，但错误输出中的第 47 行对应于-- | Unknown object type一行。

挖掘生成SecurityInfo_hsc_make.c的文件清楚地显示了一个问题（这里是一个片段）：

Haskell 注释只是简单地插入到生成的 C 文件中，这显然违反了 C 语法规则。我想要的是让这些评论传播到一个自动生成的.hs文件。

在我搜索在 Unix 上使用 pandoc 时，我发现我的 SLES11 操作系统已经安装了 GHC，并且我看到 Cabal 包确实在那里。但是找不到cabal命令，所以我尝试安装cabal。当我运行引导程序时，它说找不到 Haddock（Haddock.hs 确实显示在 Distribution 文件夹中，所以我不知道为什么找不到它）。这让我想知道是否有一个简单的设置命令可以用来激活 GHC 中已经安装的 Cabal 包？然后，一旦我运行了它，我想使用我已经在 Windows 中使用的 Pandoc。

我正在尝试使用 Haddock 为我的项目生成 LaTex-documantation。一切都是用cabal（......cabal configure并且cabal build没有问题地工作）构建的。对于文档的 html 版本，一切正常。

但是当我发出cabal haddock --haddock-option=--latex它仍然构建html：

我在文件夹*.tex中转储了一些文件dist/doc/html/my_project/。生成的输出似乎已损坏：尝试构建my_project.tex会pdflatex导致大量错误消息。

我错过了什么重要的东西吗？这是通常的方式吗 - 我必须tex手动（或脚本）从 -files 构建文档？

我使用以下命令在沙箱内创建了一个 cabal 库：

我添加了这一行documentation: True以cabal.config确保生成文档，并vector在mylib.cabal. 然后我跑了：

我得到以下输出：

到目前为止，一切都很好。

当我打开索引文件时，它包含指向很多包的链接，例如：

但是这些链接指向任何真实文件。请注意，对于像vector内置包列表这样的额外依赖项也是如此Data.List。

所以我认为我错误地安装了文档。有人能指出我如何错误地安装了文档以及如何正确地安装吗？

由于相互依赖的导入，我不得不移动模块中的类实例Instances和模块中的数据类型Types。这两个模块的定义然后由包的主模块重新导出。

Haddock 列出了我的类型的类实例派生的类实例，deriving但所有其他实例都丢失了（尽管它们似乎正确导出和工作）。这是正常的还是应该列出来？我能做些什么？

如果需要，这是包。

谢谢你。

我尝试使用 haddock 为库生成文档，虽然它可以工作，但它不会链接任何属于 GHC/标准库的类型并发出此错误：

现在我四处搜索，发现解决方案将尝试重新安装这些软件包，haddock install array-0.4.0.1 base-4.6.0.1 binary-0.5.1.1 rts-1.0 bytestring-0.10.0.2 containers-0.5.0.0 deepseq-1.3.0.1 ghc-prim-0.3.0.0 integer-gmp-0.5.0.0 utf8-string-1 --enable-documentation但它失败了

甚至没有找到一个名为 rts 的包。到底是怎么回事？

根据此评论，您可以使 cabal-install 也超链接您正在安装的软件包的源。它把这些来源放在哪里？我是否需要启用任何其他选项或包来获取它们？

我的配置中确实有hyperlink-source: True。我添加了标志只是为了多余。当我查找文档时，它都是彩色的，但源代码没有链接。我究竟做错了什么？

好的，所以在“为什么 Cabal 不超链接我的资源？ ”中，我发现我需要 haddock 2.16.2 才能使用cabal install --haddock-hyperlink-source. 所以，我通过克隆它从 gitHub 安装它，并cabal install -j在 repo 中运行，它说

虽然它似乎没有安装。首先，cabal install --haddock-hyperlink-source仍然没有超链接我的文档。也ghc-pkg haddock根本没有看到黑线鳕。如果我运行haddock --version，它仍然显示 2.16.1。同样的事情~/.cabal/bin/haddock --version。当我这样做时cabal install haddock，它不会警告重新安装，但会注意到出现了问题haddock-api。

如何安装 gitHub 版本Haddock？

我正在 Windows 8 上使用 Stack 0.1.3.1 创建一个新的 Haskell 项目。我的stack.yaml文件如下所示：

当我运行stack buildorstack test时，一切正常。我可以从命令行haddock手动运行，也可以。但是当我运行时，stack haddock我得到这样的输出：

显然这是胡说八道——我不应该添加base到我extra-deps的 . 这里发生了什么？

更新：正如下面的答案中所讨论的，这似乎是堆栈中的一个错误，应该在较新的版本中修复。请参阅https://github.com/fpco/minghc/issues/85。