Update docs

By running `bundle exec rake docs`
krzysztofzablocki · Apr 28, 2020 · bfd4154 · bfd4154
1 parent e236ea7
commit bfd4154
Show file tree

Hide file tree

Showing 12 changed files with 178 additions and 198 deletions.
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -164,4 +164,4 @@ DEPENDENCIES
   xcpretty
 
 BUNDLED WITH
-   1.16.6
+   2.1.4
diff --git a/SourceryRuntime/Sources/Diffable.swift b/SourceryRuntime/Sources/Diffable.swift
@@ -68,6 +68,7 @@ extension DiffableResult {
 
 #if swift(>=4.1)
 #else
+    /// :nodoc:
     @discardableResult func trackDifference<T: Equatable>(actual: T, expected: T) -> DiffableResult {
         if actual != expected {
             let result = DiffableResult(results: ["<expected: \(expected), received: \(actual)>"])
@@ -77,6 +78,7 @@ extension DiffableResult {
     }
 #endif
 
+    /// :nodoc:
     @discardableResult func trackDifference<T: Equatable>(actual: T?, expected: T?) -> DiffableResult {
         if actual != expected {
             let result = DiffableResult(results: ["<expected: \(expected.map({ "\($0)" }) ?? "nil"), received: \(actual.map({ "\($0)" }) ?? "nil")>"])
@@ -85,12 +87,14 @@ extension DiffableResult {
         return self
     }
 
+    /// :nodoc:
     @discardableResult func trackDifference<T: Equatable>(actual: T, expected: T) -> DiffableResult where T: Diffable {
         let diffResult = actual.diffAgainst(expected)
         append(contentsOf: diffResult)
         return self
     }
 
+    /// :nodoc:
     @discardableResult func trackDifference<T: Equatable>(actual: [T], expected: [T]) -> DiffableResult where T: Diffable {
         let diffResult = DiffableResult()
         defer { append(contentsOf: diffResult) }
@@ -112,6 +116,7 @@ extension DiffableResult {
         return self
     }
 
+    /// :nodoc:
     @discardableResult func trackDifference<T: Equatable>(actual: [T], expected: [T]) -> DiffableResult {
         let diffResult = DiffableResult()
         defer { append(contentsOf: diffResult) }
@@ -129,6 +134,7 @@ extension DiffableResult {
         return self
     }
 
+    /// :nodoc:
     @discardableResult func trackDifference<K, T: Equatable>(actual: [K: T], expected: [K: T]) -> DiffableResult where T: Diffable {
         let diffResult = DiffableResult()
         defer { append(contentsOf: diffResult) }
@@ -166,6 +172,7 @@ extension DiffableResult {
 
 // MARK: - NSObject diffing
 
+    /// :nodoc:
     @discardableResult func trackDifference<K, T: NSObjectProtocol>(actual: [K: T], expected: [K: T]) -> DiffableResult {
         let diffResult = DiffableResult()
         defer { append(contentsOf: diffResult) }

diff --git a/SourceryRuntime/Sources/Extensions.swift b/SourceryRuntime/Sources/Extensions.swift
@@ -178,6 +178,7 @@ public extension String {
 }
 
 public extension NSString {
+    /// :nodoc:
     var entireRange: NSRange {
         return NSRange(location: 0, length: self.length)
     }

diff --git a/SourceryRuntime/Sources/TemplateContext.swift b/SourceryRuntime/Sources/TemplateContext.swift
@@ -83,7 +83,7 @@ extension ProcessInfo {
     /// :nodoc:
     public let types: [Type]
 
-    /// :nodoc:
+    /// All known typealiases
     public let typealiases: [Typealias]
 
     /// :nodoc:

diff --git a/SourceryRuntime/Sources/Type.swift b/SourceryRuntime/Sources/Type.swift
@@ -342,6 +342,7 @@ import Foundation
 extension Type {
 
     // sourcery: skipDescription, skipJSExport
+    /// :nodoc:
     var isClass: Bool {
         let isNotClass = self is Struct || self is Enum || self is Protocol
         return !isNotClass && !isExtension

diff --git a/SourcerySwift/Sources/SourceryRuntime.content.generated.swift b/SourcerySwift/Sources/SourceryRuntime.content.generated.swift
@@ -1192,6 +1192,7 @@ extension DiffableResult {
 
 #if swift(>=4.1)
 #else
+    /// :nodoc:
     @discardableResult func trackDifference<T: Equatable>(actual: T, expected: T) -> DiffableResult {
         if actual != expected {
             let result = DiffableResult(results: ["<expected: \\(expected), received: \\(actual)>"])
@@ -1201,6 +1202,7 @@ extension DiffableResult {
     }
 #endif
 
+    /// :nodoc:
     @discardableResult func trackDifference<T: Equatable>(actual: T?, expected: T?) -> DiffableResult {
         if actual != expected {
             let result = DiffableResult(results: ["<expected: \\(expected.map({ "\\($0)" }) ?? "nil"), received: \\(actual.map({ "\\($0)" }) ?? "nil")>"])
@@ -1209,12 +1211,14 @@ extension DiffableResult {
         return self
     }
 
+    /// :nodoc:
     @discardableResult func trackDifference<T: Equatable>(actual: T, expected: T) -> DiffableResult where T: Diffable {
         let diffResult = actual.diffAgainst(expected)
         append(contentsOf: diffResult)
         return self
     }
 
+    /// :nodoc:
     @discardableResult func trackDifference<T: Equatable>(actual: [T], expected: [T]) -> DiffableResult where T: Diffable {
         let diffResult = DiffableResult()
         defer { append(contentsOf: diffResult) }
@@ -1236,6 +1240,7 @@ extension DiffableResult {
         return self
     }
 
+    /// :nodoc:
     @discardableResult func trackDifference<T: Equatable>(actual: [T], expected: [T]) -> DiffableResult {
         let diffResult = DiffableResult()
         defer { append(contentsOf: diffResult) }
@@ -1253,6 +1258,7 @@ extension DiffableResult {
         return self
     }
 
+    /// :nodoc:
     @discardableResult func trackDifference<K, T: Equatable>(actual: [K: T], expected: [K: T]) -> DiffableResult where T: Diffable {
         let diffResult = DiffableResult()
         defer { append(contentsOf: diffResult) }
@@ -1290,6 +1296,7 @@ extension DiffableResult {
 
 // MARK: - NSObject diffing
 
+    /// :nodoc:
     @discardableResult func trackDifference<K, T: NSObjectProtocol>(actual: [K: T], expected: [K: T]) -> DiffableResult {
         let diffResult = DiffableResult()
         defer { append(contentsOf: diffResult) }
@@ -2042,6 +2049,7 @@ public extension String {
 }
 
 public extension NSString {
+    /// :nodoc:
     var entireRange: NSRange {
         return NSRange(location: 0, length: self.length)
     }
@@ -3391,7 +3399,7 @@ extension ProcessInfo {
     /// :nodoc:
     public let types: [Type]
 
-    /// :nodoc:
+    /// All known typealiases
     public let typealiases: [Typealias]
 
     /// :nodoc:
@@ -3916,6 +3924,7 @@ import Foundation
 extension Type {
 
     // sourcery: skipDescription, skipJSExport
+    /// :nodoc:
     var isClass: Bool {
         let isNotClass = self is Struct || self is Enum || self is Protocol
         return !isNotClass && !isExtension

diff --git a/docs/Classes/AssociatedValue.html b/docs/Classes/AssociatedValue.html
@@ -284,6 +284,33 @@ <h4>Declaration</h4>
                     </section>
                   </div>
                 </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/c:@M@SourceryRuntime@objc(cs)AssociatedValue(py)defaultValue"></a>
+                    <a name="//apple_ref/swift/Property/defaultValue" class="dashAnchor"></a>
+                    <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)AssociatedValue(py)defaultValue">defaultValue</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Associated value default value</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="k">let</span> <span class="nv">defaultValue</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
                 <li class="item">
                   <div>
                     <code>

diff --git a/docs/Classes/EnumCase.html b/docs/Classes/EnumCase.html
@@ -282,6 +282,33 @@ <h4>Declaration</h4>
                     </section>
                   </div>
                 </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/c:@M@SourceryRuntime@objc(cs)EnumCase(py)indirect"></a>
+                    <a name="//apple_ref/swift/Property/indirect" class="dashAnchor"></a>
+                    <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)EnumCase(py)indirect">indirect</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Whether enum case is indirect</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="k">let</span> <span class="nv">indirect</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
                 <li class="item">
                   <div>
                     <code>