Haddock Constructor parameter documentation without record syntax

newer
ANN: ZuriHac 2014

satvik chauhan

22 Jan 2014 22 Jan '14

4:42 a.m.

Hi, Does anybody know how to document parameters of a constructor in haddock. The following code gives parse error on the second parameter while generating haddock documentation. ``` data Foo = Foo Int -- ^ First Int -- ^ Second ``` -Satvik

Attachments:

attachment.html (text/html — 417 bytes)

Show replies by date

Alexander Berntsen

22 Jan 22 Jan

4:48 a.m.

New subject: Haddock Constructor parameter documentation without record syntax

-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA256 On 22/01/14 10:42, satvik chauhan wrote:

...

data Foo = Foo Int -- ^ First Int -- ^ Second I don't think you can do it that way. See [0].

[0] http://www.haskell.org/haddock/doc/html/ch03s02.html#idp1371328252 - -- Alexander alexander@plaimi.net http://plaimi.net/~alexander -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.22 (GNU/Linux) Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/ iF4EAREIAAYFAlLflAsACgkQRtClrXBQc7VevgD+JBpm/PQkdUZ1v8EFgErIECWf 1Zjoyp/kSvnuYpJlPi4A/3/zVoumiAQYq8BI1lBo22r992cSkvrnOn7D57EZfJSr =KwN5 -----END PGP SIGNATURE-----

Mateusz Kowalczyk

5:25 a.m.

New subject: Haddock Constructor parameter documentation without record syntax

On 22/01/14 09:48, Alexander Berntsen wrote:

...

On 22/01/14 10:42, satvik chauhan wrote:

...
data Foo = Foo Int -- ^ First Int -- ^ Second I don't think you can do it that way. See [0].

[0] http://www.haskell.org/haddock/doc/html/ch03s02.html#idp1371328252

_______________________________________________ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe

I can confirm that you can not document constructors in this way. If you really need to, you can make it into a record and document each field. -- Mateusz K.

satvik chauhan

5:29 a.m.

New subject: Haddock Constructor parameter documentation without record syntax

Using the record is an option but it pollutes the namespace which I don't want to do. Any ideas why this is not possible? On Wed, Jan 22, 2014 at 3:55 PM, Mateusz Kowalczyk wrote:

...

On 22/01/14 09:48, Alexander Berntsen wrote:

...
On 22/01/14 10:42, satvik chauhan wrote:

...
data Foo = Foo Int -- ^ First Int -- ^ Second I don't think you can do it that way. See [0].

[0] <http://www.haskell.org/haddock/doc/html/ch03s02.html#idp1371328252

_______________________________________________ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe

I can confirm that you can not document constructors in this way. If you really need to, you can make it into a record and document each field.

-- Mateusz K. _______________________________________________ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe

-- -------------------------------------------------------------------------------------------------- Satvik Chauhan Fourth Year Under Graduate Student Deptt. of Computer Science and Engineering Indian Institute of Technology Kanpur Kanpur-208016, INDIA Email: mystic.satvik@gmail.com , satvikc@iitk.ac.in --------------------------------------------------------------------------------------------------

Mateusz Kowalczyk

5:51 a.m.

New subject: Haddock Constructor parameter documentation without record syntax

On 22/01/14 10:29, satvik chauhan wrote:

...

Using the record is an option but it pollutes the namespace which I don't want to do.

Any ideas why this is not possible?

On Wed, Jan 22, 2014 at 3:55 PM, Mateusz Kowalczyk wrote:

...
On 22/01/14 09:48, Alexander Berntsen wrote:

...
On 22/01/14 10:42, satvik chauhan wrote:

...
data Foo = Foo Int -- ^ First Int -- ^ Second I don't think you can do it that way. See [0].

[0] <http://www.haskell.org/haddock/doc/html/ch03s02.html#idp1371328252

_______________________________________________ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe

I can confirm that you can not document constructors in this way. If you really need to, you can make it into a record and document each field.

-- Mateusz K. _______________________________________________ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe

See http://trac.haskell.org/haddock/ticket/95 -- Mateusz K.

4137

Age (days ago)

4137

Last active (days ago)

List overview

Download

4 comments

3 participants

participants (3)

Alexander Berntsen
Mateusz Kowalczyk
satvik chauhan