Personal tools

Haddock

From HaskellWiki

(Difference between revisions)
Jump to: navigation, search
(main page still shows 2.0, which is broken with GHC 6.8.3)
(remove duplicate sentence, cleanup)
Line 1: Line 1:
[http://haskell.org/haddock/ Haddock] is a tool for automatically generating documentation from annotated Haskell source code. Its main web page is not updated as often as its [http://hackage.haskell.org/cgi-bin/hackage-scripts/package/haddock hackage page], so check there for the latest version.
+
Haddock is a tool for automatically generating documentation from annotated Haskell source code.
   
Haddock is now the de facto standard Haskell documentation tool. It is used for the standard libraries that come with [[GHC]] and [[Hugs]]. It is also supported by [[Cabal]].
+
It is the de facto standard Haskell documentation tool, being used for the documentation of the standard libraries that come with [[GHC]] and [[Hugs]]. It is also supported by [[Cabal]].
   
 
* [http://hackage.haskell.org/cgi-bin/hackage-scripts/package/haddock The hackage page] is updated more often than the main [http://haskell.org/haddock/ Haddock web page]
 
* [http://hackage.haskell.org/cgi-bin/hackage-scripts/package/haddock The hackage page] is updated more often than the main [http://haskell.org/haddock/ Haddock web page]
  +
* [[/FAQ|FAQ]]
 
* [[/Development ideas|Ideas for improving Haddock in various ways.]]
 
* [[/Development ideas|Ideas for improving Haddock in various ways.]]
* [[/FAQ|Frequently asked questions about Haddock.]]
 
 
* [http://trac.haskell.org/haddock/ Haddock Trac]
 
* [http://trac.haskell.org/haddock/ Haddock Trac]
   

Revision as of 14:01, 21 August 2009

Haddock is a tool for automatically generating documentation from annotated Haskell source code.

It is the de facto standard Haskell documentation tool, being used for the documentation of the standard libraries that come with GHC and Hugs. It is also supported by Cabal.