[haddock] #3: feature request: record types with partially exported fields

haddock haddock at projects.haskell.org
Wed Mar 25 14:09:56 EDT 2009


#3: feature request: record types with partially exported fields
------------------------+---------------------------------------------------
Reporter:  avatariks    |        Owner:  somebody
    Type:  enhancement  |       Status:  new     
Priority:  major        |    Milestone:          
 Version:               |   Resolution:          
Keywords:               |  
------------------------+---------------------------------------------------
Changes (by nogin):

 * cc: nogin (added)

Comment:

 Similarly, if I have a record type where all fields are exported, but the
 constructor itself is not (so that invariants can be enforced by the API),
 Haddock omits the fields from the documentation. If instead of
 {{{
 Type(field1,field2)
 }}}
 in the export list, I use
 {{{
 Type,field1,field2
 }}}
 Haddock would, of course, include the fields in the documentation but now
 they look as arbitrary functions, not as fields, which misses the point.

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


More information about the Haddock mailing list