Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
H
haddock
Manage
Activity
Members
Labels
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Environments
Terraform modules
Analyze
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Stephen Judkins
haddock
Commits
4f3fe0df
Commit
4f3fe0df
authored
7 years ago
by
Alex Biehl
Committed by
GitHub
7 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Beef up haddock description (#658)
* Beef up haddock description * Handle empty lines
parent
bd13010f
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
haddock.cabal
+20
-2
20 additions, 2 deletions
haddock.cabal
with
20 additions
and
2 deletions
haddock.cabal
+
20
−
2
View file @
4f3fe0df
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
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment