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
|
[1 of 3] Compiling Visible ( Visible.hs, Visible.o )
==================== Parser ====================
module Visible where
visible :: Int -> Int
visible a = a
[2 of 3] Compiling Hidden ( Hidden.hs, Hidden.o )
==================== Parser ====================
module Hidden where
hidden :: Int -> Int
hidden a = a
[3 of 3] Compiling Test ( Test.hs, Test.o )
==================== Parser ====================
Module : Test
Copyright : (c) Simon Marlow 2002
License : BSD-style
Maintainer : libraries@haskell.org
Stability : provisional
Portability : portable
This module illustrates & tests most of the features of Haddock.
Testing references from the description: 'T', 'f', 'g', 'Visible.visible'.
module Test (
<IEGroup: 1>, <IEGroup: 2>, T(..), T2, T3(..), T4(..), T5(..),
T6(..), N1(..), N2(..), N3(..), N4, N5(..), N6(..), N7(..),
<IEGroup: 2>, R(..), R1(..),
test that we can export record selectors on their own:, p, q, u,
<IEGroup: 1>, C(a, b), D(..), E, F(..),
Test that we can export a class method on its own:, a,
<IEGroup: 1>, f, g, <IEGroup: 1>, <IEDocNamed: aux1>,
<IEDocNamed: aux2>, <IEDocNamed: aux3>, <IEDocNamed: aux4>,
<IEDocNamed: aux5>, <IEDocNamed: aux6>, <IEDocNamed: aux7>,
<IEDocNamed: aux8>, <IEDocNamed: aux9>, <IEDocNamed: aux10>,
<IEDocNamed: aux11>, <IEDocNamed: aux12>,
This is some inline documentation in the export list
> a code block using bird-tracks
> each line must begin with > (which isn't significant unless it
> is at the beginning of the line).,
<IEGroup: 1>, module Hidden, <IEGroup: 1>, module Visible,
nested-style doc comments , <IEGroup: 1>, Ex(..), <IEGroup: 1>, k,
l, m, o, <IEGroup: 1>, <IEGroup: 2>,
> a literal line
$ a non /literal/ line $
, f'
) where
import Hidden
import Visible
<document comment>
data T a b
= This comment describes the 'A' constructor A Int (Maybe Float) |
This comment describes the 'B' constructor B (T a b, T Int Float)
<document comment>
data T2 a b = T2 a b
<document comment>
data T3 a b = A1 a | B1 b
data T4 a b = A2 a | B2 b
data T5 a b = documents 'A3' A3 a | documents 'B3' B3 b
<document comment>
data T6
= This is the doc for 'A4' A4 |
This is the doc for 'B4' B4 |
This is the doc for 'C4' C4
<document comment>
newtype N1 a = N1 a
<document comment>
newtype N2 a b = N2 {n :: a b}
<document comment>
newtype N3 a b = N3 {n3 :: a b this is the 'n3' field }
<document comment>
newtype N4 a b = N4 a
newtype N5 a b
= N5 {n5 :: a b no docs on the datatype or the constructor}
newtype N6 a b = docs on the constructor only N6 {n6 :: a b}
<document comment>
newtype N7 a b = The 'N7' constructor N7 {n7 :: a b}
class D a => C a where
a :: IO a
b :: [a]
c :: a
<document comment>
class D a where
d :: T a b
e :: (a, a)
<document comment>
instance D Int where
d = undefined
e = undefined
instance Test.D Float where
d = undefined
e = undefined
class E a where
ee :: a
<document comment>
class F a where
ff :: a
<document comment>
data R
= This is the 'C1' record constructor, with the following fields:
C1 {p :: Int This comment applies to the 'p' field,
q :: forall a. a -> a This comment applies to the 'q' field,
r :: Int This comment applies to both 'r' and 's',
s :: Int This comment applies to both 'r' and 's'} |
This is the 'C2' record constructor, also with some fields:
C2 {t :: T1
-> (T2 Int Int) -> (T3 Bool Bool) -> (T4 Float Float) -> T5 () (),
u :: Int,
v :: Int}
<document comment>
data R1
= This is the 'C3' record constructor
C3 {s1 :: Int The 's1' record selector,
s2 :: Int The 's2' record selector,
s3 :: Int The 's3' record selector}
<document comment>
<document comment>
<document comment>
<document comment>
f :: C a => a -> Int
<document comment>
foreign import ccall safe "static header.h g" g :: Int -> IO CInt
<document comment>
h :: Int
h = 42
<document comment>
<document comment>
<document comment>
<document comment>
<document comment>
<document comment>
<document comment>
<document comment>
<document comment>
<document comment>
<document comment>
<document comment>
<document comment>
data Ex a
= forall b. C b => Ex1 b |
forall b. Ex2 b |
forall b. C a => Ex3 b |
Ex4 (forall a. a -> a)
<document comment>
k ::
T () () This argument has type 'T'
-> (T2 Int Int) This argument has type 'T2 Int Int'
-> (T3 Bool Bool
-> T4 Float Float) This argument has type @T3 Bool Bool -> T4 Float Float@
-> T5 () () This argument has a very long description that should
hopefully cause some wrapping to happen when it is finally
rendered by Haddock in the generated HTML page.
-> IO () This is the result type
l :: (Int, Int, Float) takes a triple -> Int returns an 'Int'
<document comment>
m ::
R -> N1 () one of the arguments -> IO Int and the return value
<document comment>
newn ::
R one of the arguments, an 'R'
-> N1 () one of the arguments -> IO Int
newn = undefined
<document comment>
foreign import ccall unsafe "static header.h o" o
:: Float The input float -> IO Float The output float
<document comment>
newp :: Int
newp = undefined
<document comment>
f' :: Int
data T1
f = undefined
f' = undefined
type CInt = Int
k = undefined
l = undefined
m = undefined
Test.hs:32:9: Warning: ‘p’ is exported by ‘p’ and ‘R(..)’
Test.hs:32:12: Warning: ‘q’ is exported by ‘q’ and ‘R(..)’
Test.hs:32:15: Warning: ‘u’ is exported by ‘u’ and ‘R(..)’
Test.hs:38:9: Warning: ‘a’ is exported by ‘a’ and ‘C(a, b)’
|
