Set up API docs generation [SDK-2921]

.jazzy.yaml

@@ -0,0 +1,9 @@
+author: Auth0
+author_url: https://auth0.com
+github_url: https://github.com/auth0/Auth0.swift
+podspec: Auth0.podspec
+output: Docs
+clean: true
+theme: fullwidth
+sdk: iphoneos
+undocumented_text: ""

.shiprc

@@ -4,6 +4,6 @@
         "Auth0.podspec": [],
         "README.md": ["~> {MAJOR}.{MINOR}"]
     },
-    "postbump": "bundle update",
+    "postbump": "bundle update && bundle exec jazzy",
     "prefixVersion": false
 }

Auth0/Auth0.swift

@@ -23,7 +23,7 @@ public typealias WebAuthResult<T> = Result<T, WebAuthError>
 public typealias CredentialsManagerResult<T> = Result<T, CredentialsManagerError>
 
 /**
- Default scope value used across Auth0.swift.
+ Default scope value used across Auth0.swift. Equals to `openid profile email`.
  */
 public let defaultScope = "openid profile email"
 
@@ -36,7 +36,7 @@ public let defaultScope = "openid profile email"
 
  - Parameters:
    - clientId: ClientId of your Auth0 application.
-   - domain:   Domain of your Auth0 account. e.g.: 'samples.auth0.com'.
+   - domain:   Domain of your Auth0 account, e.g. 'samples.auth0.com'.
    - session:  Instance of `URLSession` used for networking. By default it will use the shared `URLSession`.
  - Returns: Auth0 Authentication API.
  */
@@ -134,7 +134,7 @@ public func users(token: String, session: URLSession = .shared, bundle: Bundle =
 
  - Parameters:
    - token:   Token of Management API v2 with the correct allowed scopes to perform the desired action.
-   - domain:  Domain of your Auth0 account. e.g.: 'samples.auth0.com'.
+   - domain:  Domain of your Auth0 account, e.g. 'samples.auth0.com'.
    - session: Instance of `URLSession` used for networking. By default it will use the shared `URLSession`.
  - Returns: Auth0 Management API v2.
  */
@@ -185,7 +185,7 @@ public func webAuth(session: URLSession = .shared, bundle: Bundle = Bundle.main)
 
  - Parameters:
    - clientId: ClientId of your Auth0 application.
-   - domain:   Domain of your Auth0 account. e.g.: 'samples.auth0.com'.
+   - domain:   Domain of your Auth0 account, e.g. 'samples.auth0.com'.
    - session:  Instance of `URLSession` used for networking. By default it will use the shared `URLSession`.
  - Returns: Auth0 WebAuth component.
  */

Auth0/Auth0Error.swift

@@ -4,10 +4,14 @@ let unknownError = "a0.sdk.internal_error.unknown"
 let nonJSONError = "a0.sdk.internal_error.plain"
 let emptyBodyError = "a0.sdk.internal_error.empty"
 
+/**
+ Generic representation of Auth0 errors. ``AuthenticationError``, ``ManagementError``, ``WebAuthError``, and
+ ``CredentialsManagerError`` conform to this protocol.
+ */
 public protocol Auth0Error: LocalizedError, CustomDebugStringConvertible {
 
     /**
-     The underlying `Error`, if any. Defaults to `nil`.
+     The underlying `Error`, if any.
      */
     var cause: Error? { get }
 
@@ -16,7 +20,7 @@ public protocol Auth0Error: LocalizedError, CustomDebugStringConvertible {
 public extension Auth0Error {
 
     /**
-     The underlying `Error`, if any. Defaults to `nil`.
+     Defaults to `nil`.
      */
     var cause: Error? { return nil }
 
@@ -37,9 +41,7 @@ public extension Auth0Error {
 }
 
 /**
- Generic representation of Auth0 API errors.
-
- - Note: It's recommended to use either `AuthenticationError` or `ManagementError` for better error handling.
+ Generic representation of Auth0 API errors. ``AuthenticationError`` and ``ManagementError`` conform to this protocol.
  */
 public protocol Auth0APIError: Auth0Error {