Package: haddock (0.8-2.1)

Documentation tool for annotated Haskell source code

Haddock is a tool for automatically generating documentation from annotated Haskell source code. It is primary intended for documenting libraries, but it should be useful for any kind of Haskell code.

Haddock lets you write documentation annotations 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 heavyweight mark-up). The documentation generated by Haddock is fully hyperlinked: click on a type name in a type signature to go straight to the definition, and documentation, for that type.

Haddock can generate documentation in multiple formats; currently HTML is implemented, and there is partial support for generating DocBook.

Tags: Software Development: Literate Programming, Haskell Development, Implemented in: Haskell, User Interface: Command Line, Role: Program, Scope: Utility, Works with: Source Code, Text, Supports Format: HTML, Hypertext Markup Language