Internal documentation isn't making it to Haddock-generated web pages
Summary
Internal documentation of Cmm
and related modules doesn't make it to the web pages generated by Haddock.
For example, the definition of GlobalReg
in Ghc.Cmm.Expr
has non-Haddock comments.
Proposed improvements or changes
I propose to change the comments on GlobalReg
, CmmLit
, ForeignTarget
, and so on, so that they are more like the definition of CmmStatic
in Ghc.Cmm
. That is, I'll make the existing comments into proper Haddock comments.
I don't intend to do this systematically but rather to fix whatever issues I might spot as I'm driving by, so to speak.
Environment
- GHC version used (if appropriate): HEAD (commit 79c9c816)