[Haskell-cafe] Haddock question

[Ivan Lazar Miljenovic]

"S. Doaitse Swierstra" <doaitse at cs.uu.nl> writes:

> Unfortunately I get for input:
>
> -- | We can now run the parser @`pa`@ on input \"a\", which succeeds: 
> -- @ 
> --   Result: \"a\"
> --   Second line
> -- @
>
> the output
>
> We can now run the parser pa on input "a", which succeeds: Result: "a"
> Second line

Methinks you need a blank (comment) line before the @:

-- | We can now run the parser @`pa`@ on input \"a\", which succeeds: 
--
-- @                                                                  
--   Result: \"a\"                                                    
--   Second line                                                      
-- @                                                                  

>
> Doaitse
>
>
>
>
>
>
> On 21 jul 2010, at 16:17, Daniel Fischer wrote:
>
>> On Wednesday 21 July 2010 16:09:37, S. Doaitse Swierstra wrote:
>>> I am trying to document my parser library. In order to do so I should
>>> like to include some example output in my haddock documentation. I fail
>>> to see however how to get a block of output into the haddock part.
>>> 
>>> E.g.
>>> 
>>> -- | We can now run the parser @`pa`@ on input \"a\", which succeeds:
>>> -- @ Result: \"a\"
>>> -- @
>> 
>> -- | We can now ...
>> --
>> -- @
>> --   Result: \"a\"
>> -- @
>> --
>> --  In further news, ...
>> 
>>> 
>>> does not put the Result ... on a separate line, and if I have several
>>> lines of output they are concatenated.
>>> 
>>> How to proceed,
>>> 
>>> Doaitse
>>> 
>> 
>> _______________________________________________
>> Haskell-Cafe mailing list
>> Haskell-Cafe at haskell.org
>> http://www.haskell.org/mailman/listinfo/haskell-cafe
>
> _______________________________________________
> Haskell-Cafe mailing list
> Haskell-Cafe at haskell.org
> http://www.haskell.org/mailman/listinfo/haskell-cafe

-- 
Ivan Lazar Miljenovic
Ivan.Miljenovic at gmail.com
IvanMiljenovic.wordpress.com