Blank definition list in haddock
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/B... 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/s... Did I used those definitons the wrong way? Thanks, Maurício
2009/8/16 Maurício CA
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/B...
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/s...
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
I read in haddock documentation that we write definition lists like this: [...] 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.
OK. Sent the patch below to haddock maintainer. Thanks, Maurício %%% <title>Paragraphs</title> - <para>One or more blank lines separates two paragraphs in a - documentation comment.</para> + <para>One or more blank lines separate two paragraphs in a + documentation comment. Such blank lines, though, should + still be commented, or they would interrupt Haddock + documentation.</para> </section> %%%
participants (2)
-
David Waern -
Maurício CA