事实证明,Haddock不会为类型类呈现每个参数的文档
方法:
class Foo a where
foo
:: Int -- ^ This string will be ignored by Haddock
-> a
这会给我维护的库的用户带来某些问题,因为
就我而言,这些方法的签名很长。我一直在描述
这样格式化的源(一定适用于普通功能),但是
事实证明,Haddock不会显示它们(也不会提示它们
任何一个)。
有没有办法用Haddock显示每个参数的文档?可能有一些解决方法?
最佳答案
好的,这是回归。这个东西应该可以工作(并在2.16.1版本中可以工作),但是可以停止工作(2.17.1和更高版本)。
我已经报告了这个问题:https://github.com/haskell/haddock/issues/647,应该在2.18版中修复(您可以看到已经有一个PR了)。