Haddock User Guide

Simon Marlow

David Waern

Abstract

This document describes Haddock version 2.13.2, a Haskell documentation tool.


Table of Contents

1. Introduction
1.1. Obtaining Haddock
1.2. License
1.3. Contributors
1.4. Acknowledgements
2. Invoking Haddock
2.1. Using literate or pre-processed source
3. Documentation and Markup
3.1. Documenting a top-level declaration
3.2. Documenting parts of a declaration
3.2.1. Class methods
3.2.2. Constructors and record fields
3.2.3. Function arguments
3.3. The module description
3.4. Controlling the documentation structure
3.4.1. Re-exporting an entire module
3.4.2. Omitting the export list
3.5. Named chunks of documentation
3.6. Hyperlinking and re-exported entities
3.7. Module Attributes
3.8. Markup
3.8.1. Paragraphs
3.8.2. Special characters
3.8.3. Character references
3.8.4. Code Blocks
3.8.5. Examples
3.8.6. Properties
3.8.7. Hyperlinked Identifiers
3.8.8. Emphasis and Monospaced text
3.8.9. Linking to modules
3.8.10. Itemized and Enumerated lists
3.8.11. Definition lists
3.8.12. URLs
3.8.13. Anchors
Index