diff options
Diffstat (limited to 'doc/doc/modules/luacov.runner.html')
| -rw-r--r-- | doc/doc/modules/luacov.runner.html | 48 |
1 files changed, 35 insertions, 13 deletions
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> |