Docs: Update Jazzy Docs for Codable Sessions (#57)

Kitura · Jan 30, 2019 · 511be68 · 511be68
1 parent 352aa43
commit 511be68
Show file tree

Hide file tree

Showing 35 changed files with 196 additions and 72 deletions.
diff --git a/README.md b/README.md
@@ -75,7 +75,7 @@ The router has a POST route that decodes a `User` instance from the request body
 The router has a GET route that reads a user id from the query parameters
      and decodes the instance of `User` that is in the session for that id.  
 
-```
+```swift
 public struct User: Codable {
         let id: String
         let name: String

diff --git a/docs/Classes.html b/docs/Classes.html
@@ -22,7 +22,7 @@
         <a class="header-link" href="index.html">
           KituraSession Docs
         </a>
-         (100% documented)
+         (97% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -182,7 +182,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
+      <p>&copy; 2019 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-01-30)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.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/Session.html b/docs/Classes/Session.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           KituraSession Docs
         </a>
-         (100% documented)
+         (97% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -272,7 +272,7 @@ <h4>Parameters</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
+      <p>&copy; 2019 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-01-30)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.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/SessionState.html b/docs/Classes/SessionState.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           KituraSession Docs
         </a>
-         (100% documented)
+         (97% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -345,7 +345,7 @@ <h4>Parameters</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Retrieve an entry from the session data.</p>
+                        <p>Retrieve or store an entry from the session data.</p>
 
                       </div>
                       <div class="declaration">
@@ -378,6 +378,33 @@ <h4>Parameters</h4>
                     </section>
                   </div>
                 </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:13KituraSession0B5StateCxSgSScs9DecodableRzs9EncodableRzluip"></a>
+                    <a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
+                    <a class="token" href="#/s:13KituraSession0B5StateCxSgSScs9DecodableRzs9EncodableRzluip">subscript(_:)</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Undocumented</p>
+
+                      </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="kd">subscript</span><span class="o">&lt;</span><span class="kt">T</span><span class="p">:</span> <span class="kt">Codable</span><span class="o">&gt;</span><span class="p">(</span><span class="nv">key</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">T</span><span class="p">?</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
               </ul>
             </div>
           </div>
@@ -386,7 +413,7 @@ <h4>Parameters</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
+      <p>&copy; 2019 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-01-30)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Enums.html b/docs/Enums.html
@@ -22,7 +22,7 @@
         <a class="header-link" href="index.html">
           KituraSession Docs
         </a>
-         (100% documented)
+         (97% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -182,7 +182,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
+      <p>&copy; 2019 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-01-30)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Enums/CookieParameter.html b/docs/Enums/CookieParameter.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           KituraSession Docs
         </a>
-         (100% documented)
+         (97% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -249,7 +249,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
+      <p>&copy; 2019 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-01-30)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Enums/StoreError.html b/docs/Enums/StoreError.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           KituraSession Docs
         </a>
-         (100% documented)
+         (97% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -156,7 +156,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
+      <p>&copy; 2019 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-01-30)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Extensions.html b/docs/Extensions.html
@@ -22,7 +22,7 @@
         <a class="header-link" href="index.html">
           KituraSession Docs
         </a>
-         (100% documented)
+         (97% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -151,7 +151,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
+      <p>&copy; 2019 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-01-30)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Extensions/RouterRequest.html b/docs/Extensions/RouterRequest.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           KituraSession Docs
         </a>
-         (100% documented)
+         (97% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -157,7 +157,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
+      <p>&copy; 2019 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-01-30)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Protocols.html b/docs/Protocols.html
@@ -22,7 +22,7 @@
         <a class="header-link" href="index.html">
           KituraSession Docs
         </a>
-         (100% documented)
+         (97% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -204,7 +204,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
+      <p>&copy; 2019 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-01-30)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Protocols/Store.html b/docs/Protocols/Store.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           KituraSession Docs
         </a>
-         (100% documented)
+         (97% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -373,7 +373,7 @@ <h4>Parameters</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
+      <p>&copy; 2019 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-01-30)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Protocols/TypeSafeSession.html b/docs/Protocols/TypeSafeSession.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           KituraSession Docs
         </a>
-         (100% documented)
+         (97% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -569,7 +569,7 @@ <h4>Parameters</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
+      <p>&copy; 2019 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-01-30)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Structs.html b/docs/Structs.html
@@ -22,7 +22,7 @@
         <a class="header-link" href="index.html">
           KituraSession Docs
         </a>
-         (100% documented)
+         (97% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -155,7 +155,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
+      <p>&copy; 2019 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-01-30)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Structs/SessionCookie.html b/docs/Structs/SessionCookie.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           KituraSession Docs
         </a>
-         (100% documented)
+         (97% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -275,7 +275,7 @@ <h4>Parameters</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
+      <p>&copy; 2019 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-01-30)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/badge.svg b/docs/badge.svg
diff --git a/docs/docsets/KituraSession.docset/Contents/Resources/Documents/Classes.html b/docs/docsets/KituraSession.docset/Contents/Resources/Documents/Classes.html
@@ -22,7 +22,7 @@
         <a class="header-link" href="index.html">
           KituraSession Docs
         </a>
-         (100% documented)
+         (97% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -182,7 +182,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
+      <p>&copy; 2019 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-01-30)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/docsets/KituraSession.docset/Contents/Resources/Documents/Classes/Session.html b/docs/docsets/KituraSession.docset/Contents/Resources/Documents/Classes/Session.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           KituraSession Docs
         </a>
-         (100% documented)
+         (97% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -272,7 +272,7 @@ <h4>Parameters</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
+      <p>&copy; 2019 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-01-30)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>