Skip to content

Commit

Permalink
Regenerated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
avnik committed Aug 8, 2012
1 parent 6af0513 commit e42eaa4
Show file tree
Hide file tree
Showing 8 changed files with 319 additions and 55 deletions.
26 changes: 12 additions & 14 deletions doc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,10 @@ <h2>Modules</h2>
<li><a href="modules/ami.connection.html">ami.connection</a></li>
<li><a href="modules/ami.login.html">ami.login</a></li>
<li><a href="modules/ami.utils.html">ami.utils</a></li>
<li><a href="modules/etc.interactive-test.html">etc.interactive-test</a></li>
</ul>
<h2>Scripts</h2>
<ul>
<li><a href="scripts/interactive-test.lua.html">interactive-test.lua</a></li>
</ul>

</div>
Expand All @@ -51,30 +54,25 @@ <h2>Modules</h2>
<table class="module_list">
<tr>
<td class="name" nowrap><a href="modules/ami.html">ami</a></td>
<td class="summary">ami.lua: Lua module to talk with Asterisk by AMI protocol
This file is a part of Lua-AMI library
Copyright (c) Lua-AMI authors (see file `COPYRIGHT` for the license)</td>
<td class="summary">Lua module to talk with Asterisk by AMI protocol.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ami.connection.html">ami.connection</a></td>
<td class="summary">connection.lua: Low-level connection object
This file is a part of Lua-AMI library
Copyright (c) Lua-AMI authors (see file `COPYRIGHT` for the license)</td>
<td class="summary">Low-level connection object</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ami.login.html">ami.login</a></td>
<td class="summary">login.lua: implementation of AMI protocol authorization sequence
This file is a part of Lua-AMI library
Copyright (c) Lua-AMI authors (see file `COPYRIGHT` for the license)</td>
<td class="summary">implementation of AMI protocol authorization sequence</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ami.utils.html">ami.utils</a></td>
<td class="summary">utils.lua: utility functions
This file is a part of Lua-AMI library
Copyright (c) Lua-AMI authors (see file `COPYRIGHT` for the license)</td>
<td class="summary">utility functions</td>
</tr>
</table>
<h2>Scripts</h2>
<table class="module_list">
<tr>
<td class="name" nowrap><a href="modules/etc.interactive-test.html">etc.interactive-test</a></td>
<td class="name" nowrap><a href="scripts/interactive-test.lua.html">interactive-test.lua</a></td>
<td class="summary">interactive-test.lua: interactive test
This file is a part of Lua-AMI library
Copyright (c) Lua-AMI authors (see file `COPYRIGHT` for the license)</td>
Expand Down
107 changes: 107 additions & 0 deletions doc/modules/Lua.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
<!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>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>lua-AMI</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>
<li><strong>Lua</strong></li>
<li><a href="../modules/ami.connection.html">ami.connection</a></li>
<li><a href="../modules/ami.login.html">ami.login</a></li>
<li><a href="../modules/ami.utils.html">ami.utils</a></li>
</ul>
<h2>Scripts</h2>
<ul>
<li><a href="../scripts/interactive-test.lua.html">interactive-test.lua</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>Lua</code></h1>

<p>ami.lua: Lua module to talk with Asterisk by AMI protocol
This file is a part of Lua-AMI library
Copyright (c) Lua-AMI authors (see file `COPYRIGHT` for the license)</p>
<p></p>

<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#make_ami_manager">make_ami_manager&nbsp;(config)</a></td>
<td class="summary">Make AMI manager object</td>
</tr>
</table>

<br/>
<br/>


<h2><a name="Functions"></a>Functions</h2>

<dl class="function">
<dt>
<a name = "make_ami_manager"></a>
<strong>make_ami_manager&nbsp;(config)</strong>
</dt>
<dd>
Make AMI manager object

<h3>Parameters:</h3>
<ul>
<li><code><em>config</em></code>: -- table with configuration values</li>
</ul>


<h3>Returns:</h3>
<ol>
AMI manager object
</ol>


</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.2</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
33 changes: 5 additions & 28 deletions doc/modules/ami.connection.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ <h1>lua-AMI</h1>

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


Expand All @@ -42,7 +41,10 @@ <h2>Modules</h2>
<li><strong>ami.connection</strong></li>
<li><a href="../modules/ami.login.html">ami.login</a></li>
<li><a href="../modules/ami.utils.html">ami.utils</a></li>
<li><a href="../modules/etc.interactive-test.html">etc.interactive-test</a></li>
</ul>
<h2>Scripts</h2>
<ul>
<li><a href="../scripts/interactive-test.lua.html">interactive-test.lua</a></li>
</ul>

</div>
Expand All @@ -51,39 +53,14 @@ <h2>Modules</h2>

<h1>Module <code>ami.connection</code></h1>

<p>connection.lua: Low-level connection object
This file is a part of Lua-AMI library
Copyright (c) Lua-AMI authors (see file `COPYRIGHT` for the license)</p>
<p>Low-level connection object</p>
<p></p>

