Supriya Ghosh (Editor)

Haddock (software)

Updated on
Share on FacebookTweet on TwitterShare on LinkedInShare on Reddit
Developer(s)  Simon Marlow
Written in  Haskell
Platform  x86, PowerPC
Initial release  May 1, 2002
Operating system  Cross-platform
Stable release  2.8.0 / September 2, 2010

Haddock is a free, portable command-line program documentation generator for Haskell. It is influenced by IDoc [1], HDoc [2], and Doxygen. It produces hyperlinked HTML files from annotated Haskell (the documentation is embedded in comments) source files, with additional information extracted from type annotations; it supports only partially generating documentation in SGML. It is often used in conjunction with darcs and Cabal. It is dependent on GHC, using a modified form of the HsParser (written in Happy) parser for Haskell included in GHC. Its lightweight markup is based on IDoc's. Haddock is contained in the Haskell Platform.

It is used by the GHC, Gtk2Hs and HTk projects, as well as XMonad and Yi.

Here is an example of Haddock markup:


Haddock (software) Wikipedia