Update documentation to version 1.1-6.

doc/index.html

@@ -153,7 +153,7 @@
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#tiny.getSystemIndex">tiny.getSystemIndex (world, system)</a></td>
-	<td class="summary">Gets the index of a System in the World.</td>
+	<td class="summary">Gets the index of the System in the World.</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#tiny.setSystemIndex">tiny.setSystemIndex (world, system, index)</a></td>
@@ -322,12 +322,15 @@ end
     <li>The <code>active</code> flag is whether or not the System is updated automatically.
     Inactive Systems should be updated manually or not at all via
     <code>system:update(dt)</code>. Defaults to true.</li>
-    <li>The 'entities' field is an ordered list of Entities in the System. This
+    <li>The <code>entities</code> field is an ordered list of Entities in the System. This
     list can be used to quickly iterate through all Entities in a System.</li>
     <li>The <code>interval</code> field is an optional field that makes Systems update at
     certain intervals using buffered time, regardless of World update frequency.
     For example, to make a System update once a second, set the System's interval
     to 1.</li>
+    <li>The <code>index</code> field is the System's index in the World. Lower indexed
+    Systems are processed before higher indices. The <code>index</code> is a read only
+    field; to set the <code>index</code>, use <code>tiny.setSystemIndex(world, system)</code>.</li>
     <li>The <code>indices</code> field is a table of Entity keys to their indices in the
     <code>entities</code> list. Most Systems can ignore this.</li>
     <li>The <code>modified</code> flag is an indicator if the System has been modified in
@@ -446,7 +449,8 @@ end
     </dt>
     <dd>
     Creates a new World.
- Can optionally add default Systems and Entities.
+ Can optionally add default Systems and Entities. Returns the new World along
+ with default Entities and Systems.
 
 
 
@@ -462,7 +466,7 @@ end
     <dd>
     Adds an Entity to the world.
  Also call this on Entities that have changed Components such that they
- match different Filters.
+ match different Filters. Returns the Entity.
 
 
 
@@ -476,7 +480,7 @@ end
     <strong>tiny.addSystem (world, system)</strong>
     </dt>
     <dd>
-    Adds a System to the world.
+    Adds a System to the world.  Returns the System.
 
 
 
@@ -490,7 +494,8 @@ end
     <strong>tiny.add (world, ...)</strong>
     </dt>
     <dd>
-    Shortcut for adding multiple Entities and Systems to the World.
+    Shortcut for adding multiple Entities and Systems to the World.  Returns all
+ added Entities and Systems.
 
 
 
@@ -504,7 +509,7 @@ end
     <strong>tiny.removeEntity (world, entity)</strong>
     </dt>
     <dd>
-    Removes an Entity to the World.
+    Removes an Entity to the World.  Returns the Entity.
 
 
 
@@ -518,7 +523,7 @@ end
     <strong>tiny.removeSystem (world, system)</strong>
     </dt>
     <dd>
-    Removes a System from the world.
+    Removes a System from the world.  Returns the System.
 
 
 
@@ -532,7 +537,8 @@ end
     <strong>tiny.remove (world, ...)</strong>
     </dt>
     <dd>
-    Shortcut for removing multiple Entities and Systems from the World.
+    Shortcut for removing multiple Entities and Systems from the World.  Returns
+ all rmeove Systems and Entities
 
 
 
@@ -619,8 +625,8 @@ end
     <strong>tiny.getSystemIndex (world, system)</strong>
     </dt>
     <dd>
-    Gets the index of a System in the World.  Lower indexed Systems are processed
- before higher indexed systems.
+    Gets the index of the System in the World.
+ A simpler alternative is <code>system.index</code>.
 
 
 
@@ -636,7 +642,7 @@ end
     <dd>
     Sets the index of a System in the World, and returns the old index.  Changes
  the order in which they Systems processed, because lower indexed Systems are
- processed first.
+ processed first. Returns the old system.index.
 
 
 
@@ -652,7 +658,7 @@ end
 </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 2015-06-19 19:45:33 </i>
+<i style="float:right;">Last updated 2015-07-07 20:41:42 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>