aboutsummaryrefslogtreecommitdiff
path: root/TODO
blob: 42b22549af45d56e96f9fdcc59a1d998c6d4c7e0 (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
* doc strings for: function arguments

* more compact rendering for datatypes, like
	data T = -- comment for T
	   A	 -- comment for A
	 | B     -- comment for B

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

* A module re-export should only reference the target module if the
  target module is imported without hiding any of its exports (otherwise
  we should inline just the exported bits).

* Put SrcLocs in DocComments

* 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.

* 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!

* include file revision info in module headers

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

* fixities

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

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

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

* Horizontal lines?

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

* implicit parameter support in the parser.

* Allow a qualified name in a doc string to point to the entity even if it
  isn't in scope.