The Backpack patch.
[ghc.git] / testsuite / tests / haddock / haddock_examples / haddock.Test.stderr
1 [1 of 3] Compiling Hidden           ( Hidden.hs, Hidden.o )
2
3 ==================== Parser ====================
4 module Hidden where
5 hidden :: Int -> Int
6 hidden a = a
7
8
9 [2 of 3] Compiling Visible          ( Visible.hs, Visible.o )
10
11 ==================== Parser ====================
12 module Visible where
13 visible :: Int -> Int
14 visible a = a
15
16
17 [3 of 3] Compiling Test             ( Test.hs, Test.o )
18
19 ==================== Parser ====================
20
21  Module      :  Test
22  Copyright   :  (c) Simon Marlow 2002
23  License     :  BSD-style
24
25  Maintainer  :  libraries@haskell.org
26  Stability   :  provisional
27  Portability :  portable
28
29  This module illustrates & tests most of the features of Haddock.
30  Testing references from the description: 'T', 'f', 'g', 'Visible.visible'.
31
32 module Test (
33         <IEGroup: 1>, <IEGroup: 2>, T(..), T2, T3(..), T4(..), T5(..),
34         T6(..), N1(..), N2(..), N3(..), N4, N5(..), N6(..), N7(..),
35         <IEGroup: 2>, R(..), R1(..),
36          test that we can export record selectors on their own:, p, q, u,
37         <IEGroup: 1>, C(a, b), D(..), E, F(..),
38          Test that we can export a class method on its own:, a,
39         <IEGroup: 1>, f, g, <IEGroup: 1>, <IEDocNamed: aux1>,
40         <IEDocNamed: aux2>, <IEDocNamed: aux3>, <IEDocNamed: aux4>,
41         <IEDocNamed: aux5>, <IEDocNamed: aux6>, <IEDocNamed: aux7>,
42         <IEDocNamed: aux8>, <IEDocNamed: aux9>, <IEDocNamed: aux10>,
43         <IEDocNamed: aux11>, <IEDocNamed: aux12>,
44          This is some inline documentation in the export list
45
46  > a code block using bird-tracks
47  > each line must begin with > (which isn't significant unless it
48  > is at the beginning of the line).,
49         <IEGroup: 1>, module Hidden, <IEGroup: 1>, module Visible,
50          nested-style doc comments , <IEGroup: 1>, Ex(..), <IEGroup: 1>, k,
51         l, m, o, <IEGroup: 1>, <IEGroup: 2>,
52         
53  > a literal line
54
55  $ a non /literal/ line $
56 , f'
57     ) where
58 import Hidden
59 import Visible
60 <document comment>
61 data T a b
62   =  This comment describes the 'A' constructor A Int (Maybe Float) |
63      This comment describes the 'B' constructor B (T a b, T Int Float)
64 <document comment>
65 data T2 a b = T2 a b
66 <document comment>
67 data T3 a b = A1 a | B1 b
68 data T4 a b = A2 a | B2 b
69 data T5 a b =  documents 'A3' A3 a |  documents 'B3' B3 b
70 <document comment>
71 data T6
72   =  This is the doc for 'A4' A4 |
73      This is the doc for 'B4' B4 |
74      This is the doc for 'C4' C4
75 <document comment>
76 newtype N1 a = N1 a
77 <document comment>
78 newtype N2 a b = N2 {n :: a b}
79 <document comment>
80 newtype N3 a b = N3 {n3 :: a b  this is the 'n3' field}
81 <document comment>
82 newtype N4 a b = N4 a
83 newtype N5 a b
84   = N5 {n5 :: a b  no docs on the datatype or the constructor}
85 newtype N6 a b =  docs on the constructor only N6 {n6 :: a b}
86 <document comment>
87 newtype N7 a b =  The 'N7' constructor N7 {n7 :: a b}
88 class (D a) => C a where
89   a :: IO a
90   b :: [a]
91   c :: a
92 <document comment>
93 class D a where
94   d :: T a b
95   e :: (a, a)
96 <document comment>
97 instance D Int where
98   d = undefined
99   e = undefined
100 instance Test.D Float where
101   d = undefined
102   e = undefined
103 class E a where
104   ee :: a
105 <document comment>
106 class F a where
107   ff :: a
108 <document comment>
109 data R
110   =  This is the 'C1' record constructor, with the following fields:
111     C1 {p :: Int  This comment applies to the 'p' field,
112         q :: forall a. a -> a  This comment applies to the 'q' field,
113         r, s :: Int  This comment applies to both 'r' and 's'} |
114      This is the 'C2' record constructor, also with some fields:
115     C2 {t :: T1
116              -> (T2 Int Int) -> (T3 Bool Bool) -> (T4 Float Float) -> T5 () (),
117         u, v :: Int}
118 <document comment>
119 data R1
120   =  This is the 'C3' record constructor
121     C3 {s1 :: Int  The 's1' record selector,
122         s2 :: Int  The 's2' record selector,
123         s3 :: Int  The 's3' record selector}
124 <document comment>
125 <document comment>
126 <document comment>
127 <document comment>
128 f :: C a => a -> Int
129 <document comment>
130 foreign import ccall safe "static header.h g" g :: Int -> IO CInt
131 <document comment>
132 h :: Int
133 h = 42
134 <document comment>
135 <document comment>
136 <document comment>
137 <document comment>
138 <document comment>
139 <document comment>
140 <document comment>
141 <document comment>
142 <document comment>
143 <document comment>
144 <document comment>
145 <document comment>
146 <document comment>
147 data Ex a
148   = forall b. C b => Ex1 b |
149     forall b. Ex2 b |
150     forall b. C a => Ex3 b |
151     Ex4 (forall a. a -> a)
152 <document comment>
153 k ::
154   T () ()  This argument has type 'T'
155   -> (T2 Int Int)  This argument has type 'T2 Int Int'
156      -> (T3 Bool Bool
157          -> T4 Float Float)  This argument has type @T3 Bool Bool -> T4 Float Float@
158         -> T5 () ()  This argument has a very long description that should
159  hopefully cause some wrapping to happen when it is finally
160  rendered by Haddock in the generated HTML page.
161            -> IO ()  This is the result type
162 l :: (Int, Int, Float)  takes a triple -> Int  returns an 'Int'
163 <document comment>
164 m ::
165   R -> N1 ()  one of the arguments -> IO Int  and the return value
166 <document comment>
167 newn ::
168   R  one of the arguments, an 'R'
169   -> N1 ()  one of the arguments -> IO Int
170 newn = undefined
171 <document comment>
172 foreign import ccall unsafe "static header.h o" o
173   :: Float  The input float -> IO Float  The output float
174 <document comment>
175 newp :: Int
176 newp = undefined
177 <document comment>
178 f' :: Int
179 data T1
180 f = undefined
181 f' = undefined
182 type CInt = Int
183 k = undefined
184 l = undefined
185 m = undefined
186
187
188
189 Test.hs:33:9: warning: [-Wduplicate-exports (in -Wdefault)]
190     ‘p’ is exported by ‘p’ and ‘R(..)’
191
192 Test.hs:33:12: warning: [-Wduplicate-exports (in -Wdefault)]
193     ‘q’ is exported by ‘q’ and ‘R(..)’
194
195 Test.hs:33:15: warning: [-Wduplicate-exports (in -Wdefault)]
196     ‘u’ is exported by ‘u’ and ‘R(..)’
197
198 Test.hs:39:9: warning: [-Wduplicate-exports (in -Wdefault)]
199     ‘a’ is exported by ‘a’ and ‘C(a, b)’