Update docs

AnderGoig · Jan 21, 2018 · dd826fd · dd826fd
1 parent 7305e87
commit dd826fd
Show file tree

Hide file tree

Showing 56 changed files with 1,568 additions and 143 deletions.
diff --git a/README.md b/README.md
@@ -57,6 +57,7 @@
 - [x] Secure access token storing, thanks to [keychain-swift](https://github.com/evgenyneu/keychain-swift).
 - [x] Client-Side authentication.
 - [x] 100% documented code.
+- [x] Use of Swift 4 Decodable.
 - [x] Up-to-date with the latest Apple technologies (Swift 4, Xcode 9, etc).
 
 ### [Upcoming features](https://github.com/AnderGoig/SwiftInstagram/projects/1)

diff --git a/Sources/Instagram.swift b/Sources/Instagram.swift
@@ -110,10 +110,12 @@ public class Instagram {
 
     // MARK: - Access Token
 
+    /// Store your own authenticated access token so you don't have to use the included login authentication.
     public func storeAccessToken(_ accessToken: String) -> Bool {
         return keychain.set(accessToken, forKey: Keychain.accessTokenKey)
     }
 
+    /// Returns the current access token.
     public func retrieveAccessToken() -> String? {
         return keychain.get(Keychain.accessTokenKey)
     }

diff --git a/Sources/Models/InstagramError.swift b/Sources/Models/InstagramError.swift
@@ -8,9 +8,19 @@
 
 /// A type representing an error value that can be thrown.
 public enum InstagramError: Error {
+
+    /// Error 400 on login
     case badRequest
+
+    /// Error decoding JSON
     case decoding(message: String)
+
+    /// Invalid API request
     case invalidRequest(message: String)
+
+    /// Keychain error
     case keychainError(code: OSStatus)
+
+    /// The client id or the redirect URI is missing inside the Info.plist file
     case missingClientIdOrRedirectURI
 }
diff --git a/Sources/Models/InstagramResponse.swift b/Sources/Models/InstagramResponse.swift
@@ -39,4 +39,5 @@ struct InstagramResponse<T: Decodable>: Decodable {
     }
 }
 
+/// Dummy struct used for empty Instagram API data responses
 public struct InstagramEmptyResponse: Decodable { }
diff --git a/docs/API.html b/docs/API.html
@@ -22,7 +22,7 @@
         <a class="header-link" href="index.html">
           SwiftInstagram Docs
         </a>
-         (93% documented)
+         (100% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -113,7 +113,15 @@
             <a class="nav-group-name-link" href="Errors.html">Errors</a>
             <ul class="nav-group-tasks">
               <li class="nav-group-task">
-                <a class="nav-group-task-link" href="Errors.html#/s:14SwiftInstagram0B5ErrorO">InstagramError</a>
+                <a class="nav-group-task-link" href="Enums/InstagramError.html">InstagramError</a>
+              </li>
+            </ul>
+          </li>
+          <li class="nav-group-name">
+            <a class="nav-group-name-link" href="Other Structs.html">Other Structures</a>
+            <ul class="nav-group-tasks">
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="Other Structs.html#/s:14SwiftInstagram0B13EmptyResponseV">InstagramEmptyResponse</a>
               </li>
             </ul>
           </li>

diff --git a/docs/Authentication.html b/docs/Authentication.html
@@ -22,7 +22,7 @@
         <a class="header-link" href="index.html">
           SwiftInstagram Docs
         </a>
-         (93% documented)
+         (100% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -113,7 +113,15 @@
             <a class="nav-group-name-link" href="Errors.html">Errors</a>
             <ul class="nav-group-tasks">
               <li class="nav-group-task">
-                <a class="nav-group-task-link" href="Errors.html#/s:14SwiftInstagram0B5ErrorO">InstagramError</a>
+                <a class="nav-group-task-link" href="Enums/InstagramError.html">InstagramError</a>
+              </li>
+            </ul>
+          </li>
+          <li class="nav-group-name">
+            <a class="nav-group-name-link" href="Other Structs.html">Other Structures</a>
+            <ul class="nav-group-tasks">
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="Other Structs.html#/s:14SwiftInstagram0B13EmptyResponseV">InstagramEmptyResponse</a>
               </li>
             </ul>
           </li>

diff --git a/docs/Classes/Instagram.html b/docs/Classes/Instagram.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftInstagram Docs
         </a>
-         (93% documented)
+         (100% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -114,7 +114,15 @@
             <a class="nav-group-name-link" href="../Errors.html">Errors</a>
             <ul class="nav-group-tasks">
               <li class="nav-group-task">
-                <a class="nav-group-task-link" href="../Errors.html#/s:14SwiftInstagram0B5ErrorO">InstagramError</a>
+                <a class="nav-group-task-link" href="../Enums/InstagramError.html">InstagramError</a>
+              </li>
+            </ul>
+          </li>
+          <li class="nav-group-name">
+            <a class="nav-group-name-link" href="../Other Structs.html">Other Structures</a>
+            <ul class="nav-group-tasks">
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Other Structs.html#/s:14SwiftInstagram0B13EmptyResponseV">InstagramEmptyResponse</a>
               </li>
             </ul>
           </li>
@@ -332,6 +340,71 @@ <h4>Declaration</h4>
                 </li>
               </ul>
             </div>
+            <div class="task-group">
+              <div class="task-name-container">
+                <a name="/Access%20Token"></a>
+                <a name="//apple_ref/swift/Section/Access Token" class="dashAnchor"></a>
+                <a href="#/Access%20Token">
+                  <h3 class="section-name">Access Token</h3>
+                </a>
+              </div>
+              <ul class="item-container">
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:14SwiftInstagram0B0C16storeAccessTokenSbSSF"></a>
+                    <a name="//apple_ref/swift/Method/storeAccessToken(_:)" class="dashAnchor"></a>
+                    <a class="token" href="#/s:14SwiftInstagram0B0C16storeAccessTokenSbSSF">storeAccessToken(_:)</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Store your own authenticated access token so you don&rsquo;t have to use the included login authentication.</p>
+
+                      </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">func</span> <span class="nf">storeAccessToken</span><span class="p">(</span><span class="n">_</span> <span class="nv">accessToken</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:14SwiftInstagram0B0C19retrieveAccessTokenSSSgyF"></a>
+                    <a name="//apple_ref/swift/Method/retrieveAccessToken()" class="dashAnchor"></a>
+                    <a class="token" href="#/s:14SwiftInstagram0B0C19retrieveAccessTokenSSSgyF">retrieveAccessToken()</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Returns the current access token.</p>
+
+                      </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">func</span> <span class="nf">retrieveAccessToken</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">String</span><span class="p">?</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
+              </ul>
+            </div>
             <div class="task-group">
               <div class="task-name-container">
                 <a name="/Comment%20Endpoints"></a>