[haddock] #29: Comments on instance declarations

haddock haddock at projects.haskell.org
Tue Nov 24 17:28:30 EST 2009

#29: Comments on instance declarations
Reporter:  waern        |        Owner:        
    Type:  enhancement  |       Status:  closed
Priority:  critical     |    Milestone:        
 Version:               |   Resolution:  fixed 
Keywords:               |  
Changes (by waern):

  * status:  new => closed
  * resolution:  => fixed


 Implemented by this patch:

  Comments on instances
  David Waern <david.waern at gmail.com>**20091124205549

  Implementing this was a little trickier than I thought, since we need to
  up instances from the renamed syntax with instances represented by
  InstEnv.Instance. This is due to the current design of Haddock, which
  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
  - No change to the .haddock file format
  - Works for normal user-written instances only. No comments are added on
    derived or TH-generated instances

 What remains is:

  * Comments on methods (needs more detailed instance documenation).
  * Auto-generated comments on derived/TH-generated instances.

 I'm closing this ticket and opening separate tickets for those two tasks.

Ticket URL: <http://trac.haskell.org/haddock/ticket/29#comment:15>
haddock <http://www.haskell.org/haddock>
Haddock, The Haskell Documentation Tool

More information about the Haddock mailing list