[Haddock] [haddock] #37: Hide instances that are "internal" to a module
haddock
haddock at projects.haskell.org
Wed Jun 20 14:37:16 BST 2012
#37: Hide instances that are "internal" to a module
------------------------+---------------------------------------------------
Reporter: waern | Owner:
Type: enhancement | Status: new
Priority: minor | Milestone:
Version: | Resolution:
Keywords: |
------------------------+---------------------------------------------------
Comment(by SimonHengel):
I'm not doing the review, that is David's privilege. But I tried it, and
it seems to work very well. One concern: if I understand correctly, the
test case does not test correct handling of `--hide` at all, right? I
think it would be possible to test this like so:
{{{
{-# OPTIONS_HADDOCK hide #-}
module Foo where
-- | Should be visible
class Foo a
-- | Should be visible
data Bar
-- | Should be visible
instance Foo Bar
-- | Should *not* be visible
data Baz
-- | Should *not* be visible
instance Foo Baz
}}}
{{{
module Bar (Foo, Bar) where
import Foo
}}}
--
Ticket URL: <http://trac.haskell.org/haddock/ticket/37#comment:11>
haddock <http://www.haskell.org/haddock>
Haddock, The Haskell Documentation Tool
More information about the Haddock
mailing list