Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update edocs

  • Loading branch information...
commit e8bcd9927bc387597a0bc7f20306c7b34cb490e7 1 parent 07032c5
@norton authored
View
14 README.md
@@ -10,9 +10,7 @@ QuickCheck and Proper testing tools.</p>
<p><em>This repository is a "work-in-progress" - please contribute if you
find QC useful.</em></p>
-
-##Quick Start Recipe##
-
+<h2 id="_quick_start_recipe">Quick Start Recipe</h2>
<p>To download and build the qc application in one shot, please follow
this recipe:</p>
@@ -30,13 +28,15 @@ $ ./rebar skip_deps=true doc</tt></pre>
-##Documentation##
+<h2 id="_documentation">Documentation</h2>
<h3 id="_where_should_i_start">Where should I start?</h3>
<p>This README is the only bit of documentation right now.</p>
<p>Please see <a href="https://github.com/norton/lets">https://github.com/norton/lets</a> for an Erlang application
that has been developed and tested by using <strong>only</strong> QC.</p>
+
+
<h3 id="_what_is_quickcheck">What is QuickCheck?</h3>
<p>QuickCheck is a commercial property-based testing tool for Erlang.</p>
<ul>
@@ -53,6 +53,8 @@ A <em>tool</em> for testing properties in randomly generated cases.
</li>
</ul>
<p>See <a href="http://www.quviq.com/">http://www.quviq.com/</a> for further details.</p>
+
+
<h3 id="_what_is_proper">What is Proper?</h3>
<p>PropEr (PROPerty-based testing tool for ERlang) is a
QuickCheck-inspired open-source property-based testing tool for
@@ -61,8 +63,8 @@ Erlang.</p>
-##Roadmap##
+<h2 id="_roadmap">Roadmap</h2>
<ul>
<li>
@@ -85,12 +87,14 @@ PropEr resize issue (<a href="https://github.com/manopapad/proper/issues/10">htt
+
##Modules##
<table width="100%" border="0" summary="list of modules">
<tr><td><a href="https://github.com/norton/qc/blob/master/doc/qc.md" class="module">qc</a></td></tr>
<tr><td><a href="https://github.com/norton/qc/blob/master/doc/qc_gen.md" class="module">qc_gen</a></td></tr>
+<tr><td><a href="https://github.com/norton/qc/blob/master/doc/qc_gen_http.md" class="module">qc_gen_http</a></td></tr>
<tr><td><a href="https://github.com/norton/qc/blob/master/doc/qc_slave.md" class="module">qc_slave</a></td></tr>
<tr><td><a href="https://github.com/norton/qc/blob/master/doc/qc_statem.md" class="module">qc_statem</a></td></tr></table>
View
14 doc/README.md
@@ -10,9 +10,7 @@ QuickCheck and Proper testing tools.</p>
<p><em>This repository is a "work-in-progress" - please contribute if you
find QC useful.</em></p>
-
-##Quick Start Recipe##
-
+<h2 id="_quick_start_recipe">Quick Start Recipe</h2>
<p>To download and build the qc application in one shot, please follow
this recipe:</p>
@@ -30,13 +28,15 @@ $ ./rebar skip_deps=true doc</tt></pre>
-##Documentation##
+<h2 id="_documentation">Documentation</h2>
<h3 id="_where_should_i_start">Where should I start?</h3>
<p>This README is the only bit of documentation right now.</p>
<p>Please see <a href="https://github.com/norton/lets">https://github.com/norton/lets</a> for an Erlang application
that has been developed and tested by using <strong>only</strong> QC.</p>
+
+
<h3 id="_what_is_quickcheck">What is QuickCheck?</h3>
<p>QuickCheck is a commercial property-based testing tool for Erlang.</p>
<ul>
@@ -53,6 +53,8 @@ A <em>tool</em> for testing properties in randomly generated cases.
</li>
</ul>
<p>See <a href="http://www.quviq.com/">http://www.quviq.com/</a> for further details.</p>
+
+
<h3 id="_what_is_proper">What is Proper?</h3>
<p>PropEr (PROPerty-based testing tool for ERlang) is a
QuickCheck-inspired open-source property-based testing tool for
@@ -61,8 +63,8 @@ Erlang.</p>
-##Roadmap##
+<h2 id="_roadmap">Roadmap</h2>
<ul>
<li>
@@ -85,12 +87,14 @@ PropEr resize issue (<a href="https://github.com/manopapad/proper/issues/10">htt
+
##Modules##
<table width="100%" border="0" summary="list of modules">
<tr><td><a href="qc.md" class="module">qc</a></td></tr>
<tr><td><a href="qc_gen.md" class="module">qc_gen</a></td></tr>
+<tr><td><a href="qc_gen_http.md" class="module">qc_gen_http</a></td></tr>
<tr><td><a href="qc_slave.md" class="module">qc_slave</a></td></tr>
<tr><td><a href="qc_statem.md" class="module">qc_statem</a></td></tr></table>
View
2  doc/edoc-info
@@ -1,3 +1,3 @@
{application,qc}.
{packages,[]}.
-{modules,[qc,qc_gen,qc_slave,qc_statem]}.
+{modules,[qc,qc_gen,qc_gen_http,qc_slave,qc_statem]}.
View
7 doc/qc_gen_http.md
@@ -0,0 +1,7 @@
+
+
+#Module qc_gen_http#
+
+
+
+
View
32 doc/qc_statem.md
@@ -9,10 +9,6 @@
-
-__This module defines the `qc_statem` behaviour.__
-<br></br>
- Required callback functions: `command_gen/2`, `initial_state/0`, `state_is_sane/1`, `next_state/3`, `precondition/2`, `postcondition/3`, `commands_setup/1`, `commands_teardown/1`, `commands_teardown/2`.
<a name="types"></a>
##Data Types##
@@ -38,7 +34,7 @@ __abstract datatype__: `modstate()`
##Function Index##
-<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#behaviour_info-1">behaviour_info/1</a></td><td></td></tr><tr><td valign="top"><a href="#command-1">command/1</a></td><td></td></tr><tr><td valign="top"><a href="#initial_state-0">initial_state/0</a></td><td></td></tr><tr><td valign="top"><a href="#initial_state-1">initial_state/1</a></td><td></td></tr><tr><td valign="top"><a href="#next_state-3">next_state/3</a></td><td></td></tr><tr><td valign="top"><a href="#postcondition-3">postcondition/3</a></td><td></td></tr><tr><td valign="top"><a href="#precondition-2">precondition/2</a></td><td></td></tr><tr><td valign="top"><a href="#qc_gen_command-2">qc_gen_command/2</a></td><td></td></tr><tr><td valign="top"><a href="#qc_run_commands-1">qc_run_commands/1</a></td><td></td></tr><tr><td valign="top"><a href="#qc_run_commands-2">qc_run_commands/2</a></td><td></td></tr><tr><td valign="top"><a href="#qc_sample_commands-1">qc_sample_commands/1</a></td><td></td></tr><tr><td valign="top"><a href="#qc_sample_commands-2">qc_sample_commands/2</a></td><td></td></tr></table>
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#behaviour_info-1">behaviour_info/1</a></td><td></td></tr><tr><td valign="top"><a href="#command-1">command/1</a></td><td></td></tr><tr><td valign="top"><a href="#initial_state-0">initial_state/0</a></td><td></td></tr><tr><td valign="top"><a href="#initial_state-1">initial_state/1</a></td><td></td></tr><tr><td valign="top"><a href="#next_state-3">next_state/3</a></td><td></td></tr><tr><td valign="top"><a href="#postcondition-3">postcondition/3</a></td><td></td></tr><tr><td valign="top"><a href="#precondition-2">precondition/2</a></td><td></td></tr><tr><td valign="top"><a href="#qc_gen_command-2">qc_gen_command/2</a></td><td></td></tr><tr><td valign="top"><a href="#qc_prop-1">qc_prop/1</a></td><td></td></tr><tr><td valign="top"><a href="#qc_prop-2">qc_prop/2</a></td><td></td></tr><tr><td valign="top"><a href="#qc_sample-1">qc_sample/1</a></td><td></td></tr><tr><td valign="top"><a href="#qc_sample-2">qc_sample/2</a></td><td></td></tr></table>
<a name="functions"></a>
@@ -115,51 +111,51 @@ __abstract datatype__: `modstate()`
-<pre>qc_gen_command(Mod::module(), ModState::[modstate()](#type-modstate)) -&gt; any()</pre>
+<pre>qc_gen_command(Mod::module(), ModState::<a href="#type-modstate">modstate()</a>) -> any()</pre>
<br></br>
-<a name="qc_run_commands-1"></a>
+<a name="qc_prop-1"></a>
-###qc_run_commands/1##
+###qc_prop/1##
-<pre>qc_run_commands(Mod::module()) -&gt; any()</pre>
+<pre>qc_prop(Mod::module()) -&gt; any()</pre>
<br></br>
-<a name="qc_run_commands-2"></a>
+<a name="qc_prop-2"></a>
-###qc_run_commands/2##
+###qc_prop/2##
-<pre>qc_run_commands(Mod::module(), Options::[proplist()](#type-proplist)) -&gt; any()</pre>
+<pre>qc_prop(Mod::module(), Options::<a href="#type-proplist">proplist()</a>) -> any()</pre>
<br></br>
-<a name="qc_sample_commands-1"></a>
+<a name="qc_sample-1"></a>
-###qc_sample_commands/1##
+###qc_sample/1##
-<pre>qc_sample_commands(Mod::module()) -&gt; any()</pre>
+<pre>qc_sample(Mod::module()) -&gt; any()</pre>
<br></br>
-<a name="qc_sample_commands-2"></a>
+<a name="qc_sample-2"></a>
-###qc_sample_commands/2##
+###qc_sample/2##
-<pre>qc_sample_commands(Mod::module(), Options::[proplist()](#type-proplist)) -&gt; any()</pre>
+<pre>qc_sample(Mod::module(), Options::<a href="#type-proplist">proplist()</a>) -> any()</pre>
<br></br>
Please sign in to comment.
Something went wrong with that request. Please try again.