[haddock] #110: Allow grouping of functions with a corresponding data type

[haddock]

#110: Allow grouping of functions with a corresponding data type
-------------------+--------------------------------------------------------
Reporter:  duncan  |        Owner:     
    Type:  defect  |       Status:  new
Priority:  minor   |    Milestone:     
 Version:  2.4.2   |   Resolution:     
Keywords:          |  
-------------------+--------------------------------------------------------
Comment (by duncan):

 This particularly affects the synopsis. Currently we get:
 {{{
 data WindowBits

 defaultWindowBits :: WindowBits

 windowBits :: Int -> WindowBits
 }}}
 each in their own grey div box. Ideally I want to present it as:
 {{{
 data WindowBits
  defaultWindowBits  :: WindowBits
  windowBits         :: Int -> WindowBits
 }}}
 in a single grey div.

 In the detail section I want it to be something like:
 {{{
 data WindowBits

 This specifies the size of the compression window. Larger
 values of this parameter result in better compression at
 the expense of higher memory usage.

 The compression window size is the value of the the window
 bits raised to the power 2. The window bits must be in the
 range 8..15 which corresponds to compression window sizes
 of 256b to 32Kb. The default is 15 which is also the
 maximum size.

 The total amount of memory used depends on the window bits
 and the MemoryLevel. See the MemoryLevel for the details.

 Constructor Functions
   defaultWindowBits :: WindowBits
   The default WindowBits is 15 which is also the maximum size.

   windowBits :: Int -> WindowBits
   A specific compression window size, specified in bits in
   the range 8..15
 }}}

 The appropriate place to indicate the grouping is almost certainly in the
 export list, eg:
 {{{
   WindowBits,
   -- * Constructor Functions
     defaultWindowBits,
     windowBits,
 }}}
 or some similar suitable syntax to give a name to these related things.
 Perhaps it should not be a free form title, just like the existing
 "Constructors" is standard not free form. One of a small number of
 standard labels may be better.

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