aboutsummaryrefslogtreecommitdiff
path: root/TODO
blob: 3be52f231e023c0bdeb5ceac8d91231e8f71f985 (plain) (blame)
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
* IDoc compatibility, as far as possible
	- bird-tracks for code blocks

* facilities for saving interfaces so that you can run Haddock against
  something that isn't the Prelude.

-----------------------------------------------------------------------------

* Do the unlitting/CPPing from Haddock itself so we get the source file
  links right.

* Allow documentation annotations to explicitly name the entity they
  refer to.

* Allow {- -} style documentation comments in addition to --.

* Add back-references from the definition to the uses of types/classes
  (perhaps in the index?)

* In the contents page, indicate portability/stability of each module
  somehow.

* remove extra whitespace from the generated HTML to save space

* To clean up: various warnings are emitted with trace rather than
  being propagated back to the top level properly.

* split large modules into several pages (perhaps split at each
  section 1 heading?)

* pay attention to import specs!

* instances: list relevant instances in the documentation for classes and
  datatypes.

* include file revision info in module headers

* Allow fully hiding modules from the output

* Add a link to the defining location of a re-exported entity

* fixities

* we don't deal with records properly - exporting record selectors etc.

* doc strings for: function arguments

* remove the s/r conflicts I added to the grammar

* check handling of special types ([], (), (,) etc.)

* Horizontal lines?

* enhance the doc string parser:
	* @...@ for monospaced text
	* an apostrophe inside a string shouldn't be considered to be a quote

* Do proper dependency analysis rather than relying on laziness to
  sort it out.

* clean up the layout: don't use table cellspacing, use CSS instead