[Haskell-cafe] Haddock question

[Daniel Fischer]

On Wednesday 21 July 2010 16:23:48, S. Doaitse Swierstra wrote:
> Unfortunately I get for input:
>
> -- | We can now run the parser @`pa`@ on input \"a\", which succeeds:
> -- @
> --   Result: \"a\"
> --   Second line
> -- @
>
> the output

You need to separate the @'d paragraph from the rest of the comment by a 
blank comment line.


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

ought to work as intended.

>
> 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