8

事实证明,Haddock 不会为类型类方法呈现每个参数的文档:

class Foo a where

  foo
    :: Int -- ^ This string will be ignored by Haddock
    -> a

这会给我维护的库的用户带来某些问题,因为在我的案例中,这些方法的签名很长。我一直将源中的描述格式化为这样(当然适用于普通函数),但事实证明 Haddock 没有显示它们(也没有抱怨它们)。

有没有办法用 Haddock 显示每个参数的文档?也许一些解决方法?

4

1 回答 1

3

好吧,这是一个回归。这个东西应该可以工作(并且在 2.16.1 版本中工作),但停止了(2.17.1 及更高版本)。

我已经报告了这个:https://github.com/haskell/haddock/issues/647,应该在 2.18 版本中修复(你可以看到已经有一个 PR)。

于 2017-06-29T17:34:09.183 回答