update docs

socketio · Aug 31, 2017 · 4929c84 · 4929c84
1 parent 04e90fc
commit 4929c84
Show file tree

Hide file tree

Showing 27 changed files with 124 additions and 131 deletions.
diff --git a/docs/Classes.html b/docs/Classes.html
@@ -256,29 +256,25 @@ <h4>Declaration</h4>
  <li class="item">
  <div>
  <code>
- <a name="/s:C8SocketIO14SocketIOClient"></a>
- <a name="//apple_ref/swift/Class/SocketIOClient" class="dashAnchor"></a>
- <a class="token" href="#/s:C8SocketIO14SocketIOClient">SocketIOClient</a>
+ <a name="/s:C8SocketIO14SocketAnyEvent"></a>
+ <a name="//apple_ref/swift/Class/SocketAnyEvent" class="dashAnchor"></a>
+ <a class="token" href="#/s:C8SocketIO14SocketAnyEvent">SocketAnyEvent</a>
  </code>
  </div>
  <div class="height-container">
  <div class="pointer-container"></div>
  <section class="section">
  <div class="pointer"></div>
  <div class="abstract">
- <p>The main class for SocketIOClientSwift.</p>
-
-<p><strong>NOTE</strong>: The client is not thread/queue safe, all interaction with the socket should be done on the <code>handleQueue</code></p>
-
-<p>Represents a socket.io-client. Most interaction with socket.io will be through this class.</p>
+ <p>Represents some event that was received.</p>
 
- <a href="Classes/SocketIOClient.html" class="slightly-smaller">See more</a>
+ <a href="Classes/SocketAnyEvent.html" class="slightly-smaller">See more</a>
  </div>
  <div class="declaration">
  <h4>Declaration</h4>
  <div class="language">
  <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">SocketIOClient</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">SocketIOClientSpec</span><span class="p">,</span> <span class="kt"><a href="Protocols/SocketEngineClient.html">SocketEngineClient</a></span><span class="p">,</span> <span class="kt">SocketParsable</span></code></pre>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">SocketAnyEvent</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
 
  </div>
  </div>
@@ -292,25 +288,29 @@ <h4>Declaration</h4>
  <li class="item">
  <div>
  <code>
- <a name="/s:C8SocketIO14SocketAnyEvent"></a>
- <a name="//apple_ref/swift/Class/SocketAnyEvent" class="dashAnchor"></a>
- <a class="token" href="#/s:C8SocketIO14SocketAnyEvent">SocketAnyEvent</a>
+ <a name="/s:C8SocketIO14SocketIOClient"></a>
+ <a name="//apple_ref/swift/Class/SocketIOClient" class="dashAnchor"></a>
+ <a class="token" href="#/s:C8SocketIO14SocketIOClient">SocketIOClient</a>
  </code>
  </div>
  <div class="height-container">
  <div class="pointer-container"></div>
  <section class="section">
  <div class="pointer"></div>
  <div class="abstract">
- <p>Represents some event that was received.</p>
+ <p>The main class for SocketIOClientSwift.</p>
 
- <a href="Classes/SocketAnyEvent.html" class="slightly-smaller">See more</a>
+<p><strong>NOTE</strong>: The client is not thread/queue safe, all interaction with the socket should be done on the <code>handleQueue</code></p>
+
+<p>Represents a socket.io-client. Most interaction with socket.io will be through this class.</p>
+
+ <a href="Classes/SocketIOClient.html" class="slightly-smaller">See more</a>
  </div>
  <div class="declaration">
  <h4>Declaration</h4>
  <div class="language">
  <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">SocketAnyEvent</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
+ <pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">SocketIOClient</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">SocketIOClientSpec</span><span class="p">,</span> <span class="kt"><a href="Protocols/SocketEngineClient.html">SocketEngineClient</a></span><span class="p">,</span> <span class="kt">SocketParsable</span></code></pre>
 
  </div>
  </div>
@@ -372,7 +372,7 @@ <h4>Declaration</h4>
  </article>
  </div>
  <section class="footer">
- <p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
+ <p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-31)</p>
  <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>

diff --git a/docs/Classes/OnAckCallback.html b/docs/Classes/OnAckCallback.html
@@ -239,7 +239,7 @@ <h4>Parameters</h4>
  </article>
  </div>
  <section class="footer">
- <p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
+ <p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-31)</p>
  <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>

diff --git a/docs/Classes/SocketAckEmitter.html b/docs/Classes/SocketAckEmitter.html
@@ -309,7 +309,7 @@ <h4>Parameters</h4>
  </article>
  </div>
  <section class="footer">
- <p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
+ <p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-31)</p>
  <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>

diff --git a/docs/Classes/SocketAnyEvent.html b/docs/Classes/SocketAnyEvent.html
@@ -255,7 +255,7 @@ <h4>Declaration</h4>
  </article>
  </div>
  <section class="footer">
- <p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
+ <p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-31)</p>
  <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>

diff --git a/docs/Classes/SocketClientManager.html b/docs/Classes/SocketClientManager.html
@@ -443,7 +443,7 @@ <h4>Declaration</h4>
  </article>
  </div>
  <section class="footer">
- <p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
+ <p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-31)</p>
  <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>

diff --git a/docs/Classes/SocketEngine.html b/docs/Classes/SocketEngine.html
@@ -1433,7 +1433,7 @@ <h4>Declaration</h4>
  </article>
  </div>
  <section class="footer">
- <p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
+ <p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-31)</p>
  <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>

diff --git a/docs/Classes/SocketIOClient.html b/docs/Classes/SocketIOClient.html
@@ -1856,7 +1856,7 @@ <h4>Declaration</h4>
  </article>
  </div>
  <section class="footer">
- <p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-17)</p>
+ <p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-08-31)</p>
  <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>