<h2><a href="#Fields">Fields</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#ASTERISK_BANNER">ASTERISK_BANNER</a></td>
<td class="summary"></td>
</tr>
</table>

<br/>
<br/>


<h2><a name="Fields"></a>Fields</h2>

<dl class="function">
<dt>
<a name = "ASTERISK_BANNER"></a>
<strong>ASTERISK_BANNER</strong>
</dt>
<dd>
?





</dd>
</dl>


</div> <!-- id="content" -->
Expand Down
9 changes: 5 additions & 4 deletions doc/modules/ami.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,10 @@ <h2>Modules</h2>
<li><a href="../modules/ami.connection.html">ami.connection</a></li>
<li><a href="../modules/ami.login.html">ami.login</a></li>
<li><a href="../modules/ami.utils.html">ami.utils</a></li>
<li><a href="../modules/etc.interactive-test.html">etc.interactive-test</a></li>
</ul>
<h2>Scripts</h2>
<ul>
<li><a href="../scripts/interactive-test.lua.html">interactive-test.lua</a></li>
</ul>

</div>
Expand All @@ -51,9 +54,7 @@ <h2>Modules</h2>

<h1>Module <code>ami</code></h1>

<p>ami.lua: Lua module to talk with Asterisk by AMI protocol
This file is a part of Lua-AMI library
Copyright (c) Lua-AMI authors (see file `COPYRIGHT` for the license)</p>
<p>Lua module to talk with Asterisk by AMI protocol.</p>
<p></p>

<h2><a href="#Functions">Functions</a></h2>
Expand Down
9 changes: 5 additions & 4 deletions doc/modules/ami.login.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,10 @@ <h2>Modules</h2>
<li><a href="../modules/ami.connection.html">ami.connection</a></li>
<li><strong>ami.login</strong></li>
<li><a href="../modules/ami.utils.html">ami.utils</a></li>
<li><a href="../modules/etc.interactive-test.html">etc.interactive-test</a></li>
</ul>
<h2>Scripts</h2>
<ul>
<li><a href="../scripts/interactive-test.lua.html">interactive-test.lua</a></li>
</ul>

</div>
Expand All @@ -50,9 +53,7 @@ <h2>Modules</h2>

<h1>Module <code>ami.login</code></h1>

<p>login.lua: implementation of AMI protocol authorization sequence
This file is a part of Lua-AMI library
Copyright (c) Lua-AMI authors (see file `COPYRIGHT` for the license)</p>
<p>implementation of AMI protocol authorization sequence</p>
<p></p>


Expand Down
107 changes: 107 additions & 0 deletions doc/modules/ami.lua.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
<!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>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>lua-AMI</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>
<li><a href="../modules/ami.connection.html">ami.connection</a></li>
<li><a href="../modules/ami.login.html">ami.login</a></li>
<li><strong>ami.lua</strong></li>
<li><a href="../modules/ami.utils.html">ami.utils</a></li>
</ul>
<h2>Scripts</h2>
<ul>
<li><a href="../scripts/interactive-test.lua.html">interactive-test.lua</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>ami.lua</code></h1>

<p>ami.lua: Lua module to talk with Asterisk by AMI protocol
This file is a part of Lua-AMI library
Copyright (c) Lua-AMI authors (see file `COPYRIGHT` for the license)</p>
<p></p>

<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#make_ami_manager">make_ami_manager&nbsp;(config)</a></td>
<td class="summary">Make AMI manager object</td>
</tr>
</table>

<br/>
<br/>


<h2><a name="Functions"></a>Functions</h2>

<dl class="function">
<dt>
<a name = "make_ami_manager"></a>
<strong>make_ami_manager&nbsp;(config)</strong>
</dt>
<dd>
Make AMI manager object

<h3>Parameters:</h3>
<ul>
<li><code><em>config</em></code>: -- table with configuration values</li>
</ul>


<h3>Returns:</h3>
<ol>
AMI manager object
</ol>


</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.2</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
11 changes: 6 additions & 5 deletions doc/modules/ami.utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,10 @@ <h2>Modules</h2>
<li><a href="../modules/ami.connection.html">ami.connection</a></li>
<li><a href="../modules/ami.login.html">ami.login</a></li>
<li><strong>ami.utils</strong></li>
<li><a href="../modules/etc.interactive-test.html">etc.interactive-test</a></li>
</ul>
<h2>Scripts</h2>
<ul>
<li><a href="../scripts/interactive-test.lua.html">interactive-test.lua</a></li>
</ul>

</div>
Expand All @@ -50,10 +53,8 @@ <h2>Modules</h2>

<h1>Module <code>ami.utils</code></h1>

<p>utils.lua: utility functions
This file is a part of Lua-AMI library
Copyright (c) Lua-AMI authors (see file `COPYRIGHT` for the license)</p>
<p> This module is part of implementation, not API</p>
<p>utility functions</p>
<p></p>


<br/>
Expand Down
Loading

0 comments on commit e42eaa4

Please sign in to comment.