Skip to content

Commit e4747d0

Browse files
kostiskostis
committed
New documentation
1 parent 6094505 commit e4747d0

13 files changed

+248
-176
lines changed

‎resources/doc/modules-frame.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ <h2 class="indextitle">Modules</h2>
1515
<tr><td><a href="proper_transformer.html" target="overviewFrame" class="module">proper_transformer</a></td></tr>
1616
<tr><td><a href="proper_types.html" target="overviewFrame" class="module">proper_types</a></td></tr>
1717
<tr><td><a href="proper_typeserver.html" target="overviewFrame" class="module">proper_typeserver</a></td></tr>
18+
<tr><td><a href="proper_unicode.html" target="overviewFrame" class="module">proper_unicode</a></td></tr>
1819
<tr><td><a href="strip_types.html" target="overviewFrame" class="module">strip_types</a></td></tr></table>
1920
<p style="position: absolute; bottom: 0px"><a href="/" target="_top">Back to Main Page</a></p></body>
20-
</html>
21+
</html>

‎resources/doc/overview-summary.html‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
22
<html>
33
<head>
4-
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
55
<title>PropEr: A QuickCheck-inspired property-based testing tool for Erlang
66
</title>
77
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
@@ -10,8 +10,8 @@
1010
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="/" target="_top"><img src="/images/proper_tiny.png" align="right" border="0" alt="PropEr logo"></a></td></tr></table></div>
1111
<h1>PropEr: A QuickCheck-inspired property-based testing tool for Erlang
1212
</h1>
13-
<p>Copyright © 2010-2013 Manolis Papadakis, Eirini Arvaniti and Kostis Sagonas</p>
14-
<p><b>Version:</b> Apr 3 2013 10:43:12</p>
13+
<p>Copyright © 2010-2013 Manolis Papadakis, Eirini Arvaniti and Kostis Sagonas</p>
14+
<p><b>Version:</b> Jun 20 2016 16:27:13</p>
1515
<p><b>Authors:</b> Manolis Papadakis.</p>
1616
<p>This is PropEr's Reference Manual. If you are new to PropEr, you should
1717
first read the User Guide (available online at
@@ -34,10 +34,12 @@ <h1>PropEr: A QuickCheck-inspired property-based testing tool for Erlang
3434
<dt><a href="proper_statem.html"><code>proper_statem</code></a></dt>
3535
<dd>using PropEr to test stateful reactive systems specified via an abstract
3636
state machine</dd>
37+
<dt><a href="proper_unicode.html"><code>proper_unicode</code></a></dt>
38+
<dd>generating unicode strings and binaries</dd>
3739
</dl>
3840

3941
<hr>
4042
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="/" target="_top"><img src="/images/proper_tiny.png" align="right" border="0" alt="PropEr logo"></a></td></tr></table></div>
41-
<p><i>Generated by EDoc, Apr 3 2013, 10:43:12.</i></p>
43+
<p><i>Generated by EDoc, Jun 20 2016, 16:27:13.</i></p>
4244
</body>
4345
</html>

‎resources/doc/packages-frame.html‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎resources/doc/proper.html‎

Lines changed: 60 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
22
<html>
33
<head>
4-
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
55
<title>Module proper</title>
66
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
77
</head>
@@ -11,9 +11,9 @@
1111

1212
<h1>Module proper</h1>
1313
<ul class="index"><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>This is the main PropEr module.
14-
<p>Copyright © 2010-2013 Manolis Papadakis, Eirini Arvaniti and Kostis Sagonas</p>
14+
<p>Copyright © 2010-2015 Manolis Papadakis, Eirini Arvaniti and Kostis Sagonas</p>
1515

16-
<p><b>Version:</b> Apr 3 2013 10:43:12</p>
16+
<p><b>Version:</b> Jun 20 2016 16:27:12</p>
1717
<p><b>Authors:</b> Manolis Papadakis.</p>
1818

1919
<h2><a name="description">Description</a></h2><p>This is the main PropEr module.</p>
@@ -341,46 +341,51 @@ <h3><a name="Errors">Errors</a></h3><p>
341341
</dl>
342342
<h2><a name="types">Data Types</a></h2>
343343

344+
<h3 class="typedecl"><a name="type-clean_input">clean_input()</a></h3>
345+
<p><pre>clean_input() = <a href="proper_gen.html#type-instance">proper_gen:instance()</a> | <a href="#type-sub_counterexamples">sub_counterexamples()</a></pre></p>
346+
347+
344348
<h3 class="typedecl"><a name="type-counterexample">counterexample()</a></h3>
345-
<p><pre>counterexample() =
346-
[<a href="proper_gen.html#type-instance">proper_gen:instance()</a> | [{<a href="#type-tag">tag()</a>, <a href="#type-counterexample">counterexample()</a>}]]</pre></p>
349+
<p><pre>counterexample() = [<a href="#type-clean_input">clean_input()</a>]</pre></p>
350+
351+
352+
<h3 class="typedecl"><a name="type-error">error()</a></h3>
353+
<p><pre>error() = {error, <a href="#type-error_reason">error_reason()</a>}</pre></p>
347354

348355

349356
<h3 class="typedecl"><a name="type-error_reason">error_reason()</a></h3>
350-
<p><pre>error_reason() = arity_limit
351-
| cant_generate
352-
| cant_satisfy
353-
| non_boolean_result
354-
| rejected
355-
| too_many_instances
356-
| type_mismatch
357-
| wrong_type
358-
| {typeserver, term()}
359-
| {unexpected, any()}
360-
| {unrecognized_option, term()}</pre></p>
357+
<p><pre>error_reason() =
358+
arity_limit |
359+
cant_generate |
360+
cant_satisfy |
361+
non_boolean_result |
362+
rejected |
363+
too_many_instances |
364+
type_mismatch |
365+
wrong_type |
366+
{typeserver, term()} |
367+
{unexpected, any()} |
368+
{unrecognized_option, term()}</pre></p>
361369

362370

363371
<h3 class="typedecl"><a name="type-false_positive_mfas">false_positive_mfas()</a></h3>
364-
<p><pre>false_positive_mfas() = fun((mfa(),
365-
Args :: [term()],
366-
{fail, Result :: term()} |
367-
{error | exit | throw,
368-
Reason :: term()}) -&gt;
369-
boolean())
370-
| undefined</pre></p>
372+
<p><pre>false_positive_mfas() =
373+
fun((mfa(),
374+
Args :: [term()],
375+
{fail, Result :: term()} |
376+
{error | exit | throw, Reason :: term()}) -&gt;
377+
boolean()) |
378+
undefined</pre></p>
371379
<p> -----------------------------------------------------------------------------
372380
Options and Context types
373381
-----------------------------------------------------------------------------</p>
374382

375383
<h3 class="typedecl"><a name="type-long_module_result">long_module_result()</a></h3>
376-
<p><pre>long_module_result() = [{mfa(), <a href="#type-counterexample">counterexample()</a>}]
377-
| {error, <a href="#type-error_reason">error_reason()</a>}</pre></p>
384+
<p><pre>long_module_result() = [{mfa(), <a href="#type-counterexample">counterexample()</a>}] | <a href="#type-error">error()</a></pre></p>
378385

379386

380387
<h3 class="typedecl"><a name="type-long_result">long_result()</a></h3>
381-
<p><pre>long_result() = true
382-
| <a href="#type-counterexample">counterexample()</a>
383-
| {error, <a href="#type-error_reason">error_reason()</a>}</pre></p>
388+
<p><pre>long_result() = true | <a href="#type-counterexample">counterexample()</a> | <a href="#type-error">error()</a></pre></p>
384389

385390

386391
<h3 class="typedecl"><a name="type-mod_name">mod_name()</a></h3>
@@ -410,26 +415,30 @@ <h3 class="typedecl"><a name="type-sample">sample()</a></h3>
410415

411416

412417
<h3 class="typedecl"><a name="type-short_module_result">short_module_result()</a></h3>
413-
<p><pre>short_module_result() = [mfa()] | {error, <a href="#type-error_reason">error_reason()</a>}</pre></p>
418+
<p><pre>short_module_result() = [mfa()] | <a href="#type-error">error()</a></pre></p>
414419

415420

416421
<h3 class="typedecl"><a name="type-short_result">short_result()</a></h3>
417-
<p><pre>short_result() = boolean() | {error, <a href="#type-error_reason">error_reason()</a>}</pre></p>
422+
<p><pre>short_result() = boolean() | <a href="#type-error">error()</a></pre></p>
418423

419424

420425
<h3 class="typedecl"><a name="type-size">size()</a></h3>
421426
<p><pre>size() = non_neg_integer()</pre></p>
422427

423428

424429
<h3 class="typedecl"><a name="type-stats_printer">stats_printer()</a></h3>
425-
<p><pre>stats_printer() = fun((<a href="#type-sample">sample()</a>) -&gt; ok)
426-
| fun((<a href="#type-sample">sample()</a>, <a href="#type-output_fun">output_fun()</a>) -&gt; ok)</pre></p>
430+
<p><pre>stats_printer() =
431+
fun((<a href="#type-sample">sample()</a>) -&gt; ok) | fun((<a href="#type-sample">sample()</a>, <a href="#type-output_fun">output_fun()</a>) -&gt; ok)</pre></p>
427432
<p> A stats-printing function that can be passed to some of the statistics
428433
collection functions, to be used instead of the predefined stats-printer.
429434
Such a function will be called at the end of testing (in case no test fails)
430435
with a sorted list of collected terms. A commonly used stats-printer is
431436
<code>with_title/1</code>.</p>
432437

438+
<h3 class="typedecl"><a name="type-sub_counterexamples">sub_counterexamples()</a></h3>
439+
<p><pre>sub_counterexamples() = [{<a href="#type-tag">tag()</a>, <a href="#type-counterexample">counterexample()</a>}]</pre></p>
440+
441+
433442
<h3 class="typedecl"><a name="type-tag">tag()</a></h3>
434443
<p><pre>tag() = atom()</pre></p>
435444

@@ -444,23 +453,24 @@ <h3 class="typedecl"><a name="type-title">title()</a></h3>
444453

445454

446455
<h3 class="typedecl"><a name="type-user_opt">user_opt()</a></h3>
447-
<p><pre>user_opt() = quiet
448-
| verbose
449-
| {to_file, <a href="file.html#type-io_device">file:io_device()</a>}
450-
| {on_output, <a href="#type-output_fun">output_fun()</a>}
451-
| long_result
452-
| {numtests, pos_integer()}
453-
| pos_integer()
454-
| {start_size, <a href="#type-size">size()</a>}
455-
| {max_size, <a href="#type-size">size()</a>}
456-
| {max_shrinks, non_neg_integer()}
457-
| noshrink
458-
| {constraint_tries, pos_integer()}
459-
| fails
460-
| any_to_integer
461-
| {spec_timeout, timeout()}
462-
| {skip_mfas, [mfa()]}
463-
| {false_positive_mfas, <a href="#type-false_positive_mfas">false_positive_mfas()</a>}</pre></p>
456+
<p><pre>user_opt() =
457+
quiet |
458+
verbose |
459+
{to_file, <a href="io.html#type-device">io:device()</a>} |
460+
{on_output, <a href="#type-output_fun">output_fun()</a>} |
461+
long_result |
462+
{numtests, pos_integer()} |
463+
pos_integer() |
464+
{start_size, <a href="#type-size">size()</a>} |
465+
{max_size, <a href="#type-size">size()</a>} |
466+
{max_shrinks, non_neg_integer()} |
467+
noshrink |
468+
{constraint_tries, pos_integer()} |
469+
fails |
470+
any_to_integer |
471+
{spec_timeout, timeout()} |
472+
{skip_mfas, [mfa()]} |
473+
{false_positive_mfas, <a href="#type-false_positive_mfas">false_positive_mfas()</a>}</pre></p>
464474

465475

466476
<h3 class="typedecl"><a name="type-user_opts">user_opts()</a></h3>
@@ -704,6 +714,6 @@ <h3 class="function"><a name="with_title-1">with_title/1</a></h3>
704714
<hr>
705715

706716
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="/" target="_top"><img src="/images/proper_tiny.png" align="right" border="0" alt="PropEr logo"></a></td></tr></table></div>
707-
<p><i>Generated by EDoc, Apr 3 2013, 10:43:12.</i></p>
717+
<p><i>Generated by EDoc, Jun 20 2016, 16:27:12.</i></p>
708718
</body>
709719
</html>

0 commit comments

Comments
 (0)