summaryrefslogtreecommitdiff
path: root/doc/doc/modules/luacov.stats.html
blob: c1f5a747071e83ba47407e9fbd65f025ac1d708f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>LuaCov Reference</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>LuaCov</h1>

<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
</ul>


<h2>Modules</h2>
<ul class="nowrap">
  <li><a href="../modules/luacov.html">luacov</a></li>
  <li><a href="../modules/luacov.defaults.html">luacov.defaults</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><strong>luacov.stats</strong></li>
  <li><a href="../modules/luacov.tick.html">luacov.tick</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>luacov.stats</code></h1>
<p>Manages the file with statistics (being) collected.</p>
<p>

</p>


<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
	<tr>
	<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="#save">save (statsfile, data)</a></td>
	<td class="summary">Saves data to the stats file.</td>
	</tr>
</table>

<br/>
<br/>


    <h2 class="section-header "><a name="Functions"></a>Functions</h2>

    <dl class="function">
    <dt>
    <a name = "load"></a>
    <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 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.
    </ol>




</dd>
    <dt>
    <a name = "save"></a>
    <strong>save (statsfile, data)</strong>
    </dt>
    <dd>
    Saves data to the stats file.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">statsfile</span>
         path to the stats file.
        </li>
        <li><span class="parameter">data</span>
         data to store.
        </li>
    </ul>





</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-04-18 11:50:47 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>