yonote/yjs
14
0
Fork 0
Code Pull Requests 1 Releases Activity

100% documentation

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

19
doc/class/AddName.html
View File

@@ -59,6 +59,7 @@ only one will AddName operation will be executed.</p>
</a>
</span>
<span class='desc'>
If map_manager doesn&#39;t have the property name, then add it.
</span>
</li>
<li>
@@ -70,6 +71,7 @@ only one will AddName operation will be executed.</p>
</a>
</span>
<span class='desc'>
Encode this operation in such a way that it can be parsed by remote peers.
</span>
</li>
</ul>
@@ -128,7 +130,14 @@ only one will AddName operation will be executed.</p>
<b>execute</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>If map_manager doesn&#39;t have the property name, then add it.
The ReplaceManager that is being written on the property is unique
in such a way that if AddName is executed (from another peer) it will
always have the same result (ReplaceManager, and its beginning and end are the same)</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='_encode-dynamic'>
@@ -137,12 +146,16 @@ only one will AddName operation will be executed.</p>
<b>_encode</b><span>()</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>
</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>

2
doc/class/Delete.html
View File

@@ -157,7 +157,7 @@ This result can be sent to other clients.</p>
</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>

2
doc/class/Delimiter.html
View File

@@ -191,7 +191,7 @@ of the Engine is empty.</p>
</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>

39
doc/class/Engine.html
View File

@@ -74,6 +74,7 @@
</a>
</span>
<span class='desc'>
Same as applyOps but operations that are already in the HB are not applied.
</span>
</li>
<li>
@@ -122,7 +123,29 @@
<b>constructor</b><span>(HB, parser)</span>
<br>
</p>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>HB</span>
<span class='type'>
(
<tt><a href='../class/HistoryBuffer.html'>HistoryBuffer</a></tt>
)
</span>
</li>
<li>
<span class='name'>parser</span>
<span class='type'>
(
<tt>Array</tt>
)
</span>
&mdash;
<span class='desc'>Defines how to parse encoded messages. </span>
</li>
</ul>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
@@ -164,7 +187,17 @@
<b>applyOpsCheckDouble</b><span>(ops_json)</span>
<br>
</p>
<div class='docstring'>
<p>Same as applyOps but operations that are already in the HB are not applied.</p>
</div>
<div class='tags'>
<h3>See also:</h3>
<ul class='see'>
<li>
<a href='Engine.applyOps'>Engine.applyOps</a>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='applyOps-dynamic'>
@@ -215,7 +248,7 @@ It checks if operations that were previously not executable are now executable.<
</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>

34
doc/class/HistoryBuffer.html
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>

9
doc/class/ImmutableObject.html
View File

@@ -67,6 +67,7 @@
</a>
</span>
<span class='desc'>
Encode this operation in such a way that it can be parsed by remote peers.
</span>
</li>
</ul>
@@ -151,12 +152,16 @@
<b>_encode</b><span>()</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>
</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>

2
doc/class/Insert.html
View File

@@ -255,7 +255,7 @@ TODO (Unused)</p>
</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>

136
doc/class/IwcConnector.html
View File

@@ -59,6 +59,7 @@
</a>
</span>
<span class='desc'>
This function is called whenever an operation was executed.
</span>
</li>
<li>
@@ -70,6 +71,7 @@
</a>
</span>
<span class='desc'>
This function is called whenever an operation was received from another peer.
</span>
</li>
<li>
@@ -81,17 +83,7 @@
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#sync-dynamic'>
#
(void)
<b>sync</b><span>()</span>
</a>
</span>
<span class='desc'>
Helper for sending iwc intents.
</span>
</li>
</ul>
@@ -104,7 +96,49 @@
<b>constructor</b><span>(engine, HB, execution_listener, yatta)</span>
<br>
</p>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>engine</span>
<span class='type'>
(
<tt><a href='../class/Engine.html'>Engine</a></tt>
)
</span>
&mdash;
<span class='desc'>The transformation engine </span>
</li>
<li>
<span class='name'>HB</span>
<span class='type'>
(
<tt><a href='../class/HistoryBuffer.html'>HistoryBuffer</a></tt>
)
</span>
</li>
<li>
<span class='name'>execution_listener</span>
<span class='type'>
(
<tt>Array&lt;Function&gt;</tt>
)
</span>
&mdash;
<span class='desc'>You must ensure that whenever an operation is executed, every function in this Array is called. </span>
</li>
<li>
<span class='name'>yatta</span>
<span class='type'>
(
<tt>Yatta</tt>
)
</span>
&mdash;
<span class='desc'>The Yatta framework. </span>
</li>
</ul>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
@@ -116,7 +150,24 @@
<b>send</b><span>(o)</span>
<br>
</p>
<div class='docstring'>
<p>This function is called whenever an operation was executed.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>o</span>
<span class='type'>
(
<tt><a href='../class/Operation.html'>Operation</a></tt>
)
</span>
&mdash;
<span class='desc'>The operation that was executed. </span>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='receive-dynamic'>
@@ -125,7 +176,24 @@
<b>receive</b><span>(o)</span>
<br>
</p>
<div class='docstring'>
<p>This function is called whenever an operation was received from another peer.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>o</span>
<span class='type'>
(
<tt><a href='../class/Operation.html'>Operation</a></tt>
)
</span>
&mdash;
<span class='desc'>The operation that was received. </span>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='sendIwcIntent-dynamic'>
@@ -134,21 +202,39 @@
<b>sendIwcIntent</b><span>(action_name, content)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='sync-dynamic'>
#
(void)
<b>sync</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Helper for sending iwc intents.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>action_name</span>
<span class='type'>
(
<tt>String</tt>
)
</span>
&mdash;
<span class='desc'>The name of the action that is going to be send. </span>
</li>
<li>
<span class='name'>content</span>
<span class='type'>
(
<tt>String</tt>
)
</span>
&mdash;
<span class='desc'>The content that is atteched to the intent. </span>
</li>
</ul>
</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>

28
doc/class/JsonType.html
View File

@@ -53,7 +53,11 @@
</dt>
<dd>
<pre><code class='coffeescript'>true</code></pre>
<div class='docstring'>
<p>Whether the default is &#39;mutable&#39; (true) or &#39;immutable&#39; (false)</p>
</div>
<div class='tags'>
</div>
</dd>
</dl>
<h2>Instance Method Summary</h2>
@@ -67,6 +71,7 @@
</a>
</span>
<span class='desc'>
Set if the default is &#39;mutable&#39; or &#39;immutable&#39;
</span>
</li>
<li>
@@ -148,7 +153,24 @@
<b>setMutableDefault</b><span>(mutable)</span>
<br>
</p>
<div class='docstring'>
<p>Set if the default is &#39;mutable&#39; or &#39;immutable&#39;</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>mutable</span>
<span class='type'>
(
<tt>String|Boolean</tt>
)
</span>
&mdash;
<span class='desc'>Set either &#39;mutable&#39; / true or &#39;immutable&#39; / false </span>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='val-dynamic'>
@@ -286,7 +308,7 @@
</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>

18
doc/class/JsonWrapper.html
View File

@@ -116,12 +116,26 @@ console.log(w.newProperty == &quot;Awesome&quot;) # true!</code></pre>
<b>constructor</b><span>(jsonType)</span>
<br>
</p>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>jsonType</span>
<span class='type'>
(
<tt><a href='../class/JsonType.html'>JsonType</a></tt>
)
</span>
&mdash;
<span class='desc'>Instance of the JsonType that this class wrappes. </span>
</li>
</ul>
</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>

28
doc/class/JsonYatta.html
View File

@@ -137,7 +137,31 @@ Known values that are supported:</p><ul>
<b>constructor</b><span>(user_id, Connector)</span>
<br>
</p>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>user_id</span>
<span class='type'>
(
<tt>String</tt>
)
</span>
&mdash;
<span class='desc'>Unique id of the peer. </span>
</li>
<li>
<span class='name'>Connector</span>
<span class='type'>
(
<tt>Connector</tt>
)
</span>
&mdash;
<span class='desc'>the connector class. </span>
</li>
</ul>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
@@ -250,7 +274,7 @@ JsonYatta was initialized (Depending on the HistoryBuffer implementation).</p>
</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>

2
doc/class/ListManager.html
View File

@@ -208,7 +208,7 @@ Doesn&#39;t return left-right delimiter.</p>
</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>

11
doc/class/MapManager.html
View File

@@ -94,12 +94,19 @@
<b>val</b><span>(name, content)</span>
<br>
</p>
<div class='tags'>
<h3>See also:</h3>
<ul class='see'>
<li>
<a href='JsonTypes.val'>JsonTypes.val</a>
</li>
</ul>
</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>

2
doc/class/Operation.html
View File

@@ -285,7 +285,7 @@ an easy way to refer to these operations via an uid or object reference.</p><p>F
</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>

34
doc/class/ReplaceManager.html
View File

