diff options
Diffstat (limited to 'docs/api/modules/pl.test.html')
| -rw-r--r-- | docs/api/modules/pl.test.html | 46 |
1 files changed, 30 insertions, 16 deletions
diff --git a/docs/api/modules/pl.test.html b/docs/api/modules/pl.test.html index a57be5a..2c5bffc 100644 --- a/docs/api/modules/pl.test.html +++ b/docs/api/modules/pl.test.html @@ -2,7 +2,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html> <head> - <title>Reference</title> + <title>pl.test: Module Index</title> <link rel="stylesheet" href="../luadoc.css" type="text/css" /> <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/--> </head> @@ -21,7 +21,7 @@ <div id="navigation"> -<h1>LuaDoc</h1> +<h2>LuaDoc</h2> <ul> <li><a href="../index.html">Index</a></li> @@ -31,7 +31,7 @@ <!-- Module list --> -<h1>Modules</h1> +<h2>Modules</h2> <ul> <li> @@ -75,6 +75,10 @@ </li> <li> + <a href="../modules/pl.lapp.html">pl.lapp</a> + </li> + + <li> <a href="../modules/pl.lexer.html">pl.lexer</a> </li> @@ -143,7 +147,7 @@ <div id="content"> -<h1>Module <code>pl.test</code></h1> +<h1>Module "pl.test"</h1> <p>Useful test utilities.</p> @@ -155,17 +159,17 @@ <table class="function_list"> <tr> - <td class="name" nowrap><a href="#asserteq">asserteq</a> (x, y)</td> + <td class="name" nowrap><a href="#test.asserteq">test.asserteq</a> (x, y)</td> <td class="summary">like assert, except takes two arguments that must be equal and can be tables.</td> </tr> <tr> - <td class="name" nowrap><a href="#asserteq2">asserteq2</a> (x1, x2, y1, y2)</td> + <td class="name" nowrap><a href="#test.asserteq2">test.asserteq2</a> (x1, x2, y1, y2)</td> <td class="summary">a version of asserteq that takes two pairs of values.</td> </tr> <tr> - <td class="name" nowrap><a href="#timer">timer</a> (msg, n, fun, ...)</td> + <td class="name" nowrap><a href="#test.timer">test.timer</a> (msg, n, fun, ...)</td> <td class="summary">Time a function.</td> </tr> @@ -186,12 +190,13 @@ -<dt><a name="asserteq"></a><strong>asserteq</strong> (x, y)</dt> +<dt><a name="test.asserteq"></a><strong>test.asserteq</strong> (x, y)</dt> <dd> -like assert, except takes two arguments that must be equal and can be tables. If they are plain tables, it will use tablex.deepcompare. +like assert, except takes two arguments that must be equal and can be tables. +If they are plain tables, it will use tablex.deepcompare. -<h3>Parameters</h3> +<h3>Parameters:</h3> <ul> <li> @@ -211,17 +216,21 @@ like assert, except takes two arguments that must be equal and can be tables. If + + </dd> -<dt><a name="asserteq2"></a><strong>asserteq2</strong> (x1, x2, y1, y2)</dt> +<dt><a name="test.asserteq2"></a><strong>test.asserteq2</strong> (x1, x2, y1, y2)</dt> <dd> -a version of asserteq that takes two pairs of values. <code>x1==y1 and x2==y2</code> must be true. Useful for functions that naturally return two values. +a version of asserteq that takes two pairs of values. +<code>x1==y1 and x2==y2</code> must be true. Useful for functions that naturally +return two values. -<h3>Parameters</h3> +<h3>Parameters:</h3> <ul> <li> @@ -249,17 +258,20 @@ a version of asserteq that takes two pairs of values. <code>x1==y1 and x2==y2</c + + </dd> -<dt><a name="timer"></a><strong>timer</strong> (msg, n, fun, ...)</dt> +<dt><a name="test.timer"></a><strong>test.timer</strong> (msg, n, fun, ...)</dt> <dd> -Time a function. Call the function a given number of times, and report the number of seconds taken, together with a message. Any extra arguments will be passed to the function. +Time a function. Call the function a given number of times, and report the number of seconds taken, +together with a message. Any extra arguments will be passed to the function. -<h3>Parameters</h3> +<h3>Parameters:</h3> <ul> <li> @@ -287,6 +299,8 @@ Time a function. Call the function a given number of times, and report the numbe + + </dd> |