Welcome to Haddock’s documentation!¶

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

Contents:

  • Introduction
    • Obtaining Haddock
    • License
    • Acknowledgements
  • Invoking Haddock
    • Using literate or pre-processed source
    • Avoiding recompilation
    • Incremental mode
  • 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

Haddock

Navigation

  • Introduction
  • Invoking Haddock
  • Documentation and Markup
  • Common Errors
  • Haddocks of multiple components

Related Topics

  • Documentation overview
    • Next: Introduction

Quick search

©2016, Simon Marlow. | Powered by Sphinx 7.1.2 & Alabaster 0.7.13 | Page source