Ticket #1632: Test-HUnit-Lang.html

File Test-HUnit-Lang.html, 8.5 KB (added by himself@…, 7 years ago)

HTML docs produced by Haddock

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--Rendered using the Haskell Html Library v0.2-->
3<HTML
4><HEAD
5><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
6><TITLE
7>Test.HUnit.Lang</TITLE
8>
9<style type="text/css">
10/* -------- Global things --------- */
11
12BODY { 
13  background-color: #ffffff;
14  color: #000000;
15  font-family: sans-serif;
16  } 
17
18A:link    { color: #0000e0; text-decoration: none }
19A:visited { color: #0000a0; text-decoration: none }
20A:hover   { background-color: #e0e0ff; text-decoration: none }
21
22TABLE.vanilla {
23  width: 100%;
24  border-width: 0px;
25  /* I can't seem to specify cellspacing or cellpadding properly using CSS... */
26}
27
28TABLE.vanilla2 {
29  border-width: 0px;
30}
31
32/* <TT> font is a little too small in MSIE */
33TT  { font-size: 100%; }
34PRE { font-size: 100%; }
35
36LI P { margin: 0pt } 
37
38TD {
39  border-width: 0px;
40}
41
42TABLE.narrow {
43  border-width: 0px;
44}
45
46TD.s8  {  height: 8px;  }
47TD.s15 {  height: 15px; }
48
49SPAN.keyword { text-decoration: underline; }
50
51/* Resize the buttom image to match the text size */
52IMG.coll { width : 0.75em; height: 0.75em; margin-bottom: 0; margin-right: 0.5em }
53
54/* --------- Contents page ---------- */
55
56DIV.node {
57  padding-left: 3em;
58}
59
60DIV.cnode {
61  padding-left: 1.75em;
62}
63
64SPAN.pkg {
65  position: absolute;
66  left: 50em;
67}
68
69/* --------- Documentation elements ---------- */
70
71TD.children {
72  padding-left: 25px;
73  }
74
75TD.synopsis {
76  padding: 2px;
77  background-color: #f0f0f0;
78  font-family: monospace
79 }
80
81TD.decl { 
82  padding: 2px;
83  background-color: #f0f0f0; 
84  font-family: monospace;
85  vertical-align: top;
86  }
87
88TD.topdecl {
89  padding: 2px;
90  background-color: #f0f0f0;
91  font-family: monospace;
92  vertical-align: top;
93}
94
95TABLE.declbar {
96  border-spacing: 0px;
97 }
98
99TD.declname {
100  width: 100%;
101 }
102
103TD.declbut {
104  padding-left: 5px;
105  padding-right: 5px;
106  border-left-width: 1px;
107  border-left-color: #000099;
108  border-left-style: solid;
109  white-space: nowrap;
110  font-size: small;
111 }
112
113/*
114  arg is just like decl, except that wrapping is not allowed.  It is
115  used for function and constructor arguments which have a text box
116  to the right, where if wrapping is allowed the text box squashes up
117  the declaration by wrapping it.
118*/
119TD.arg { 
120  padding: 2px;
121  background-color: #f0f0f0; 
122  font-family: monospace;
123  vertical-align: top;
124  white-space: nowrap;
125  }
126
127TD.recfield { padding-left: 20px }
128
129TD.doc  { 
130  padding-top: 2px;
131  padding-left: 10px;
132  }
133
134TD.ndoc  { 
135  padding: 2px;
136  }
137
138TD.rdoc  { 
139  padding: 2px;
140  padding-left: 10px;
141  width: 100%;
142  }
143
144TD.body  { 
145  padding-left: 10px
146  }
147
148TD.pkg {
149  width: 100%;
150  padding-left: 10px
151}
152
153TD.indexentry {
154  vertical-align: top;
155  padding-right: 10px
156  }
157
158TD.indexannot {
159  vertical-align: top;
160  padding-left: 20px;
161  white-space: nowrap
162  }
163
164TD.indexlinks {
165  width: 100%
166  }
167
168/* ------- Section Headings ------- */
169
170TD.section1 {
171  padding-top: 15px;
172  font-weight: bold;
173  font-size: 150%
174  }
175
176TD.section2 {
177  padding-top: 10px;
178  font-weight: bold;
179  font-size: 130%
180  }
181
182TD.section3 {
183  padding-top: 5px;
184  font-weight: bold;
185  font-size: 110%
186  }
187
188TD.section4 {
189  font-weight: bold;
190  font-size: 100%
191  }
192
193/* -------------- The title bar at the top of the page */
194
195TD.infohead {
196  color: #ffffff;
197  font-weight: bold;
198  padding-right: 10px;
199  text-align: left;
200}
201
202TD.infoval {
203  color: #ffffff;
204  padding-right: 10px;
205  text-align: left;
206}
207
208TD.topbar {
209  background-color: #000099;
210  padding: 5px;
211}
212
213TD.title {
214  color: #ffffff;
215  padding-left: 10px;
216  width: 100%
217  }
218
219TD.topbut {
220  padding-left: 5px;
221  padding-right: 5px;
222  border-left-width: 1px;
223  border-left-color: #ffffff;
224  border-left-style: solid;
225  white-space: nowrap;
226  }
227
228TD.topbut A:link {
229  color: #ffffff
230  }
231
232TD.topbut A:visited {
233  color: #ffff00
234  }
235
236TD.topbut A:hover {
237  background-color: #6060ff;
238  }
239
240TD.topbut:hover {
241  background-color: #6060ff
242  }
243
244TD.modulebar { 
245  background-color: #0077dd;
246  padding: 5px;
247  border-top-width: 1px;
248  border-top-color: #ffffff;
249  border-top-style: solid;
250  }
251
252/* --------- The page footer --------- */
253
254TD.botbar {
255  background-color: #000099;
256  color: #ffffff;
257  padding: 5px
258  }
259TD.botbar A:link {
260  color: #ffffff;
261  text-decoration: underline
262  }
263TD.botbar A:visited {
264  color: #ffff00
265  }
266TD.botbar A:hover {
267  background-color: #6060ff
268  }
269</style>
270<SCRIPT TYPE="text/javascript">
271//<!--
272// Haddock JavaScript utilities
273function toggle(button,id)
274{
275   var n = document.getElementById(id).style;
276   if (n.display == "none")
277   {
278        button.src = "minus.gif";
279        n.display = "block";
280   }
281   else
282   {
283        button.src = "plus.gif";
284        n.display = "none";
285   }
286}
287//-->
288</SCRIPT>
289</HEAD
290><BODY
291><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
292><TR
293><TD CLASS="topbar"
294><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
295><TR
296><TD
297><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
298></TD
299><TD CLASS="title"
300></TD
301><TD CLASS="topbut"
302><A HREF="index.html"
303>Contents</A
304></TD
305><TD CLASS="topbut"
306><A HREF="doc-index.html"
307>Index</A
308></TD
309></TR
310></TABLE
311></TD
312></TR
313><TR
314><TD CLASS="modulebar"
315><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
316><TR
317><TD
318><FONT SIZE="6"
319>Test.HUnit.Lang</FONT
320></TD
321></TR
322></TABLE
323></TD
324></TR
325><TR
326><TD CLASS="s15"
327></TD
328></TR
329><TR
330><TD CLASS="section1"
331>Description</TD
332></TR
333><TR
334><TD CLASS="doc"
335>HUnit language support.
336</TD
337></TR
338><TR
339><TD CLASS="s15"
340></TD
341></TR
342><TR
343><TD CLASS="section1"
344>Synopsis</TD
345></TR
346><TR
347><TD CLASS="s15"
348></TD
349></TR
350><TR
351><TD CLASS="body"
352><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
353><TR
354><TD CLASS="decl"
355><SPAN CLASS="keyword"
356>type</SPAN
357> <A HREF="#t%3AAssertion"
358>Assertion</A
359> = IO ()</TD
360></TR
361><TR
362><TD CLASS="s8"
363></TD
364></TR
365><TR
366><TD CLASS="decl"
367><A HREF="#v%3AassertFailure"
368>assertFailure</A
369> :: String -&gt; <A HREF="Test-HUnit-Lang.html#t%3AAssertion"
370>Assertion</A
371></TD
372></TR
373><TR
374><TD CLASS="s8"
375></TD
376></TR
377><TR
378><TD CLASS="decl"
379><A HREF="#v%3AperformTestCase"
380>performTestCase</A
381> :: <A HREF="Test-HUnit-Lang.html#t%3AAssertion"
382>Assertion</A
383> -&gt; IO (Maybe (Bool, String))</TD
384></TR
385></TABLE
386></TD
387></TR
388><TR
389><TD CLASS="s15"
390></TD
391></TR
392><TR
393><TD CLASS="section1"
394>Documentation</TD
395></TR
396><TR
397><TD CLASS="s15"
398></TD
399></TR
400><TR
401><TD CLASS="decl"
402><SPAN CLASS="keyword"
403>type</SPAN
404> <A NAME="t%3AAssertion"
405></A
406><B
407>Assertion</B
408> = IO ()</TD
409></TR
410><TR
411><TD CLASS="doc"
412>An assertion is an IO computation with trivial result. An assertion or
413   a sequence of assertions makes up a test case.
414</TD
415></TR
416><TR
417><TD CLASS="s15"
418></TD
419></TR
420><TR
421><TD CLASS="decl"
422><A NAME="v%3AassertFailure"
423></A
424><B
425>assertFailure</B
426></TD
427></TR
428><TR
429><TD CLASS="body"
430><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
431><TR
432><TD CLASS="arg"
433>:: String</TD
434><TD CLASS="rdoc"
435>a message that is displayed with the assertion failure
436</TD
437></TR
438><TR
439><TD CLASS="arg"
440>-&gt; <A HREF="Test-HUnit-Lang.html#t%3AAssertion"
441>Assertion</A
442></TD
443><TD CLASS="rdoc"
444></TD
445></TR
446><TR
447><TD CLASS="ndoc" COLSPAN="2"
448>signals an assertion failure with a given message.
449</TD
450></TR
451></TABLE
452></TD
453></TR
454><TR
455><TD CLASS="s15"
456></TD
457></TR
458><TR
459><TD CLASS="decl"
460><A NAME="v%3AperformTestCase"
461></A
462><B
463>performTestCase</B
464></TD
465></TR
466><TR
467><TD CLASS="body"
468><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
469><TR
470><TD CLASS="arg"
471>:: <A HREF="Test-HUnit-Lang.html#t%3AAssertion"
472>Assertion</A
473></TD
474><TD CLASS="rdoc"
475>an assertion to be made during the test case run
476</TD
477></TR
478><TR
479><TD CLASS="arg"
480>-&gt; IO (Maybe (Bool, String))</TD
481><TD CLASS="rdoc"
482></TD
483></TR
484><TR
485><TD CLASS="ndoc" COLSPAN="2"
486><P
487>performs a single test case.  The meaning of the result is as follows:
488</P
489><DL
490><DT
491><TT
492>Nothing</TT
493></DT
494><DD
495>           test case success
496</DD
497><DT
498><TT
499>Just (True,  msg)</TT
500></DT
501><DD
502> test case failure with the given message
503</DD
504><DT
505><TT
506>Just (False, msg)</TT
507></DT
508><DD
509> test case error with the given message
510</DD
511></DL
512></TD
513></TR
514></TABLE
515></TD
516></TR
517><TR
518><TD CLASS="s15"
519></TD
520></TR
521><TR
522><TD CLASS="botbar"
523>Produced by <A HREF="http://www.haskell.org/haddock/"
524>Haddock</A
525> version 0.8</TD
526></TR
527></TABLE
528></BODY
529></HTML
530>