[Haskell-cafe] Blank definition list in haddock

David Waern david.waern at gmail.com
Sun Aug 16 09:34:05 EDT 2009


2009/8/16 Maurí­cio CA <mauricio.antunes at gmail.com>:
> I read in haddock documentation that we write
> definition lists like this:
>
> --  [@something@] Definition of something.
>
> However, using that structure to document many
> itens, I get a blank list of definitions, like
> you can see in this section ('Macros') of the
> documentation for a package of mine:
>
> http://hackage.haskell.org/packages/archive/bindings-common/0.2.2/doc/html/Bindings.html#3
>
> However, as can be seen in the source code, there
> are many definitions inside 'Macros' section.
>
> http://hackage.haskell.org/packages/archive/bindings-common/0.2.2/doc/html/src/Bindings.html
>
>
> Did I used those definitons the wrong way?

I think the problem is that you have written normal comments instead
of Haddock comments. Try adding a | in front of the paragraphs, or
just merge them all into one Haddock comment by inserting "--" in
front of the blank lines in between your paragraphs.

David


More information about the Haskell-Cafe mailing list