为什么没有为基础上的某些模块生成HTML?

时间:2017-06-07 14:24:46

标签: haskell haddock

base黑线鳕中有一些模块没有文档链接。例如,GHC/Show.hs有haddock注释,但Hackage上没有GHC.Show模块的文档。为什么不?这是一个错误吗?

1 个答案:

答案 0 :(得分:2)

这显然是故意的。它是GHC / Show.hs中this line的结果:

{-# OPTIONS_HADDOCK hide #-}

the haddock documentation的相关摘录:

  

可以为每个模块指定某些属性,这些属性会影响Haddock为该模块生成文档的方式。属性在模块顶部的{-# OPTIONS_HADDOCK ... #-} pragma中以逗号分隔的列表中指定,在模块描述之前或之后。

     

[...]

     

Haddock目前了解以下属性:

     
      
  • 隐藏      
        

    从生成的文档中省略此模块,但仍然将此模块中的定义和文档传播到重新导出这些定义的模块。

      
  •   
     

[...]