代码之家  ›  专栏  ›  技术社区  ›  Mark Karpov sheikh_anton

有没有办法让Haddock呈现类型类方法的每个参数文档?

  •  8
  • Mark Karpov sheikh_anton  · 技术社区  · 8 年前

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

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

    这会给我维护的库的用户带来一些问题,因为 这种格式的源代码(当然适用于普通函数),但是 要么)。

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

    1 回复  |  直到 8 年前
        1
  •  3
  •   Mark Karpov sheikh_anton    8 年前

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

    我已报告: https://github.com/haskell/haddock/issues/647