diff options
| author | David Waern <david.waern@gmail.com> | 2009-11-24 20:55:49 +0000 |
|---|---|---|
| committer | David Waern <david.waern@gmail.com> | 2009-11-24 20:55:49 +0000 |
| commit | dc3a42156eeb0fd1457a395e69f5778c0446caa5 (patch) | |
| tree | 480019738b5aa5060ac43e133949f7fb1e09eab9 /src/Haddock/Backends/HH.hs | |
| parent | 53f11cbd4af38e88ef547fec54cc42f976b1d048 (diff) | |
Comments on instances
Implementing this was a little trickier than I thought, since we need to match
up instances from the renamed syntax with instances represented by
InstEnv.Instance. This is due to the current design of Haddock, which matches
comments with declarations from the renamed syntax, while getting the list of
instances of a class/family directly using the GHC API.
- Works for class instances only (Haddock has no support for type family
instances yet)
- The comments are rendered to the right of the instance head in the HTML output
- No change to the .haddock file format
- Works for normal user-written instances only. No comments are added on
derived or TH-generated instances
Diffstat (limited to 'src/Haddock/Backends/HH.hs')
0 files changed, 0 insertions, 0 deletions