diff options
Diffstat (limited to 'doc/doc/modules/luacov.stats.html')
| -rw-r--r-- | doc/doc/modules/luacov.stats.html | 83 |
1 files changed, 22 insertions, 61 deletions
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> |