[Haddock] [haddock] #144: Allow -- ^ comment on record constructor

haddock haddock at projects.haskell.org
Wed Sep 1 12:12:39 EDT 2010


#144: Allow -- ^ comment on record constructor
------------------------+---------------------------------------------------
Reporter:  heatsink     |       Owner:       
    Type:  enhancement  |      Status:  new  
Priority:  major        |   Milestone:  2.7.0
 Version:  2.6.1        |    Keywords:       
------------------------+---------------------------------------------------
 This enhancement would add flexibility to the commenting style for record
 constructors.  Accept a `-- ^` comment between a constructor and its
 fields, meaning the same as a `-- |` comment before the constructor.  The
 example below is rejected as a parse error due to the comment on 'Branch'.

 {{{
 -- | A tree with labeled internal nodes
 data Tree =
     Empty                -- ^ Leaf
   | Branch               -- ^ Internal node
     { label :: a         -- ^ Node label
     , subtrees :: [Tree] -- ^ List of subtrees
     }
 }}}

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


More information about the Haddock mailing list