Haddock (software)
≈ 1 min read
Names in other languages
No names in other languages are held for this entry yet.
Article bodies are English and are not machine-translated. A name in another language is not a translation of the article.
Haddock is a free, portable command-line program documentation generator for Haskell.
Haddock is a free, portable command-line program documentation generator for Haskell.
Software
It is influenced by IDoc, HDoc, 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 Glasgow Haskell Compiler (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.
Here is an example of Haddock markup: -- | This is the documentation for 'square', which -- uses the (*) operator from "Prelude". -- It multiplies the @x@ argument against itself. square :: Integer -> Integer square x = x*x
Text derived from https://en.wikipedia.org/w/index.php?oldid=1353806481 under CC BY-SA 4.0; modifications have been made.