1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
|
Changed in version 2.2.2:
* Relax version dependency on ghc-paths
Changes in version 2.2.1:
* Support for GHC 6.8.3
* The Hoogle backend is back, thanks to Neil Mitchell. The plan is to be
compatible with the upcoming Hoogle 4 pre-release
* Show associated types in the documentation for class declarations
* Show type family declarations
* Show type equality predicates
* Major bug fixes (#1 and #44)
* It is no longer required to specify the path to GHC's lib dir
* Remove unnecessary parenthesis in type signatures
-----------------------------------------------------------------------------
Changes in version 2.1.0:
* Fix a bug that made links point to the defining module instead
of the "best" one (e.g Int pointing to GHC.Base instead of Data.Int)
* Fix a couple of smaller bugs
* The representation of DocName was changed in the library
* Add a flag --no-warnings for turning off warnings
-----------------------------------------------------------------------------
Changes in version 2.0.0.0:
* The GHC API is used as the front-end
* Haddock now understands all syntax understood by GHC 6.8.2
* Haddock can generate documentation for some of the language extensions
in GHC 6.8.2
* Format of module attributes has changed. The only way of specifiying
module attributes is via a new OPTIONS_HADDOCK pragma. Example:
{-# OPTIONS_HADDOCK hide, prune #-}
* Haddock understands literate source files
* Add a small library to read Haddock's interface files
* Add a flag -B for passing the path to the GHC lib dir
* Add a flag --optghc for passing options to GHC
* Add a flag --ghc-version for printing the GHC version
* Remove --use-package, --allow-missing-html, --ghc-pkg, in favour of only
supporting --read-interface
* Remove --package flag, the GHC flag -package-name can be used instead
* Remove --no-implicit-prelude flag, the GHC flag -XNoImplicitPrelude can
be used instead
-----------------------------------------------------------------------------
Changes in version 0.9:
* Infix type operators, e.g., first :: a~>a' -> (a,b)~>(a',b)
* Add a search box to the index page which automatically narrows
the index to the search as you type (thanks to Neil Mitchell).
* Add a --ghc-pkg flag
* Add a flag --allow-missing-html
* URL expansion for %%, %L, %{LINE}
* added substitution %{FILE///c}
* Lexing of /.../ is now more like '...', in that a / character must
be matched by another / character on the same line, otherwise it
is treated as a literal '/'. This removes a common source of
accidental parse errors in documentation.
* Various bugs were fixed.
* Cabal 1.2 is now required, and Haddock builds with GHC 6.8.x.
-----------------------------------------------------------------------------
Changes in version 0.8:
* Haddock has a Cabal build system, and will build on Windows without
Cygwin or MSYS. GHC 6.4 or later is required.
* New options: --comments-base, --comments-module, --comments-entity
for generating links to pages (eg. wiki) for collecting user comments.
* New options: --source-base, --source-module, --source-entity
for generating links to source code. Haddock now understands
{-# LINE #-} pragmas, which means it can figure out the correct
name for the source file even if the file is preprocessed.
* Haddock generates output for populating the Hoogle search engine.
* New markup <<url>> for including images.
-----------------------------------------------------------------------------
Changes in version 0.7:
* Changes in the way Haddock decides where to direct hyperlinks. Each entity
is now assigned a single "home" module, and all hyperlinks are directed
to that module. See the docs ("Hyperlinking and re-exported entities")
for details.
* New options --ignore-all-exports, --hide
* New option --use-package for creating documentation that hyperlinks to
the HTML documentation for existing packages on your system. It works
by querying ghc-pkg for the location of the Haddock interface and
HTML for the given package.
* Parts of the HTML documentation, notably lists of instances, are
now "collapsible" with a +/- button. Also, the contents page is now
in the form of tree in which subtrees can be collapsed.
* Support for Microsoft DevHelp and HtmlHelp 2.0 formats.
* Support for a short description for each module for the contents page.
* Compiles with GHC 6.4+
* Various bugfixes
-----------------------------------------------------------------------------
Changes in version 0.6:
* Implicit parameters, zip comprehensions and 'mdo' are now
supported by the parser.
* Some lexical bugs were fixed, mainly concerning literal paragraphs
next to non-literal paragraphs.
* New options: --gen-index, --use-index, --gen-contents and --use-contents,
for generting a combined index and contents for several libraries
from the appropriate .haddock files.
* There is now one index rather than separate Function/Constructor and
Type/Class indices. Where a name refers to several entities, these
are listed separately in the index.
* New option: -v, elicits more verbose warnings. Some warnings are
now turned off by default; Haddock should be a little less noisy
in general.
* Markup for definition lists has been added. See the documentation
for details.
* New option: --package for setting the package name. The package
is listed alongside each module name in the combined contents.
* Entities which are re-exported from another package now at least
leave a hyperlink in the generated HTML, rather than nothing at all.
* Some fixes for bugs which caused incorrect hyperlinks in the
generated HTML. In particular, instances should now be linked
correctly.
* Some aesthetic improvements to the generated HTML.
-----------------------------------------------------------------------------
Changes in version 0.5:
* Compiles with recent versions of GHC.
* A few bugs have been fixed.
* New labelling/linking feature (see "Anchors" in the manual).
-----------------------------------------------------------------------------
Changes in version 0.4:
* Import declarations which list entities in parentheses, or with
hiding clauses, are now properly supported. Modulo one or two
small infelicities, the full Haskell modules system is now supported.
* Haddock is now more flexible about the placing of separators
(commas, semicolons) in relation to doc comments.
* There is support for generating and reading "interface files"
which describe the exports of a set of modules. This is useful
for generating documentation which hyperlinks to
previously-generated documentation.
* Support for generating the extra files required by the Microsoft
Help compiler.
* New option: --prologue specifies a file of documentation which is
placed on the contents page.
* Many bugs fixed
-----------------------------------------------------------------------------
Changes in version 0.3:
* Documentation on individual function arguments is now implemented
* Links can be made to identifiers that aren't in scope, by using
the fully qualified name.
* Instances are collected and listed with the appropriate classes
and datatypes (not for derived instances yet).
* Single quotes are only interpreted specially when they surround a
legal Haskell identifier, otherwise they are treated literally.
* Bird-tracked text is now literal. If you want marked-up text in
a code block, use the @...@ notation instead.
* Various changes to the layout, it generally looks nicer now.
* Various bugs fixed.
-----------------------------------------------------------------------------
Changes in version 0.2:
* The [...] markup for typewriter font has been changed to @...@.
* Module attributes introduced (see the documentation for details).
* {- ... -} style comments may now be used for documentation annotations
* Recursive modules are detected and reported as an error.
* Existential constructors and rank-N types are now groked by the parser
* Some type rendering cleaned up
* `abc' is accepted as well as 'abc' to markup an identifier
* Several bugs fixed, and error messages improved.
|
