Haddock
latest
  • Introduction
  • Invoking Haddock
  • Documentation and Markup
  • Common Errors
  • Haddocks of multiple components
Haddock
  • Docs »
  • Welcome to Haddock’s documentation!
  • Edit on GitHub

Welcome to Haddock’s documentation!¶

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

Contents:

  • Introduction
    • Obtaining Haddock
    • License
    • Contributors
    • Acknowledgements
  • Invoking Haddock
    • Using literate or pre-processed source
  • Documentation and Markup
    • Documenting a Top-Level Declaration
    • Documenting Parts of a Declaration
    • The Module Description
    • Controlling the Documentation Structure
    • Hyperlinking and Re-Exported Entities
    • Module Attributes
    • Markup
  • Common Errors
    • parse error on input ‘-- | xxx’
    • parse error on input ‘-- $ xxx’
  • Haddocks of multiple components

Indices and tables¶

  • Index
  • Search Page
Next

© Copyright 2016, Simon Marlow Revision e634eb9e.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
v2.20
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.