diff options
Diffstat (limited to 'doc/doc/modules/luacov.reporter.html')
| -rw-r--r-- | doc/doc/modules/luacov.reporter.html | 53 |
1 files changed, 42 insertions, 11 deletions
diff --git a/doc/doc/modules/luacov.reporter.html b/doc/doc/modules/luacov.reporter.html index d1884b5..a2bd1cb 100644 --- a/doc/doc/modules/luacov.reporter.html +++ b/doc/doc/modules/luacov.reporter.html @@ -33,7 +33,7 @@ <h2>Contents</h2> <ul> <li><a href="#Functions">Functions</a></li> -<li><a href="#Class_ReporterBase">Class ReporterBase </a></li> +<li><a href="#Class_ReporterBase">Class ReporterBase</a></li> </ul> @@ -41,10 +41,12 @@ <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.hook.html">luacov.hook</a></li> <li><strong>luacov.reporter</strong></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> @@ -65,7 +67,7 @@ <td class="summary">Runs the report generator.</td> </tr> </table> -<h2><a href="#Class_ReporterBase">Class ReporterBase </a></h2> +<h2><a href="#Class_ReporterBase">Class ReporterBase</a></h2> <table class="function_list"> <tr> <td class="name" nowrap><a href="#ReporterBase:config">ReporterBase:config ()</a></td> @@ -96,6 +98,10 @@ <td class="summary">Stub method called before processing a file.</td> </tr> <tr> + <td class="name" nowrap><a href="#ReporterBase:on_file_error">ReporterBase:on_file_error (filename, error_type, message)</a></td> + <td class="summary">Stub method called if a file couldn't be processed due to an error.</td> + </tr> + <tr> <td class="name" nowrap><a href="#ReporterBase:on_empty_line">ReporterBase:on_empty_line (filename, lineno, line)</a></td> <td class="summary">Stub method called for each empty source line and other lines that can't be hit.</td> @@ -155,7 +161,7 @@ </dd> </dl> - <h2 class="section-header has-description"><a name="Class_ReporterBase"></a>Class ReporterBase </h2> + <h2 class="section-header has-description"><a name="Class_ReporterBase"></a>Class ReporterBase</h2> <div class="section-description"> Basic reporter class stub. @@ -163,12 +169,11 @@ Provides some helper methods and stubs to be overridden by child classes. </div> <h3>Usage:</h3> - <pre class="example"> - <span class="keyword">local</span> MyReporter = <span class="global">setmetatable</span>({}, ReporterBase) - MyReporter.__index = MyReporter - <span class="keyword">function</span> MyReporter:on_hit_line(...) - self:write((<span class="string">"File %s: hit line %s %d times"</span>):format(...)) - <span class="keyword">end</span></pre> + <pre class="example"><span class="keyword">local</span> MyReporter = <span class="global">setmetatable</span>({}, ReporterBase) +MyReporter.__index = MyReporter +<span class="keyword">function</span> MyReporter:on_hit_line(...) + self:write((<span class="string">"File %s: hit line %s %d times"</span>):format(...)) +<span class="keyword">end</span></pre> <dl class="function"> <dt> <a name = "ReporterBase:config"></a> @@ -295,6 +300,32 @@ </dd> <dt> + <a name = "ReporterBase:on_file_error"></a> + <strong>ReporterBase:on_file_error (filename, error_type, message)</strong> + </dt> + <dd> + Stub method called if a file couldn't be processed due to an error. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">filename</span> + name of the file. + </li> + <li><span class="parameter">error_type</span> + "open", "read" or "load". + </li> + <li><span class="parameter">message</span> + error message. + </li> + </ul> + + + + + +</dd> + <dt> <a name = "ReporterBase:on_empty_line"></a> <strong>ReporterBase:on_empty_line (filename, lineno, line)</strong> </dt> @@ -422,8 +453,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> |