@@ -63,17 +63,19 @@ Each Replaceable holds a value that is now replaceable.</p><p>The Word-type has
</a>
</span>
<span class='desc'>
Replace the existing word with a new word.
</span>
</li>
<li>
<span class='signature'>
<a href='#val-dynamic'>
#
(void)
(String)
<b>val</b><span>()</span>
</a>
</span>
<span class='desc'>
Get the value of this Word
</span>
</li>
<li>
@@ -85,6 +87,7 @@ Each Replaceable holds a value that is now replaceable.</p><p>The Word-type has
</a>
</span>
<span class='desc'>
Encode this operation in such a way that it can be parsed by remote peers.
</span>
</li>
</ul>
@@ -166,16 +169,31 @@ Each Replaceable holds a value that is now replaceable.</p><p>The Word-type has
<b>replace</b><span>(content)</span>
<br>
</p>
<div class='docstring'>
<p>Replace the existing word with a new word.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='val-dynamic'>
#
(void)
(String)
<b>val</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Get the value of this Word</p>
</div>
<div class='tags'>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
<tt>String</tt>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='_encode-dynamic'>
@@ -184,12 +202,16 @@ Each Replaceable holds a value that is now replaceable.</p><p>The Word-type has
<b>_encode</b><span>()</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>
</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>

34
doc/class/Replaceable.html
View File

@@ -62,6 +62,7 @@
</a>
</span>
<span class='desc'>
Return the content that this operation holds.
</span>
</li>
<li>
@@ -73,6 +74,7 @@
</a>
</span>
<span class='desc'>
Replace the content of this replaceable with new content.
</span>
</li>
<li>
@@ -84,6 +86,7 @@
</a>
</span>
<span class='desc'>
If possible set the replace manager in the content.
</span>
</li>
<li>
@@ -95,7 +98,7 @@
</a>
</span>
<span class='desc'>
Convert all relevant information of this operation to the json-format.
Encode this operation in such a way that it can be parsed by remote peers.
</span>
</li>
</ul>
@@ -154,7 +157,11 @@
<b>val</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Return the content that this operation holds.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='replace-dynamic'>
@@ -163,7 +170,11 @@
<b>replace</b><span>(content)</span>
<br>
</p>
<div class='docstring'>
<p>Replace the content of this replaceable with new content.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='execute-dynamic'>
@@ -172,7 +183,17 @@
<b>execute</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>If possible set the replace manager in the content.</p>
</div>
<div class='tags'>
<h3>See also:</h3>
<ul class='see'>
<li>
<a href='Word.setReplaceManager'>Word.setReplaceManager</a>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='_encode-dynamic'>
@@ -182,8 +203,7 @@
<br>
</p>
<div class='docstring'>
<p>Convert all relevant information of this operation to the json-format.
This result can be send to other clients.</p>
<p>Encode this operation in such a way that it can be parsed by remote peers.</p>
</div>
<div class='tags'>
</div>
@@ -191,7 +211,7 @@ This result can be send to other clients.</p>
</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>

135
doc/class/TestConnector.html
View File

@@ -50,6 +50,7 @@
</a>
</span>
<span class='desc'>
This engine applied operations in a specific order.
</span>
</li>
<li>
@@ -61,6 +62,7 @@
</a>
</span>
<span class='desc'>
This function is called whenever an operation was executed.
</span>
</li>
<li>
@@ -72,6 +74,7 @@
</a>
</span>
<span class='desc'>
This function is called whenever an operation was received from another peer.
</span>
</li>
<li>
@@ -83,6 +86,7 @@
</a>
</span>
<span class='desc'>
Flush one operation from the line of a specific user.
</span>
</li>
<li>
@@ -94,6 +98,7 @@
</a>
</span>
<span class='desc'>
Flush one operation on a random line.
</span>
</li>
<li>
@@ -105,17 +110,7 @@
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#sync-dynamic'>
#
(void)
<b>sync</b><span>()</span>
</a>
</span>
<span class='desc'>
Flush all operations on every line.
</span>
</li>
</ul>
@@ -128,7 +123,49 @@
<b>constructor</b><span>(engine, HB, execution_listener)</span>
<br>
</p>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>engine</span>
<span class='type'>
(
<tt><a href='../class/Engine.html'>Engine</a></tt>
)
</span>
&mdash;
<span class='desc'>The transformation engine </span>
</li>
<li>
<span class='name'>HB</span>
<span class='type'>
(
<tt><a href='../class/HistoryBuffer.html'>HistoryBuffer</a></tt>
)
</span>
</li>
<li>
<span class='name'>execution_listener</span>
<span class='type'>
(
<tt>Array&lt;Function&gt;</tt>
)
</span>
&mdash;
<span class='desc'>You must ensure that whenever an operation is executed, every function in this Array is called. </span>
</li>
<li>
<span class='name'>yatta</span>
<span class='type'>
(
<tt>Yatta</tt>
)
</span>
&mdash;
<span class='desc'>The Yatta framework. </span>
</li>
</ul>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
@@ -140,7 +177,12 @@
<b>getOpsInExecutionOrder</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>This engine applied operations in a specific order.
Get the ops in the right order.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='send-dynamic'>
@@ -149,7 +191,24 @@
<b>send</b><span>(o)</span>
<br>
</p>
<div class='docstring'>
<p>This function is called whenever an operation was executed.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>o</span>
<span class='type'>
(
<tt><a href='../class/Operation.html'>Operation</a></tt>
)
</span>
&mdash;
<span class='desc'>The operation that was executed. </span>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='receive-dynamic'>
@@ -158,7 +217,24 @@
<b>receive</b><span>(o)</span>
<br>
</p>
<div class='docstring'>
<p>This function is called whenever an operation was received from another peer.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>o</span>
<span class='type'>
(
<tt><a href='../class/Operation.html'>Operation</a></tt>
)
</span>
&mdash;
<span class='desc'>The operation that was received. </span>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='flushOne-dynamic'>
@@ -167,7 +243,11 @@
<b>flushOne</b><span>(user)</span>
<br>
</p>
<div class='docstring'>
<p>Flush one operation from the line of a specific user.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='flushOneRandom-dynamic'>
@@ -176,7 +256,11 @@
<b>flushOneRandom</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Flush one operation on a random line.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='flushAll-dynamic'>
@@ -185,21 +269,16 @@
<b>flushAll</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='sync-dynamic'>
#
(void)
<b>sync</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Flush all operations on every line.</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>

