问题标签 [haddock]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
371 浏览

haskell - {-# OPTIONS_HADDOCK hide #-} 对未导出的模块有影响吗?

假设我有一个使用 Cabal 打包和构建的库,并且某些模块Internal不在我的 cabal 文件的Exposed-modules. 如果我指定一个编译指示,它会有什么不同吗

在顶部Internal.hs,还是已经根据 Haddock 自动隐藏?

如果它确实有所作为,它有什么影响?

0 投票
0 回答
247 浏览

haskell - 为什么 cabal 黑线鳕找不到镜头?

我有一个项目,我正在尝试镜头库。我正在尝试生成黑线鳕文档,以便我可以看到该函数生成的makeClassy TemplateHaskell函数。cabal build工作正常,但cabal haddock失败

我错过了什么?

0 投票
3 回答
1291 浏览

haskell - 如何在 Haddock 文档中嵌入图像

如何在本地Haddock文档中嵌入图像?

例如,我看到lens仅使用图像的外部链接,但我想将图像存储在本地。

(这个问题与邮件列表上的一个(未回答的)问题非常相似)。

0 投票
2 回答
354 浏览

haskell - 在 Haddock 文档中嵌入粗体标记

在使用黑线鳕标记记录 Haskell 源代码时,有没有办法获得粗体文本?有 / / 表示强调,但没有明显的表示强。我希望有一个优雅的黑客,但我会满足于一个笨拙的解决方法......

亚足联

0 投票
1 回答
17930 浏览

haskell - 以 `{- |` 开头的 Haskell 注释通常是什么意思?

{- |我看到Haskell多行注释有时以{-.

注释中以竖线字符开头是否意味着约定俗成?

0 投票
1 回答
360 浏览

haskell - Haskell记录字段上的黑线鳕

我正在尝试为界面上的记录字段编写黑线鳕。只导出了一些字段,所以我只希望记录其中的一些。我在这里阅读了文档页面:http ://www.haskell.org/haddock/doc/html/ch03s02.html#id565178

但是,我似乎无法让它发挥作用。这是我尝试编写黑线鳕的部分:

数据类型的注释正确显示在生成的黑线鳕中。但是,不会生成任何记录。我希望它为 cid、查找和修改记录生成。

提前致谢!

完整的源代码可以在这里找到:https ://github.com/jcollard/simple-server/blob/master/Network/SimpleServer.hs

0 投票
1 回答
533 浏览

haskell - 黑线鳕编号列表继续

如何使用黑线鳕文档工具继续编号列表?黑线鳕中的以下行

生成下一个html:

这打破了编号。有没有办法让黑线鳕继续在 HTML 中使用第三个数字,或者我应该尝试其他的东西(>>> 提供了一个很好的格式,为什么我想使用它)?

0 投票
2 回答
2673 浏览

haskell - Haskell中GHC.Prim中的“let x = x in x”和“data Float#”是什么意思

我查看了 GHC.Prim 的模块,发现似乎 GHC.Prim 中的所有数据都定义为data Float#没有类似的东西=A|B,而 GHC.Prim 中的所有函数都定义为gtFloat# = let x = x in x

我的问题是这些定义是否有意义以及它们的含义。

我检查了 GHC.Prim 的标题,如下所示

我想这可能与问题有关,谁能向我解释一下。

0 投票
0 回答
109 浏览

cabal - cabal:在 hsenv 下安装文档

我有一个项目的 hsenv 沙箱,我无法让 cabal install 安装库的文档。以下:

安装包,但不生成任何黑线鳕文档(仅 LICENSE 等被复制到 docs 目录)。构建日志仅包含:

即使使用verbose=3,我也无法从cabal install 中获得任何有用的信息。在 hsenv 之外,一切正常。关于如何修复或至少调试它的任何想法?

0 投票
1 回答
699 浏览

haskell - Haskell cabal:生成乳胶黑线鳕文档

我正在尝试通过 cabal 和 haddock 生成 API 文档。我希望它是乳胶的。所以我这样做:

这最终失败了:

黑线鳕有什么我能做的或者有什么问题吗?

仅供参考,我必须使用 cabal,因为构建过程相当复杂(很多预处理器,ffi 库,...)。手动调用黑线鳕真的很痛苦。

然而,构建 HTML 文档完全按预期工作。

完整的输出位于http://pastebin.com/xt6rWqde

我在用: