Update docs

moovel · Apr 23, 2018 · 92928fa · 92928fa
1 parent e6303b4
commit 92928fa
Show file tree

Hide file tree

Showing 43 changed files with 810 additions and 324 deletions.
diff --git a/.jazzy.yaml b/.jazzy.yaml
@@ -9,6 +9,6 @@ sdk: iphonesimulator
 exclude:
   - 'E3db/Classes/Extensions.swift'
 xcodebuild_arguments: [
-  '-workspace', 'Example/E3db.xcworkspace',
-  '-scheme',    'E3db-Example'
+  '-workspace', 'E3db.xcworkspace',
+  '-scheme',    'E3db_Example'
 ]
diff --git a/docs/Enums.html b/docs/Enums.html
@@ -208,7 +208,7 @@ <h4>Declaration</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">E3dbError</span><span class="p">:</span> <span class="kt">Swift</span><span class="o">.</span><span class="kt">Error</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">E3dbError</span><span class="p">:</span> <span class="kt">Error</span></code></pre>
 
                         </div>
                       </div>

diff --git a/docs/Enums/E3dbError.html b/docs/Enums/E3dbError.html
@@ -145,7 +145,7 @@
             <h1>E3dbError</h1>
               <div class="declaration">
                 <div class="language">
-                  <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">E3dbError</span><span class="p">:</span> <span class="kt">Swift</span><span class="o">.</span><span class="kt">Error</span></code></pre>
+                  <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">E3dbError</span><span class="p">:</span> <span class="kt">Error</span></code></pre>
 
                 </div>
               </div>
@@ -313,9 +313,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:4E3db0A5ErrorO11descriptionSSv"></a>
+                    <a name="/s:4E3db0A5ErrorO11descriptionSSvp"></a>
                     <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
-                    <a class="token" href="#/s:4E3db0A5ErrorO11descriptionSSv">description</a>
+                    <a class="token" href="#/s:4E3db0A5ErrorO11descriptionSSvp">description</a>
                     </code>
                   </div>
                   <div class="height-container">

diff --git a/docs/Protocols/Signable.html b/docs/Protocols/Signable.html
@@ -164,9 +164,6 @@ <h1>Signable</h1>
                     <a name="//apple_ref/swift/Method/serialized()" class="dashAnchor"></a>
                     <a class="token" href="#/s:4E3db8SignableP10serializedSSyF">serialized()</a>
                     </code>
-                      <span class="declaration-note">
-                        Default implementation
-                      </span>
                   </div>
                   <div class="height-container">
                     <div class="pointer-container"></div>
@@ -179,10 +176,6 @@ <h1>Signable</h1>
 such as <code>Dictionary</code> and <code>Set</code> must be serialized
 in a reproducible order.</p>
 
-                      </div>
-                      <h4>Default Implementation</h4>
-                      <div class="default_impl abstract">
-
                       </div>
                       <div class="declaration">
                         <h4>Declaration</h4>

diff --git a/docs/Structs.html b/docs/Structs.html
@@ -176,7 +176,7 @@ <h3 class="section-name">Access Key Management</h3>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">EAKInfo</span><span class="p">:</span> <span class="kt">Swift</span><span class="o">.</span><span class="kt">Codable</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">EAKInfo</span><span class="p">:</span> <span class="kt">Codable</span></code></pre>
 
                         </div>
                       </div>
@@ -249,7 +249,7 @@ <h4>Declaration</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Config</span><span class="p">:</span> <span class="kt">Swift</span><span class="o">.</span><span class="kt">Codable</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Config</span><span class="p">:</span> <span class="kt">Codable</span></code></pre>
 
                         </div>
                       </div>
@@ -288,7 +288,7 @@ <h3 class="section-name">Offline Crypto Operations</h3>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">EncryptedDocument</span><span class="p">:</span> <span class="kt"><a href="Protocols/Signable.html">Signable</a></span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">EncryptedDocument</span><span class="p">:</span> <span class="kt">Encodable</span></code></pre>
 
                         </div>
                       </div>
@@ -345,7 +345,7 @@ <h4>Declaration</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">SignedDocument</span><span class="o">&lt;</span><span class="kt">T</span><span class="p">:</span> <span class="kt"><a href="Protocols/Signable.html">Signable</a></span><span class="o">&gt;</span><span class="p">:</span> <span class="kt"><a href="Protocols/Signable.html">Signable</a></span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">SignedDocument</span><span class="o">&lt;</span><span class="kt">T</span><span class="p">:</span> <span class="kt"><a href="Protocols/Signable.html">Signable</a></span><span class="o">&gt;</span></code></pre>
 
                         </div>
                       </div>
@@ -377,7 +377,7 @@ <h4>Declaration</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">QueryParams</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">QueryParams</span><span class="p">:</span> <span class="kt">Encodable</span></code></pre>
 
                         </div>
                       </div>
@@ -465,7 +465,7 @@ <h4>Declaration</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">ClientMeta</span><span class="p">:</span> <span class="kt"><a href="Protocols/Signable.html">Signable</a></span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">ClientMeta</span><span class="p">:</span> <span class="kt">Encodable</span></code></pre>
 
                         </div>
                       </div>
@@ -493,7 +493,7 @@ <h4>Declaration</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Meta</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Meta</span><span class="p">:</span> <span class="kt">Decodable</span></code></pre>
 
                         </div>
                       </div>
@@ -552,7 +552,7 @@ <h4>Declaration</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">ClientKey</span><span class="p">:</span> <span class="kt">Swift</span><span class="o">.</span><span class="kt">Codable</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">ClientKey</span><span class="p">:</span> <span class="kt">Codable</span></code></pre>
 
                         </div>
                       </div>
@@ -579,7 +579,7 @@ <h4>Declaration</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">SigningKey</span><span class="p">:</span> <span class="kt">Swift</span><span class="o">.</span><span class="kt">Codable</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">SigningKey</span><span class="p">:</span> <span class="kt">Codable</span></code></pre>
 
                         </div>
                       </div>
@@ -607,7 +607,7 @@ <h4>Declaration</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">ClientCredentials</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">ClientCredentials</span><span class="p">:</span> <span class="kt">Decodable</span></code></pre>
 
                         </div>
                       </div>
@@ -647,7 +647,7 @@ <h3 class="section-name">Sharing</h3>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">OutgoingSharingPolicy</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">OutgoingSharingPolicy</span><span class="p">:</span> <span class="kt">Decodable</span></code></pre>
 
                         </div>
                       </div>
@@ -676,7 +676,7 @@ <h4>Declaration</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">IncomingSharingPolicy</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">IncomingSharingPolicy</span><span class="p">:</span> <span class="kt">Decodable</span></code></pre>
 
                         </div>
                       </div>

diff --git a/docs/Structs/ClientCredentials.html b/docs/Structs/ClientCredentials.html
@@ -145,7 +145,7 @@
             <h1>ClientCredentials</h1>
               <div class="declaration">
                 <div class="language">
-                  <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">ClientCredentials</span></code></pre>
+                  <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">ClientCredentials</span><span class="p">:</span> <span class="kt">Decodable</span></code></pre>
 
                 </div>
               </div>
@@ -158,9 +158,9 @@ <h1>ClientCredentials</h1>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:4E3db17ClientCredentialsV8clientId10Foundation4UUIDVv"></a>
+                    <a name="/s:4E3db17ClientCredentialsV8clientId10Foundation4UUIDVvp"></a>
                     <a name="//apple_ref/swift/Property/clientId" class="dashAnchor"></a>
-                    <a class="token" href="#/s:4E3db17ClientCredentialsV8clientId10Foundation4UUIDVv">clientId</a>
+                    <a class="token" href="#/s:4E3db17ClientCredentialsV8clientId10Foundation4UUIDVvp">clientId</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -185,9 +185,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:4E3db17ClientCredentialsV8apiKeyIdSSv"></a>
+                    <a name="/s:4E3db17ClientCredentialsV8apiKeyIdSSvp"></a>
                     <a name="//apple_ref/swift/Property/apiKeyId" class="dashAnchor"></a>
-                    <a class="token" href="#/s:4E3db17ClientCredentialsV8apiKeyIdSSv">apiKeyId</a>
+                    <a class="token" href="#/s:4E3db17ClientCredentialsV8apiKeyIdSSvp">apiKeyId</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -212,9 +212,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:4E3db17ClientCredentialsV9apiSecretSSv"></a>
+                    <a name="/s:4E3db17ClientCredentialsV9apiSecretSSvp"></a>
                     <a name="//apple_ref/swift/Property/apiSecret" class="dashAnchor"></a>
-                    <a class="token" href="#/s:4E3db17ClientCredentialsV9apiSecretSSv">apiSecret</a>
+                    <a class="token" href="#/s:4E3db17ClientCredentialsV9apiSecretSSvp">apiSecret</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -239,9 +239,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:4E3db17ClientCredentialsV4nameSSv"></a>
+                    <a name="/s:4E3db17ClientCredentialsV4nameSSvp"></a>
                     <a name="//apple_ref/swift/Property/name" class="dashAnchor"></a>
-                    <a class="token" href="#/s:4E3db17ClientCredentialsV4nameSSv">name</a>
+                    <a class="token" href="#/s:4E3db17ClientCredentialsV4nameSSvp">name</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -266,9 +266,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:4E3db17ClientCredentialsV9publicKeySSv"></a>
+                    <a name="/s:4E3db17ClientCredentialsV9publicKeySSvp"></a>
                     <a name="//apple_ref/swift/Property/publicKey" class="dashAnchor"></a>
-                    <a class="token" href="#/s:4E3db17ClientCredentialsV9publicKeySSv">publicKey</a>
+                    <a class="token" href="#/s:4E3db17ClientCredentialsV9publicKeySSvp">publicKey</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -293,9 +293,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:4E3db17ClientCredentialsV10signingKeySSv"></a>
+                    <a name="/s:4E3db17ClientCredentialsV10signingKeySSvp"></a>
                     <a name="//apple_ref/swift/Property/signingKey" class="dashAnchor"></a>
-                    <a class="token" href="#/s:4E3db17ClientCredentialsV10signingKeySSv">signingKey</a>
+                    <a class="token" href="#/s:4E3db17ClientCredentialsV10signingKeySSvp">signingKey</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -320,9 +320,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:4E3db17ClientCredentialsV7enabledSbv"></a>
+                    <a name="/s:4E3db17ClientCredentialsV7enabledSbvp"></a>
                     <a name="//apple_ref/swift/Property/enabled" class="dashAnchor"></a>
-                    <a class="token" href="#/s:4E3db17ClientCredentialsV7enabledSbv">enabled</a>
+                    <a class="token" href="#/s:4E3db17ClientCredentialsV7enabledSbvp">enabled</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -344,6 +344,32 @@ <h4>Declaration</h4>
                     </section>
                   </div>
                 </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:s9DecodablePxs7Decoder_p4from_tKcfc"></a>
+                    <a name="//apple_ref/swift/Method/init(from:)" class="dashAnchor"></a>
+                    <a class="token" href="#/s:s9DecodablePxs7Decoder_p4from_tKcfc">init(from:)</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="n">from</span> <span class="nv">decoder</span><span class="p">:</span> <span class="kt">Decoder</span><span class="p">)</span> <span class="k">throws</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
               </ul>
             </div>
           </section>