问题标签 [haddock]

在MonadState 文档页面中，实例ReaderT类型中有一个星号 (*) ：MonadState

但实际上在源代码中，没有星号：

那么文档中的星是什么意思呢？

我无法让黑线鳕显示我的数据记录的字段名称。我的一些数据类型有许多不同的数值，所以记录名称是关键。

示例数据记录：

有问题的数据类型是这样导出的：

对于这个定义（以及所有其他类似的定义），生成的唯一文档是构造函数的类型签名。但是，没有生成所涉及的值的解释。

一个可能相关的细节是我DuplicateRecordFields在这个文件中启用了。

我是在犯一个明显的错误，还是只是遗漏了什么？很高兴提供任何其他有用的信息。

是否可以为使用别名标识符重新导出的模块生成黑线鳕生成文档？

我有以下两个模块：

模块A：

模块B：

然后，如果我通过第三个模块重新导出Aand ，如下所示：BLib

AHaddock 为和生成文档B。但是，如果我将代码更改为Lib：

虽然导致Lib导出 and 的定义A，B但黑线鳕会抱怨它无法找到以下文档X：

有没有办法为别名生成A文档B？

servant我使用越来越大的 Web API 构建了一个 Web API 。

我知道自动为 api 创建文档的两种方法。

首先，有黑线鳕。Haddock 将我的代码变成了超链接的 HTML 页面。整洁的！这特别有用，因为我的 api 端点往往会扩展到多个模块，现在我可以浏览它们并找到相关的类型信息。

但是，haddock并不完全有办法正确显示这些行：

黑线鳕把它变成了这样的东西：

...甚至添加括号。具有讽刺意味的是，代码中的格式更漂亮，仅仅是因为换行符。

二是有servant-docs。然而，servant-docs相当一致地构建端点的文档，带有很好的钩子来添加例如以 JSON 显示的示例。Servant-docs不旨在提供haskell类型信息——这就是我所追求的。

所以要么，我找到一种方法来haddock以一种漂亮的方式显示长类型，或者我找到一种方法来显示 haskell 类型servant-docs。

在这两种情况下，它似乎都不适合他们的设计。我可能完全需要别的东西。

我已经尝试过的haddock：

它是有效的haskell，但评论被忽略haddock。使用 haddock 标题语法--|或-- *导致 haddock 编译错误。

我迷路了。我不明白如何使用 cabal 在本地生成文档。我想要的是 cabal install gtk3 ，它也会生成文档。或者如果这不起作用我如何在本地生成文档？

我已经把它从 cabal 放到了我的 .config 文件中： -- 文档：True

但是做的不好，找不到文档

我想这很简单，我根本看不到....

好的，在一些评论的帮助下，我走得更远了。无论如何，cabal 只是为我作为用户进行本地安装，它给了我一个警告，不推荐使用 global。在这里我找到了https://wiki.haskell.org/Cabal-Install

我应该为全局安装等做些什么，但如果我不使用它，我会收到有关不应使用全局的警告，即使使用文档集做文档：True 我没有得到 haskell 的更新平台文档。

所以我不应该使用 cabal 来全局安装文件？

有没有办法为特定的包构建黑线鳕文档？我正在尝试单独为我的包/应用程序构建黑线鳕，但以下命令似乎也在为所有依赖项执行此操作：

（webservice我的包/应用程序的名称在哪里）

我正在使用以下方法为我的 Haskell 库生成文档：

结果index.html页面有一个空的签名部分。

为什么签名部分是空的？

我似乎无法让这个嵌入在 Haskell 注释中的简单 LaTeX 代码在通过带有 HTML 目标的 Haddock 运行时正确呈现：

当我通过 Haddock 运行包含上述注释的 Haskell 代码时，我在浏览器中看到了这个：

[开始{eqnarray} y &=& f(x) z &=& g(y)

结束{eqnarray} ]

如果我去掉第三行末尾的双反斜杠，那么两个方程都可以正确渲染，但它们一个接一个地出现在同一行。

在编写用于Haddock处理的LaTeX时，有谁知道分隔eqnarray行的正确方法？

我可以为隐藏成员生成 Haddock 文档吗？我的用例是我有一个类型T显示在某些函数的签名中。例如f :: T -> U，g :: T -> U. 我希望我图书馆的用户知道T它的用途，而不是实际导出它。是否有意义？这可能吗？

从如何在构建黑线鳕时排除依赖关系？我陷入了以下循环：

1. 运行以下命令：stack haddock --no-haddock-deps webservice
2. 等待webservice建库
3. Haddock 然后从第一个源文件开始处理
4. Haddock 因与评论相关的一些微不足道的解析错误而失败
5. 修复此类解析错误
6. 转到步骤 1

有没有办法让堆栈/黑线鳕从出错的地方开始，而不需要经过上面的步骤（2）和（3）？