diff options
Diffstat (limited to 'doc/doc/modules/luacov.util.html')
| -rw-r--r-- | doc/doc/modules/luacov.util.html | 213 |
1 files changed, 213 insertions, 0 deletions
diff --git a/doc/doc/modules/luacov.util.html b/doc/doc/modules/luacov.util.html new file mode 100644 index 0000000..b269ba3 --- /dev/null +++ b/doc/doc/modules/luacov.util.html @@ -0,0 +1,213 @@ +<!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.hook.html">luacov.hook</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><a href="../modules/luacov.stats.html">luacov.stats</a></li> + <li><a href="../modules/luacov.tick.html">luacov.tick</a></li> + <li><strong>luacov.util</strong></li> +</ul> + +</div> + +<div id="content"> + +<h1>Module <code>luacov.util</code></h1> +<p>Utility module.</p> +<p> + +</p> + + +<h2><a href="#Functions">Functions</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#unprefix">unprefix (str, prefix)</a></td> + <td class="summary">Removes a prefix from a string if it's present.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#load_string">load_string (str[, env[, chunkname]])</a></td> + <td class="summary">Loads a string.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#load_config">load_config (name, env)</a></td> + <td class="summary">Load a config file.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#file_exists">file_exists (name)</a></td> + <td class="summary">Checks if a file exists.</td> + </tr> +</table> + +<br/> +<br/> + + + <h2 class="section-header "><a name="Functions"></a>Functions</h2> + + <dl class="function"> + <dt> + <a name = "unprefix"></a> + <strong>unprefix (str, prefix)</strong> + </dt> + <dd> + Removes a prefix from a string if it's present. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">str</span> + a string. + </li> + <li><span class="parameter">prefix</span> + a prefix string. + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + original string if does not start with prefix + or string without prefix. + </ol> + + + + +</dd> + <dt> + <a name = "load_string"></a> + <strong>load_string (str[, env[, chunkname]])</strong> + </dt> + <dd> + Loads a string. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">str</span> + a string. + </li> + <li><span class="parameter">env</span> + environment table. + (<em>optional</em>) + </li> + <li><span class="parameter">chunkname</span> + chunk name. + (<em>optional</em>) + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "load_config"></a> + <strong>load_config (name, env)</strong> + </dt> + <dd> + Load a config file. + Reads, loads and runs a Lua file in an environment. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">name</span> + file name. + </li> + <li><span class="parameter">env</span> + environment table. + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + true and the first return value of config on success, + nil + error type + error message on failure, where error type + can be "read", "load" or "run". + </ol> + + + + +</dd> + <dt> + <a name = "file_exists"></a> + <strong>file_exists (name)</strong> + </dt> + <dd> + Checks if a file exists. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">name</span> + file name. + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + true if file can be opened, false otherwise. + </ol> + + + + +</dd> +</dl> + + +</div> <!-- id="content" --> +</div> <!-- id="main" --> +<div id="about"> +<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> +</html> |