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

[ development, program ] [ Propose Tags ]

Literate preprocessor that allows intuitive Haddock comments.

[Skip to Readme]
Versions [RSS] [faq] 1.0, 1.1
Dependencies base (>=2 && <4), haskell98 [details]
License LicenseRef-GPL
Author Sean McLaughlin
Category Development
Bug tracker
Uploaded by SeanMcLaughlin at 2012-08-02T16:36:38Z
Distributions NixOS:1.1
Executables BirdPP
Downloads 2110 total (11 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs not available [build log]
All reported builds failed as of 2016-10-24 [all 14 reports]


Maintainer's Corner

For package maintainers and hackage trustees


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:


> code


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

> code

| comments

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

ghc -pgmL BirdPP --make Main.lhs