100% documentation

This commit is contained in:
Kevin Jahns
2014-08-09 00:31:30 +02:00
parent baf4660733
commit b340bbe806
73 changed files with 1030 additions and 438 deletions

View File

@@ -90,6 +90,7 @@
</a>
</span>
<span class='desc'>
Encode this operation in such a way that it can be parsed by remote peers.
</span>
</li>
<li>
@@ -128,6 +129,18 @@
Add an operation to the HB.
</span>
</li>
<li>
<span class='signature'>
<a href='#addToCounter-dynamic'>
#
(void)
<b>addToCounter</b><span>(o)</span>
</a>
</span>
<span class='desc'>
Increment the operation_counter that defines the current state of the Engine.
</span>
</li>
</ul>
<h2>Constructor Details</h2>
<div class='methods'>
@@ -209,7 +222,11 @@ This is why everybode must create the same operation with this uid.</p>
<b>_encode</b><span>(state_vector = {})</span>
<br>
</p>
<div class='docstring'>
<p>Encode this operation in such a way that it can be parsed by remote peers.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='getNextOperationIdentifier-dynamic'>
@@ -251,12 +268,25 @@ This will increment the operation counter.</p>
other operations (it wont executed)</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='addToCounter-dynamic'>
#
(void)
<b>addToCounter</b><span>(o)</span>
<br>
</p>
<div class='docstring'>
<p>Increment the operation_counter that defines the current state of the Engine.</p>
</div>
<div class='tags'>
</div>
</div>
</div>
</div>
<div id='footer'>
August 08, 14 04:37:31 by
August 09, 14 00:30:33 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>