2003-07-24 20:26:13 -04:00
|
|
|
Haddock is a tool for automatically generating documentation from
|
2004-01-16 03:46:37 -05:00
|
|
|
annotated Haskell source code. It is primarily intended for documenting
|
2003-07-24 20:26:13 -04:00
|
|
|
libraries, but it should be useful for any kind of Haskell code.
|
|
|
|
|
|
|
|
Like other systems, Haddock lets you write documentation annotations
|
2004-01-16 03:46:37 -05:00
|
|
|
next to the definitions of functions and types in the source code, in a
|
|
|
|
syntax that is easy on the eye when writing the source code (no
|
2003-07-24 20:26:13 -04:00
|
|
|
heavyweight mark-up). The documentation generated by Haddock is fully
|
2004-01-16 03:46:37 -05:00
|
|
|
hyperlinked - click on a type name in a type signature to go straight to
|
|
|
|
the definition, and documentation, for that type.
|
|
|
|
|