summaryrefslogtreecommitdiff
path: root/doc/doc/modules
diff options
context:
space:
mode:
Diffstat (limited to 'doc/doc/modules')
-rw-r--r--doc/doc/modules/luacov.defaults.html2
-rw-r--r--doc/doc/modules/luacov.html2
-rw-r--r--doc/doc/modules/luacov.reporter.html2
-rw-r--r--doc/doc/modules/luacov.runner.html48
-rw-r--r--doc/doc/modules/luacov.stats.html83
-rw-r--r--doc/doc/modules/luacov.tick.html2
6 files changed, 61 insertions, 78 deletions
diff --git a/doc/doc/modules/luacov.defaults.html b/doc/doc/modules/luacov.defaults.html
index 23f3fed..52bdc0e 100644
--- a/doc/doc/modules/luacov.defaults.html
+++ b/doc/doc/modules/luacov.defaults.html
@@ -272,7 +272,7 @@
</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-02-09 14:12:55 </i>
+<i style="float:right;">Last updated 2016-04-18 11:50:47 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
diff --git a/doc/doc/modules/luacov.html b/doc/doc/modules/luacov.html
index c932cac..d599026 100644
--- a/doc/doc/modules/luacov.html
+++ b/doc/doc/modules/luacov.html
@@ -66,7 +66,7 @@
</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-02-09 14:12:55 </i>
+<i style="float:right;">Last updated 2016-04-18 11:50:47 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
diff --git a/doc/doc/modules/luacov.reporter.html b/doc/doc/modules/luacov.reporter.html
index 0ee7d26..d1884b5 100644
--- a/doc/doc/modules/luacov.reporter.html
+++ b/doc/doc/modules/luacov.reporter.html
@@ -423,7 +423,7 @@
</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-02-09 14:12:55 </i>
+<i style="float:right;">Last updated 2016-04-18 11:50:47 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
diff --git a/doc/doc/modules/luacov.runner.html b/doc/doc/modules/luacov.runner.html
index d9f45f6..74ee7f9 100644
--- a/doc/doc/modules/luacov.runner.html
+++ b/doc/doc/modules/luacov.runner.html
@@ -33,6 +33,7 @@
<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
+<li><a href="#Fields">Fields</a></li>
</ul>
@@ -85,11 +86,11 @@
</tr>
<tr>
<td class="name" nowrap><a href="#pause">pause ()</a></td>
- <td class="summary">Pauses LuaCov's runner.</td>
+ <td class="summary">Pauses saving data collected by LuaCov's runner.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#resume">resume ()</a></td>
- <td class="summary">Resumes LuaCov's runner.</td>
+ <td class="summary">Resumes saving data collected by LuaCov's runner.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#with_luacov">with_luacov (f)</a></td>
@@ -120,6 +121,13 @@
<td class="summary">Adds a tree to the include list (see <a href="../modules/luacov.defaults.html#">luacov.defaults</a>).</td>
</tr>
</table>
+<h2><a href="#Fields">Fields</a></h2>
+<table class="function_list">
+ <tr>
+ <td class="name" nowrap><a href="#version">version</a></td>
+ <td class="summary">LuaCov version in <code>MAJOR.MINOR.PATCH</code> format.</td>
+ </tr>
+</table>
<br/>
<br/>
@@ -140,7 +148,7 @@
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">filename</span>
- Normalize file names before using patterns.
+ name of the file.
</li>
</ul>
@@ -253,9 +261,7 @@
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">filename</span>
-
-
-
+ name of the file.
</li>
</ul>
@@ -298,9 +304,9 @@
<strong>pause ()</strong>
</dt>
<dd>
- Pauses LuaCov's runner.
- Saves collected data and stops, allowing other processes to write to
- the same stats file. Data is still collected during pause.
+ Pauses saving data collected by LuaCov's runner.
+ Allows other processes to write to the same stats file.
+ Data is still collected during pause.
@@ -314,9 +320,7 @@
<strong>resume ()</strong>
</dt>
<dd>
- Resumes LuaCov's runner.
- Reloads stats file, possibly updated from other processes,
- and continues saving collected data.
+ Resumes saving data collected by LuaCov's runner.
@@ -523,13 +527,31 @@
</dd>
</dl>
+ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
+
+ <dl class="function">
+ <dt>
+ <a name = "version"></a>
+ <strong>version</strong>
+ </dt>
+ <dd>
+ LuaCov version in <code>MAJOR.MINOR.PATCH</code> format.
+
+
+
+
+
+
+
+</dd>
+</dl>
</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-02-09 14:12:55 </i>
+<i style="float:right;">Last updated 2016-04-18 11:50:47 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
diff --git a/doc/doc/modules/luacov.stats.html b/doc/doc/modules/luacov.stats.html
index dbe40ba..c1f5a74 100644
--- a/doc/doc/modules/luacov.stats.html
+++ b/doc/doc/modules/luacov.stats.html
@@ -52,27 +52,20 @@
<h1>Module <code>luacov.stats</code></h1>
<p>Manages the file with statistics (being) collected.</p>
-<p> In general the module requires that its property <code>stats.statsfile</code>
- has been set to the filename of the statsfile to create, load, etc.</p>
+<p>
+
+</p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
- <td class="name" nowrap><a href="#load">load ()</a></td>
+ <td class="name" nowrap><a href="#load">load (statsfile)</a></td>
<td class="summary">Loads the stats file.</td>
</tr>
<tr>
- <td class="name" nowrap><a href="#start">start ()</a></td>
- <td class="summary">Opens the statfile</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#stop">stop (fd)</a></td>
- <td class="summary">Closes the statfile</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#save">save (data, fd)</a></td>
- <td class="summary">Saves data to the statfile</td>
+ <td class="name" nowrap><a href="#save">save (statsfile, data)</a></td>
+ <td class="summary">Saves data to the stats file.</td>
</tr>
</table>
@@ -85,17 +78,24 @@
<dl class="function">
<dt>
<a name = "load"></a>
- <strong>load ()</strong>
+ <strong>load (statsfile)</strong>
</dt>
<dd>
Loads the stats file.
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">statsfile</span>
+ path to the stats file.
+ </li>
+ </ul>
<h3>Returns:</h3>
<ol>
- table with data. The table maps filenames to stats tables.
+ table with data or nil if couldn't load.
+ The table maps filenames to stats tables.
Per-file tables map line numbers to hits or nils when there are no hits.
Additionally, .max field contains maximum line number
and .max_hits contains maximum number of hits in the file.
@@ -106,59 +106,20 @@
</dd>
<dt>
- <a name = "start"></a>
- <strong>start ()</strong>
- </dt>
- <dd>
- Opens the statfile
-
-
-
- <h3>Returns:</h3>
- <ol>
-
- filehandle
- </ol>
-
-
-
-
-</dd>
- <dt>
- <a name = "stop"></a>
- <strong>stop (fd)</strong>
- </dt>
- <dd>
- Closes the statfile
-
-
- <h3>Parameters:</h3>
- <ul>
- <li><span class="parameter">fd</span>
- filehandle to the statsfile
- </li>
- </ul>
-
-
-
-
-
-</dd>
- <dt>
<a name = "save"></a>
- <strong>save (data, fd)</strong>
+ <strong>save (statsfile, data)</strong>
</dt>
<dd>
- Saves data to the statfile
+ Saves data to the stats file.
<h3>Parameters:</h3>
<ul>
- <li><span class="parameter">data</span>
- data to store
+ <li><span class="parameter">statsfile</span>
+ path to the stats file.
</li>
- <li><span class="parameter">fd</span>
- filehandle where to store
+ <li><span class="parameter">data</span>
+ data to store.
</li>
</ul>
@@ -174,7 +135,7 @@
</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-02-09 14:12:55 </i>
+<i style="float:right;">Last updated 2016-04-18 11:50:47 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
diff --git a/doc/doc/modules/luacov.tick.html b/doc/doc/modules/luacov.tick.html
index 5232d9e..45241ab 100644
--- a/doc/doc/modules/luacov.tick.html
+++ b/doc/doc/modules/luacov.tick.html
@@ -68,7 +68,7 @@
</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-02-09 14:12:55 </i>
+<i style="float:right;">Last updated 2016-04-18 11:50:47 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
View Lorry Controller Status