docs(states): add numeric values for WebGroup and Signaling states

coast-team · Dec 20, 2017 · 2207ca4 · 2207ca4
1 parent 1d3c7ba
commit 2207ca4
Show file tree

Hide file tree

Showing 38 changed files with 10,379 additions and 10,403 deletions.
diff --git a/docs/ast/source/WebChannelFacade.js.json b/docs/ast/source/WebChannelFacade.js.json
diff --git a/docs/ast/source/index.browser.js.json → docs/ast/source/index.common.js.json b/docs/ast/source/index.browser.js.json → docs/ast/source/index.common.js.json
diff --git a/docs/class/src/BotServerFacade.js~WebGroupBotServer.html b/docs/class/src/BotServerFacade.js~WebGroupBotServer.html
@@ -32,8 +32,8 @@
   <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/BotServerFacade.js~WebGroupBotServer.html">WebGroupBotServer</a></span></span></li>
 <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/WebChannelFacade.js~WebGroup.html">WebGroup</a></span></span></li>
 <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/WebChannelFacade.js~WebGroupState.html">WebGroupState</a></span></span></li>
-<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/index.browser.js~SignalingState.html">SignalingState</a></span></span></li>
-<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/index.browser.js~Topology.html">Topology</a></span></span></li>
+<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/index.common.js~SignalingState.html">SignalingState</a></span></span></li>
+<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/index.common.js~Topology.html">Topology</a></span></span></li>
 <li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-enableLog">enableLog</a></span></span></li>
 <li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-DataType">DataType</a></span></span></li>
 <li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-WebGroupBotServerOptions">WebGroupBotServerOptions</a></span></span></li>
@@ -420,7 +420,7 @@ <h4 data-ice="title">Params:</h4>
     </tr>
 <tr data-ice="property" data-depth="2">
       <td data-ice="name" class="code" data-depth="2">options.webGroupOptions.topology</td>
-      <td data-ice="type" class="code"><span><a href="class/src/index.browser.js~Topology.html">Topology</a></span></td>
+      <td data-ice="type" class="code"><span><a href="class/src/index.common.js~Topology.html">Topology</a></span></td>
       <td data-ice="appendix"><ul><li>optional</li>
 <li>default: Topology.FULL_MESH</li></ul></td>
       <td data-ice="description"></td>

diff --git a/docs/class/src/WebChannelFacade.js~WebGroup.html b/docs/class/src/WebChannelFacade.js~WebGroup.html
diff --git a/docs/class/src/WebChannelFacade.js~WebGroupState.html b/docs/class/src/WebChannelFacade.js~WebGroupState.html
@@ -32,8 +32,8 @@
   <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/BotServerFacade.js~WebGroupBotServer.html">WebGroupBotServer</a></span></span></li>
 <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/WebChannelFacade.js~WebGroup.html">WebGroup</a></span></span></li>
 <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/WebChannelFacade.js~WebGroupState.html">WebGroupState</a></span></span></li>
-<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/index.browser.js~SignalingState.html">SignalingState</a></span></span></li>
-<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/index.browser.js~Topology.html">Topology</a></span></span></li>
+<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/index.common.js~SignalingState.html">SignalingState</a></span></span></li>
+<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/index.common.js~Topology.html">Topology</a></span></span></li>
 <li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-enableLog">enableLog</a></span></span></li>
 <li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-DataType">DataType</a></span></span></li>
 <li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-WebGroupBotServerOptions">WebGroupBotServerOptions</a></span></span></li>
@@ -47,13 +47,13 @@
 </nav>
 
 <div class="content" data-ice="content"><div class="header-notice">
-  <div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {WebGroupState} from &apos;<span><a href="file/src/WebChannelFacade.js.html#lineNumber20">netflux/src/WebChannelFacade.js</a></span>&apos;</code></pre></div>
+  <div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {WebGroupState} from &apos;<span><a href="file/src/WebChannelFacade.js.html#lineNumber13">netflux/src/WebChannelFacade.js</a></span>&apos;</code></pre></div>
   <span data-ice="access">public</span>
   <span data-ice="kind">class</span>
 
 
 
-  <span data-ice="source">| <span><a href="file/src/WebChannelFacade.js.html#lineNumber20">source</a></span></span>
+  <span data-ice="source">| <span><a href="file/src/WebChannelFacade.js.html#lineNumber13">source</a></span></span>
 </div>
 
 <div class="self-detail detail">
@@ -110,7 +110,7 @@ <h1 data-ice="name">WebGroupState</h1>
       <div>
 
 
-        <div data-ice="description"><p>Joined the group successfully.</p>
+        <div data-ice="description"><p>Equals to <code>1</code>: joined the group successfully.</p>
 </div>
       </div>
     </td>
@@ -139,7 +139,7 @@ <h1 data-ice="name">WebGroupState</h1>
       <div>
 
 
-        <div data-ice="description"><p>Joining the group...</p>
+        <div data-ice="description"><p>Equals to <code>0</code>: joining the group...</p>
 </div>
       </div>
     </td>
@@ -168,7 +168,7 @@ <h1 data-ice="name">WebGroupState</h1>
       <div>
 
 
-        <div data-ice="description"><p>Left the group.</p>
+        <div data-ice="description"><p>Equals to <code>2</code>: left the group.</p>
 </div>
       </div>
     </td>
@@ -288,14 +288,14 @@ <h3 data-ice="anchor" id="static-get-JOINED">
     <span class="right-info">
 
 
-      <span data-ice="source"><span><a href="file/src/WebChannelFacade.js.html#lineNumber35">source</a></span></span>
+      <span data-ice="source"><span><a href="file/src/WebChannelFacade.js.html#lineNumber28">source</a></span></span>
     </span>
   </h3>
 
 
 
 
-  <div data-ice="description"><p>Joined the group successfully.</p>
+  <div data-ice="description"><p>Equals to <code>1</code>: joined the group successfully.</p>
 </div>
 
 
@@ -332,14 +332,14 @@ <h3 data-ice="anchor" id="static-get-JOINING">
     <span class="right-info">
 
 
-      <span data-ice="source"><span><a href="file/src/WebChannelFacade.js.html#lineNumber25">source</a></span></span>
+      <span data-ice="source"><span><a href="file/src/WebChannelFacade.js.html#lineNumber18">source</a></span></span>
     </span>
   </h3>
 
 
 
 
-  <div data-ice="description"><p>Joining the group...</p>
+  <div data-ice="description"><p>Equals to <code>0</code>: joining the group...</p>
 </div>
 
 
@@ -376,17 +376,17 @@ <h3 data-ice="anchor" id="static-get-LEFT">
     <span class="right-info">
 
 
-      <span data-ice="source"><span><a href="file/src/WebChannelFacade.js.html#lineNumber48">source</a></span></span>
+      <span data-ice="source"><span><a href="file/src/WebChannelFacade.js.html#lineNumber41">source</a></span></span>
     </span>
   </h3>
 
 
 
 
-  <div data-ice="description"><p>Left the group. If the connection to the web group has lost other then
+  <div data-ice="description"><p>Equals to <code>2</code>: left the group. If the connection to the web group has lost other then
 by calling <span><a href="class/src/WebChannelFacade.js~WebGroup.html#instance-method-leave">WebGroup#leave</a></span> or <span><a href="class/src/WebChannelFacade.js~WebGroup.html#instance-method-closeSignaling">WebGroup#closeSignaling</a></span> methods
 and <span><a href="class/src/WebChannelFacade.js~WebGroup.html#instance-member-autoRejoin">WebGroup#autoRejoin</a></span> is true, then the state would be <code>LEFT</code>,
-(usually during a relatively short period) before the rejoining process start.</p>
+(usually during a relatively short period) before the rejoining process starts.</p>
 </div>
 
 
@@ -423,7 +423,7 @@ <h3 data-ice="anchor" id="static-get-[WebGroupState.JOINED]">
     <span class="right-info">
 
 
-      <span data-ice="source"><span><a href="file/src/WebChannelFacade.js.html#lineNumber40">source</a></span></span>
+      <span data-ice="source"><span><a href="file/src/WebChannelFacade.js.html#lineNumber33">source</a></span></span>
     </span>
   </h3>
 
@@ -467,7 +467,7 @@ <h3 data-ice="anchor" id="static-get-[WebGroupState.JOINING]">
     <span class="right-info">
 
 
-      <span data-ice="source"><span><a href="file/src/WebChannelFacade.js.html#lineNumber30">source</a></span></span>
+      <span data-ice="source"><span><a href="file/src/WebChannelFacade.js.html#lineNumber23">source</a></span></span>
     </span>
   </h3>
 
@@ -511,7 +511,7 @@ <h3 data-ice="anchor" id="static-get-[WebGroupState.LEFT]">
     <span class="right-info">
 
 
-      <span data-ice="source"><span><a href="file/src/WebChannelFacade.js.html#lineNumber53">source</a></span></span>
+      <span data-ice="source"><span><a href="file/src/WebChannelFacade.js.html#lineNumber46">source</a></span></span>
     </span>
   </h3>