summaryrefslogtreecommitdiff
path: root/doc/doc/modules/luacov.defaults.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/doc/modules/luacov.defaults.html')
-rw-r--r--doc/doc/modules/luacov.defaults.html44
1 files changed, 32 insertions, 12 deletions
diff --git a/doc/doc/modules/luacov.defaults.html b/doc/doc/modules/luacov.defaults.html
index 52bdc0e..c512c18 100644
--- a/doc/doc/modules/luacov.defaults.html
+++ b/doc/doc/modules/luacov.defaults.html
@@ -41,10 +41,12 @@
<ul class="nowrap">
<li><a href="../modules/luacov.html">luacov</a></li>
<li><strong>luacov.defaults</strong></li>
+ <li><a href="../modules/luacov.hook.html">luacov.hook</a></li>
<li><a href="../modules/luacov.reporter.html">luacov.reporter</a></li>
<li><a href="../modules/luacov.runner.html">luacov.runner</a></li>
<li><a href="../modules/luacov.stats.html">luacov.stats</a></li>
<li><a href="../modules/luacov.tick.html">luacov.tick</a></li>
+ <li><a href="../modules/luacov.util.html">luacov.util</a></li>
</ul>
</div>
@@ -52,11 +54,10 @@
<div id="content">
<h1>Module <code>luacov.defaults</code></h1>
-<p>Default configuration file.</p>
-<p> Copy, customize and store in your
- project folder as '.luacov' for project specific configuration.
- If some options are missing, their default values from this file
- will be used.</p>
+<p>Default values for configuration options.</p>
+<p> For project specific configuration create '.luacov' file in your project
+ folder. It should be a Lua script setting various options as globals
+ or returning table of options.</p>
<h2><a href="#Tables">Tables</a></h2>
@@ -85,6 +86,10 @@
<td class="summary">Filename to store report.</td>
</tr>
<tr>
+ <td class="name" nowrap><a href="#tick">tick</a></td>
+ <td class="summary">Enable saving coverage data after every <a href="../modules/luacov.defaults.html#savestepsize">savestepsize</a> lines?</td>
+ </tr>
+ <tr>
<td class="name" nowrap><a href="#savestepsize">savestepsize</a></td>
<td class="summary">Stats file updating frequency for <a href="../modules/luacov.tick.html#">luacov.tick</a>.</td>
</tr>
@@ -163,11 +168,10 @@
<h3>Usage:</h3>
<ul>
- <pre class="example">
- modules = {
- [<span class="string">"some_rock"</span>] = <span class="string">"src/some_rock.lua"</span>,
- [<span class="string">"some_rock.*"</span>] = <span class="string">"src"</span>
- }</pre>
+ <pre class="example">modules = {
+ [<span class="string">"some_rock"</span>] = <span class="string">"src/some_rock.lua"</span>,
+ [<span class="string">"some_rock.*"</span>] = <span class="string">"src"</span>
+}</pre>
</ul>
</dd>
@@ -204,6 +208,22 @@
</dd>
<dt>
+ <a name = "tick"></a>
+ <strong>tick</strong>
+ </dt>
+ <dd>
+ Enable saving coverage data after every <a href="../modules/luacov.defaults.html#savestepsize">savestepsize</a> lines?
+ Setting this flag to <code>true</code> in config is equivalent to running LuaCov
+ using <a href="../modules/luacov.tick.html#">luacov.tick</a> module. Default: false.
+
+
+
+
+
+
+
+</dd>
+ <dt>
<a name = "savestepsize"></a>
<strong>savestepsize</strong>
</dt>
@@ -271,8 +291,8 @@
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
-<i style="float:right;">Last updated 2016-04-18 11:50:47 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.4</a></i>
+<i style="float:right;">Last updated 2016-06-29 18:46:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>