Update Documentation

Author: 06needhamt

Docs/index-outline.html

@@ -73,6 +73,11 @@
 <a href="Docs\index"><a href="linq.collections\-skip.html"><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">&gt;</span> <span class="identifier">Skip</span><span class="symbol">(</span><span class="identifier">list</span><span class="symbol">:</span>&nbsp;<span class="identifier">AbstractList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier">amount</span><span class="symbol">:</span>&nbsp;<span class="identifier">Int</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">ArrayList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span></a></a><br/>
 <a href="Docs\index"><a href="linq.collections\-skip-while.html"><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">&gt;</span> <span class="identifier">SkipWhile</span><span class="symbol">(</span><span class="identifier">list</span><span class="symbol">:</span>&nbsp;<span class="identifier">AbstractList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier">condition</span><span class="symbol">:</span>&nbsp;<span class="symbol">(</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<span class="identifier">Boolean</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">ArrayList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span></a></a><br/>
 <a href="Docs\index"><a href="linq.collections\-skip-while.html"><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">&gt;</span> <span class="identifier">SkipWhile</span><span class="symbol">(</span><span class="identifier">list</span><span class="symbol">:</span>&nbsp;<span class="identifier">AbstractList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier">condition</span><span class="symbol">:</span>&nbsp;<span class="symbol">(</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">,</span>&nbsp;<span class="identifier">Int</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<span class="identifier">Boolean</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">ArrayList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span></a></a><br/>
+<a href="Docs\index"><a href="linq.collections\-sum.html"><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">ElementType</span>&nbsp;<span class="symbol">:</span>&nbsp;<span class="identifier">Number</span><span class="symbol">&gt;</span> <span class="identifier">Sum</span><span class="symbol">(</span><span class="identifier">list</span><span class="symbol">:</span>&nbsp;<span class="identifier">AbstractList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">ElementType</span><span class="symbol">?</span></a></a><br/>
+<a href="Docs\index"><a href="linq.collections\-sum.html"><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">&gt;</span> <span class="identifier">Sum</span><span class="symbol">(</span><span class="identifier">list</span><span class="symbol">:</span>&nbsp;<span class="identifier">AbstractList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier">comparitor</span><span class="symbol">:</span>&nbsp;<span class="symbol">(</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">ElementType</span><span class="symbol">?</span></a></a><br/>
+<a href="Docs\index"><a href="linq.collections\-take.html"><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">&gt;</span> <span class="identifier">Take</span><span class="symbol">(</span><span class="identifier">list</span><span class="symbol">:</span>&nbsp;<span class="identifier">AbstractList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier">amount</span><span class="symbol">:</span>&nbsp;<span class="identifier">Int</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">ArrayList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span></a></a><br/>
+<a href="Docs\index"><a href="linq.collections\-take-while.html"><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">&gt;</span> <span class="identifier">TakeWhile</span><span class="symbol">(</span><span class="identifier">list</span><span class="symbol">:</span>&nbsp;<span class="identifier">AbstractList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier">condition</span><span class="symbol">:</span>&nbsp;<span class="symbol">(</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<span class="identifier">Boolean</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">ArrayList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span></a></a><br/>
+<a href="Docs\index"><a href="linq.collections\-to-array.html"><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">&gt;</span> <span class="identifier">ToArray</span><span class="symbol">(</span><span class="identifier">list</span><span class="symbol">:</span>&nbsp;<span class="identifier">AbstractList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Array</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span></a></a><br/>
 </BODY>
 </HTML>
 </ul>

Docs/linq.collections/-last.html

@@ -17,6 +17,14 @@ <h3>Parameters</h3>
 <br/>
 <br/>
 <code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">&gt;</span> <span class="identifier">Last</span><span class="symbol">(</span><span class="identifier">list</span><span class="symbol">:</span>&nbsp;<span class="identifier">AbstractList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier">condition</span><span class="symbol">:</span>&nbsp;<span class="symbol">(</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<span class="identifier">Boolean</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">ElementType</span><span class="symbol">?</span></code><br/>
+<p>Returns the last item contained in <a href="-last.html#list">list</a> that meets the <a href="-last.html#condition">condition</a></p>
+<h3>Parameters</h3>
+<a name="list"></a>
+<code>list</code> - The Collection<br/>
+<a name="condition"></a>
+<code>condition</code> - the condition to check the items against<br/>
+<strong>Return</strong><br/>
+the last item contained in <a href="-last.html#list">list</a> that meets the <a href="-last.html#condition">condition</a><br/>
 <br/>
 <br/>
 </BODY>

Docs/linq.collections/-sum.html

@@ -0,0 +1,31 @@
+<HTML>
+<HEAD>
+<title> / linq.collections.Sum</title>
+<link rel="stylesheet" href="..\style.css">
+</HEAD>
+<BODY>
+<a href="index.html">linq.collections</a>&nbsp;/&nbsp;<a href=".">Sum</a><br/>
+<br/>
+<h1>Sum</h1>
+<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">ElementType</span>&nbsp;<span class="symbol">:</span>&nbsp;<span class="identifier">Number</span><span class="symbol">&gt;</span> <span class="identifier">Sum</span><span class="symbol">(</span><span class="identifier">list</span><span class="symbol">:</span>&nbsp;<span class="identifier">AbstractList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">ElementType</span><span class="symbol">?</span></code><br/>
+<p>Returns the sum of all items within the <a href="-sum.html#list">list</a></p>
+<h3>Parameters</h3>
+<a name="list"></a>
+<code>list</code> - the list to sum<br/>
+<strong>Return</strong><br/>
+the sum of all the items within the <a href="-sum.html#list">list</a><br/>
+<br/>
+<br/>
+<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">&gt;</span> <span class="identifier">Sum</span><span class="symbol">(</span><span class="identifier">list</span><span class="symbol">:</span>&nbsp;<span class="identifier">AbstractList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier">comparitor</span><span class="symbol">:</span>&nbsp;<span class="symbol">(</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">ElementType</span><span class="symbol">?</span></code><br/>
+<p>Returns the sum of all items within the <a href="-sum.html#list">list</a> after applying transform function <a href="-sum.html#comparitor">comparitor</a></p>
+<h3>Parameters</h3>
+<a name="list"></a>
+<code>list</code> - the list to sum<br/>
+<a name="comparitor"></a>
+<code>comparitor</code> - a transform function to apply to each element<br/>
+<strong>Return</strong><br/>
+the sum of all the items within the <a href="-sum.html#list">list</a> after applying transform function <a href="-sum.html#comparitor">comparitor</a><br/>
+<br/>
+<br/>
+</BODY>
+</HTML>

Docs/linq.collections/-take-while.html

@@ -0,0 +1,22 @@
+<HTML>
+<HEAD>
+<title> / linq.collections.TakeWhile</title>
+<link rel="stylesheet" href="..\style.css">
+</HEAD>
+<BODY>
+<a href="index.html">linq.collections</a>&nbsp;/&nbsp;<a href=".">TakeWhile</a><br/>
+<br/>
+<h1>TakeWhile</h1>
+<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">&gt;</span> <span class="identifier">TakeWhile</span><span class="symbol">(</span><span class="identifier">list</span><span class="symbol">:</span>&nbsp;<span class="identifier">AbstractList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier">condition</span><span class="symbol">:</span>&nbsp;<span class="symbol">(</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<span class="identifier">Boolean</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">ArrayList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span></code><br/>
+<p>Returns items from the <a href="-take-while.html#list">list</a> while the <a href="-take-while.html#condition">condition</a> is true</p>
+<h3>Parameters</h3>
+<a name="list"></a>
+<code>list</code> - the list to return items from<br/>
+<a name="condition"></a>
+<code>condition</code> - the condition on which to return items<br/>
+<strong>Return</strong><br/>
+the items which meet <a href="-take-while.html#condition">condition</a><br/>
+<br/>
+<br/>
+</BODY>
+</HTML>

Docs/linq.collections/-take.html

@@ -0,0 +1,25 @@
+<HTML>
+<HEAD>
+<title> / linq.collections.Take</title>
+<link rel="stylesheet" href="..\style.css">
+</HEAD>
+<BODY>
+<a href="index.html">linq.collections</a>&nbsp;/&nbsp;<a href=".">Take</a><br/>
+<br/>
+<h1>Take</h1>
+<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">&gt;</span> <span class="identifier">Take</span><span class="symbol">(</span><span class="identifier">list</span><span class="symbol">:</span>&nbsp;<span class="identifier">AbstractList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier">amount</span><span class="symbol">:</span>&nbsp;<span class="identifier">Int</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">ArrayList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span></code><br/>
+<p>Returns <a href="-take.html#amount">amount</a> items from the <a href="-take.html#list">list</a></p>
+<h3>Parameters</h3>
+<a name="list"></a>
+<code>list</code> - the list to return items from<br/>
+<a name="amount"></a>
+<code>amount</code> - the amount of items to return<br/>
+<h3>Exceptions</h3>
+<a name="Exception"></a>
+<code>Exception</code> - when there are less than <a href="-take.html#amount">amount</a> items in the <a href="-take.html#list">list</a><br/>
+<strong>Return</strong><br/>
+the first <a href="-take.html#amount">amount</a> items in the <a href="-take.html#list">list</a><br/>
+<br/>
+<br/>
+</BODY>
+</HTML>

Docs/linq.collections/-to-array.html

@@ -0,0 +1,20 @@
+<HTML>
+<HEAD>
+<title> / linq.collections.ToArray</title>
+<link rel="stylesheet" href="..\style.css">
+</HEAD>
+<BODY>
+<a href="index.html">linq.collections</a>&nbsp;/&nbsp;<a href=".">ToArray</a><br/>
+<br/>
+<h1>ToArray</h1>
+<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">&gt;</span> <span class="identifier">ToArray</span><span class="symbol">(</span><span class="identifier">list</span><span class="symbol">:</span>&nbsp;<span class="identifier">AbstractList</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Array</span><span class="symbol">&lt;</span><span class="identifier">ElementType</span><span class="symbol">?</span><span class="symbol">&gt;</span></code><br/>
+<p>Converts a list of items to an array of items</p>
+<h3>Parameters</h3>
+<a name="list"></a>
+<code>list</code> - the list of items<br/>
+<strong>Return</strong><br/>
+an array containing all the items contained in the list<br/>
+<br/>
+<br/>
+</BODY>
+</HTML>