Haddockifying the documentation in HsSyn
I took the liberty of making some cosmetic changes to the comments in HsBinds.lhs and HsExpr.lhs. Particularly I've made most of the relevants comments appear as Haddock annotations for datatypes and constructors. This way a user of GHC API (or a GHC dev) can refer to the haddocks in order to find out what does the given datatype/constructor represent/do instead of digging too deep in the source code.
You can see the output here: <http://co-dan.github.io/ghc-docs/HsExpr.html>, <http://co-dan.github.io/ghc-docs/HsBinds.html>
This patch on github: https://github.com/co-dan/ghc/compare/hssyn-docs
Related wiki pages: Commentary/Compiler/HsSynType
If this proves useful I may update documentation in other files.
Trac metadata
| Trac field | Value |
|---|---|
| Version | 7.7 |
| Type | Bug |
| TypeOfFailure | OtherFailure |
| Priority | low |
| Resolution | Unresolved |
| Component | Documentation |
| Test case | |
| Differential revisions | |
| BlockedBy | |
| Related | |
| Blocking | |
| CC | |
| Operating system | |
| Architecture |