2
doc/class/TextDelete.html
View File

@@ -53,7 +53,7 @@
</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>

2
doc/class/TextInsert.html
View File

@@ -173,7 +173,7 @@ This result can be send to other clients.</p>
</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>

105
doc/class/TextYatta.html
View File

@@ -50,6 +50,7 @@
</a>
</span>
<span class='desc'>
@result Word
</span>
</li>
<li>
@@ -72,6 +73,7 @@
</a>
</span>
<span class='desc'>
Get the initialized connector.
</span>
</li>
<li>
@@ -94,6 +96,7 @@
</a>
</span>
<span class='desc'>
Get the UserId from the HistoryBuffer object.
</span>
</li>
<li>
@@ -150,7 +153,31 @@
<b>constructor</b><span>(user_id, Connector)</span>
<br>
</p>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>user_id</span>
<span class='type'>
(
<tt>String</tt>
)
</span>
&mdash;
<span class='desc'>Uniqe user id that defines this peer. </span>
</li>
<li>
<span class='name'>Connector</span>
<span class='type'>
(
<tt>Connector</tt>
)
</span>
&mdash;
<span class='desc'>The connector defines how you connect to the other peers. </span>
</li>
</ul>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
@@ -162,7 +189,11 @@
<b>getRootElement</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>@result Word</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='getEngine-dynamic'>
@@ -171,7 +202,14 @@
<b>getEngine</b><span>()</span>
<br>
</p>
<div class='tags'>
<h3>See also:</h3>
<ul class='see'>
<li>
<a href='../class/Engine.html'>Engine</a>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='getConnector-dynamic'>
@@ -180,7 +218,11 @@
<b>getConnector</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Get the initialized connector.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='getHistoryBuffer-dynamic'>
@@ -189,7 +231,14 @@
<b>getHistoryBuffer</b><span>()</span>
<br>
</p>
<div class='tags'>
<h3>See also:</h3>
<ul class='see'>
<li>
<a href='../class/HistoryBuffer.html'>HistoryBuffer</a>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='getUserId-dynamic'>
@@ -198,7 +247,13 @@
<b>getUserId</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Get the UserId from the HistoryBuffer object.
In most cases this will be the same as the user_id value with which
JsonYatta was initialized (Depending on the HistoryBuffer implementation).</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='val-dynamic'>
@@ -207,7 +262,14 @@
<b>val</b><span>()</span>
<br>
</p>
<div class='tags'>
<h3>See also:</h3>
<ul class='see'>
<li>
<a href='JsonType.val'>JsonType.val</a>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='insertText-dynamic'>
@@ -216,7 +278,14 @@
<b>insertText</b><span>(pos, content)</span>
<br>
</p>
<div class='tags'>
<h3>See also:</h3>
<ul class='see'>
<li>
<a href='Word.insertText'>Word.insertText</a>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='deleteText-dynamic'>
@@ -225,7 +294,14 @@
<b>deleteText</b><span>(pos, length)</span>
<br>
</p>
<div class='tags'>
<h3>See also:</h3>
<ul class='see'>
<li>
<a href='Word.deleteText'>Word.deleteText</a>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='replaceText-dynamic'>
@@ -234,12 +310,19 @@
<b>replaceText</b><span>(text)</span>
<br>
</p>
<div class='tags'>
<h3>See also:</h3>
<ul class='see'>
<li>
<a href='Word.replaceText'>Word.replaceText</a>
</li>
</ul>
</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>

9
doc/class/Word.html
View File

@@ -117,6 +117,7 @@
</a>
</span>
<span class='desc'>
Encode this operation in such a way that it can be parsed by remote peers.
</span>
</li>
</ul>
@@ -228,12 +229,16 @@ to provide replace functionality.</p>
<b>_encode</b><span>()</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>
</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>