[Haddock] [haddock] #259: Hoogle backend drops documentation for type class fields.

haddock haddock at projects.haskell.org
Tue Sep 10 00:21:51 BST 2013


#259: Hoogle backend drops documentation for type class fields.
--------------------+-------------------------------------------------------
Reporter:  Fūzetsu  |       Owner:  Fūzetsu
    Type:  defect   |      Status:  new    
Priority:  major    |   Milestone:         
 Version:           |    Keywords:         
--------------------+-------------------------------------------------------
 Originally reported by Neil Mitchel in ticket #168.

 Input:
 {{{
 module NoTypeClassDocs where

 -- | Docs for typeclass Foo
 class BUG1 a  where
     -- | Doc for 'bar' field of 'Foo'
     bar :: Integer -> a
 }}}

 Output
 {{{
 -- Hoogle documentation, generated by Haddock
 -- See Hoogle, http://www.haskell.org/hoogle/

 @package main

 module NoTypeClassDocs

 -- | Docs for typeclass <a>Foo</a>
 class Foo a
 bar :: Foo a => Integer -> a
 }}}

 Expected(?):
 {{{
 -- Hoogle documentation, generated by Haddock
 -- See Hoogle, http://www.haskell.org/hoogle/

 @package main

 module NoTypeClassDocs

 -- | Docs for typeclass <a>Foo</a>
 class Foo a
 -- | Doc for <a>bar</a> field of <a>Foo</a>
 bar :: Foo a => Integer -> a
 }}}

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


More information about the Haddock mailing list