aboutsummaryrefslogtreecommitdiff
path: root/haddock.cabal
diff options
context:
space:
mode:
authorAlexander Biehl <alexbiehl@gmail.com>2017-07-20 11:25:54 +0200
committerGitHub <noreply@github.com>2017-07-20 11:25:54 +0200
commit4f3fe0df65caea76ed268f1907918c19c7da4335 (patch)
tree3080ee1952cb4c0d93089f8393a5a2fe73557565 /haddock.cabal
parentbd13010fdc2180b2fad4170c7e94f5c7c721755c (diff)
Beef up haddock description (#658)
* Beef up haddock description * Handle empty lines
Diffstat (limited to 'haddock.cabal')
-rw-r--r--haddock.cabal22
1 files changed, 20 insertions, 2 deletions
diff --git a/haddock.cabal b/haddock.cabal
index be2efb27..85790cab 100644
--- a/haddock.cabal
+++ b/haddock.cabal
@@ -1,8 +1,26 @@
name: haddock
version: 2.18.1
synopsis: A documentation-generation tool for Haskell libraries
-description: Haddock is a documentation-generation tool for Haskell
- libraries
+description:
+ This is Haddock, a tool for automatically generating documentation
+ from annotated Haskell source code. It is primary intended for documenting
+ library interfaces, 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).
+ .
+ Haddock understands Haskell's module system, so you can structure your code
+ however you like without worrying that internal structure will be exposed in
+ the generated documentation. For example, it is common to implement a library
+ in several modules, but define the external API by having a single module
+ which re-exports parts of these implementation modules. Using Haddock, you can
+ still write documentation annotations next to the actual definitions of the
+ functions and types in the library, but the documentation annotations from the
+ implementation will be propagated to the external API when the documentation is
+ generated. Abstract types and classes are handled correctly. In fact, even
+ without any documentation annotations, Haddock can generate useful documentation
+ from your source code.
license: BSD3
license-file: LICENSE
author: Simon Marlow, David Waern