BirdPP: A preprocessor for Bird-style Literate Haskell comments with Haddock markup.

[ development, program ] [ Propose Tags ] [ Report a vulnerability ]

Literate preprocessor that allows intuitive Haddock comments.

[Skip to Readme]

Downloads

BirdPP-1.1.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

SeanMcLaughlin

For package maintainers and hackage trustees

edit package information

Candidates

No Candidates

Versions [RSS]	1.0, 1.1
Dependencies	base (>=2 && <4), haskell98 [details]
License	LicenseRef-GPL
Author	Sean McLaughlin
Maintainer	seanmcl@gmail.com
Category	Development
Bug tracker	http://github.com/seanmcl/BirdPP/issues
Uploaded	by SeanMcLaughlin at 2012-08-02T16:36:38Z
Distributions
Reverse Dependencies	1 direct, 0 indirect [details]
Executables	BirdPP
Downloads	2309 total (9 in the last 30 days)
Rating	(no votes yet) [estimated by Bayesian average]
Your Rating	λ λ λ
Status	Docs not available [build log] All reported builds failed as of 2016-10-24 [all 14 reports]

Readme for BirdPP-1.1

[back to package description]

Using Haddock markup with Literate Haskell commenting style doesn't 
currently work.  For instance, to get Haddock markup in an lhs file:

comments
comments

> code

comments

you'd need to write:

> -- | comments
> -- comments

> code

> -- | comments

This clearly defeats the purpose of Literate Haskell.  BirdPP is
a preprocessor that works with GHC so you can write what you want:


| comments
comments

> code

| comments

Compilation of this package will give you an executable called
bunlit.  This can be used by ghc using the option -pgmL BirdPP.
E.g.

ghc -pgmL BirdPP --make Main.lhs