[Haskell-cafe] Problem with haddock - it dislikes my comments

Colin Paul Adams colin at colina.demon.co.uk
Sat Feb 28 15:21:36 EST 2009

>>>>> "Colin" == Colin Paul Adams <colin at colina.demon.co.uk> writes:

>>>>> "Colin" == Colin Paul Adams <colin at colina.demon.co.uk> writes:
>>>>> "Gwern" == Gwern Branwen <gwern0 at gmail.com> writes:
    Gwern> On Sat, Feb 28, 2009 at 2:59 PM, Colin Paul Adams
    Gwern> <colin at colina.demon.co.uk> wrote:
    >>>> Having just read the Haddock manual , I am haddocking (may I
    >>>> copyleft that verb?) my code.
    >>>> But half-way through this data type, I discover that haddock
    >>>> rejects my non-haddock comments, although GHC is fine:

    >>>> How can I document the components of each constructor?

    Gwern> http://trac.haskell.org/haddock/ticket/60 ?

    Colin> That seems to be a different bug - my haddock comments are
    Colin> accepted fine - it's the plain Haskell ones (no ^) that it
    Colin> complains about as a parse error.

    Colin> No, I'm wrong - it does seem to be the same problem.

    Colin> Since the ticket has been downgraded to a minor problem, it
    Colin> seems the Haddock team doesn't want to allow documentation
    Colin> of components, except when they are named fields. 

The by-pass seems to avoid haddock comments - it means i have to read
the source code to see my comments - well, I don't mind, but it seems
to make Haddock pointless.
Colin Adams
Preston Lancashire

More information about the Haskell-Cafe mailing list