Fix DocC error

adamayoung · Nov 19, 2024 · 8153637 · 8153637
1 parent cb3f00e
commit 8153637
Show file tree

Hide file tree

Showing 16 changed files with 67 additions and 43 deletions.
diff --git a/Package.resolved b/Package.resolved
@@ -0,0 +1,24 @@
+{
+  "originHash" : "30be1a8795d91fbccb4a904ab667609855569d33f57038fec1ba246343472f40",
+  "pins" : [
+    {
+      "identity" : "swift-docc-plugin",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/apple/swift-docc-plugin.git",
+      "state" : {
+        "revision" : "85e4bb4e1cd62cec64a4b8e769dcefdf0c5b9d64",
+        "version" : "1.4.3"
+      }
+    },
+    {
+      "identity" : "swift-docc-symbolkit",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/swiftlang/swift-docc-symbolkit",
+      "state" : {
+        "revision" : "b45d1f2ed151d057b54504d653e0da5552844e34",
+        "version" : "1.0.0"
+      }
+    }
+  ],
+  "version" : 3
+}
diff --git a/Sources/TMDb/Domain/Models/Company.swift b/Sources/TMDb/Domain/Models/Company.swift
@@ -122,9 +122,9 @@ extension Company {
     ///
     /// - Parameter decoder: The decoder to read data from.
     ///
-    /// - Throws: ``DecodingError.typeMismatch`` if the encountered encoded value is not convertible to the requested type.
-    /// - Throws: ``DecodingError.keyNotFound`` if self does not have an entry for the given key.
-    /// - Throws: ``DecodingError.valueNotFound`` if self has a null entry for the given key.
+    /// - Throws: `DecodingError.typeMismatch` if the encountered encoded value is not convertible to the requested type.
+    /// - Throws: `DecodingError.keyNotFound` if self does not have an entry for the given key.
+    /// - Throws: `DecodingError.valueNotFound` if self has a null entry for the given key.
     ///
     public init(from decoder: any Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)

diff --git a/Sources/TMDb/Domain/Models/Gender.swift b/Sources/TMDb/Domain/Models/Gender.swift
@@ -52,9 +52,9 @@ public enum Gender: Int, Codable, Equatable, Hashable, Sendable {
     ///
     /// - Parameter decoder: The decoder to read data from.
     ///
-    /// - Throws: ``DecodingError.typeMismatch`` if the encountered encoded value is not convertible to the requested type.
-    /// - Throws: ``DecodingError.keyNotFound`` if self does not have an entry for the given key.
-    /// - Throws: ``DecodingError.valueNotFound`` if self has a null entry for the given key.
+    /// - Throws: `DecodingError.typeMismatch` if the encountered encoded value is not convertible to the requested type.
+    /// - Throws: `DecodingError.keyNotFound` if self does not have an entry for the given key.
+    /// - Throws: `DecodingError.valueNotFound` if self has a null entry for the given key.
     ///
     public init(from decoder: Decoder) throws {
         self =

diff --git a/Sources/TMDb/Domain/Models/Media.swift b/Sources/TMDb/Domain/Models/Media.swift
@@ -77,9 +77,9 @@ extension Media {
     ///
     /// - Parameter decoder: The decoder to read data from.
     ///
-    /// - Throws: ``DecodingError.typeMismatch`` if the encountered encoded value is not convertible to the requested type.
-    /// - Throws: ``DecodingError.keyNotFound`` if self does not have an entry for the given key.
-    /// - Throws: ``DecodingError.valueNotFound`` if self has a null entry for the given key.
+    /// - Throws: `DecodingError.typeMismatch` if the encountered encoded value is not convertible to the requested type.
+    /// - Throws: `DecodingError.keyNotFound` if self does not have an entry for the given key.
+    /// - Throws: `DecodingError.valueNotFound` if self has a null entry for the given key.
     ///
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)

diff --git a/Sources/TMDb/Domain/Models/Movie.swift b/Sources/TMDb/Domain/Models/Movie.swift
@@ -268,9 +268,9 @@ extension Movie {
     ///
     /// - Parameter decoder: The decoder to read data from.
     ///
-    /// - Throws: ``DecodingError.typeMismatch`` if the encountered encoded value is not convertible to the requested type.
-    /// - Throws: ``DecodingError.keyNotFound`` if self does not have an entry for the given key.
-    /// - Throws: ``DecodingError.valueNotFound`` if self has a null entry for the given key.
+    /// - Throws: `DecodingError.typeMismatch` if the encountered encoded value is not convertible to the requested type.
+    /// - Throws: `DecodingError.keyNotFound` if self does not have an entry for the given key.
+    /// - Throws: `DecodingError.valueNotFound` if self has a null entry for the given key.
     ///
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)

diff --git a/Sources/TMDb/Domain/Models/MovieExternalLinksCollection.swift b/Sources/TMDb/Domain/Models/MovieExternalLinksCollection.swift
@@ -102,9 +102,9 @@ extension MovieExternalLinksCollection {
     ///
     /// - Parameter decoder: The decoder to read data from.
     ///
-    /// - Throws: ``DecodingError.typeMismatch`` if the encountered encoded value is not convertible to the requested type.
-    /// - Throws: ``DecodingError.keyNotFound`` if self does not have an entry for the given key.
-    /// - Throws: ``DecodingError.valueNotFound`` if self has a null entry for the given key.
+    /// - Throws: `DecodingError.typeMismatch` if the encountered encoded value is not convertible to the requested type.
+    /// - Throws: `DecodingError.keyNotFound` if self does not have an entry for the given key.
+    /// - Throws: `DecodingError.valueNotFound` if self has a null entry for the given key.
     ///
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)

diff --git a/Sources/TMDb/Domain/Models/MovieListItem.swift b/Sources/TMDb/Domain/Models/MovieListItem.swift
@@ -178,9 +178,9 @@ extension MovieListItem {
     ///
     /// - Parameter decoder: The decoder to read data from.
     ///
-    /// - Throws: ``DecodingError.typeMismatch`` if the encountered encoded value is not convertible to the requested type.
-    /// - Throws: ``DecodingError.keyNotFound`` if self does not have an entry for the given key.
-    /// - Throws: ``DecodingError.valueNotFound`` if self has a null entry for the given key.
+    /// - Throws: `DecodingError.typeMismatch` if the encountered encoded value is not convertible to the requested type.
+    /// - Throws: `DecodingError.keyNotFound` if self does not have an entry for the given key.
+    /// - Throws: `DecodingError.valueNotFound` if self has a null entry for the given key.
     ///
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)

diff --git a/Sources/TMDb/Domain/Models/Person.swift b/Sources/TMDb/Domain/Models/Person.swift
@@ -167,9 +167,9 @@ extension Person {
     ///
     /// - Parameter decoder: The decoder to read data from.
     ///
-    /// - Throws: ``DecodingError.typeMismatch`` if the encountered encoded value is not convertible to the requested type.
-    /// - Throws: ``DecodingError.keyNotFound`` if self does not have an entry for the given key.
-    /// - Throws: ``DecodingError.valueNotFound`` if self has a null entry for the given key.
+    /// - Throws: `DecodingError.typeMismatch` if the encountered encoded value is not convertible to the requested type.
+    /// - Throws: `DecodingError.keyNotFound` if self does not have an entry for the given key.
+    /// - Throws: `DecodingError.valueNotFound` if self has a null entry for the given key.
     ///
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)

diff --git a/Sources/TMDb/Domain/Models/PersonExternalLinksCollection.swift b/Sources/TMDb/Domain/Models/PersonExternalLinksCollection.swift
@@ -111,9 +111,9 @@ extension PersonExternalLinksCollection {
     ///
     /// - Parameter decoder: The decoder to read data from.
     ///
-    /// - Throws: ``DecodingError.typeMismatch`` if the encountered encoded value is not convertible to the requested type.
-    /// - Throws: ``DecodingError.keyNotFound`` if self does not have an entry for the given key.
-    /// - Throws: ``DecodingError.valueNotFound`` if self has a null entry for the given key.
+    /// - Throws: `DecodingError.typeMismatch` if the encountered encoded value is not convertible to the requested type.
+    /// - Throws: `DecodingError.keyNotFound` if self does not have an entry for the given key.
+    /// - Throws: `DecodingError.valueNotFound` if self has a null entry for the given key.
     ///
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)

diff --git a/Sources/TMDb/Domain/Models/Show.swift b/Sources/TMDb/Domain/Models/Show.swift
@@ -94,9 +94,9 @@ extension Show {
     ///
     /// - Parameter decoder: The decoder to read data from.
     ///
-    /// - Throws: ``DecodingError.typeMismatch`` if the encountered encoded value is not convertible to the requested type.
-    /// - Throws: ``DecodingError.keyNotFound`` if self does not have an entry for the given key.
-    /// - Throws: ``DecodingError.valueNotFound`` if self has a null entry for the given key.
+    /// - Throws: `DecodingError.typeMismatch` if the encountered encoded value is not convertible to the requested type.
+    /// - Throws: `DecodingError.keyNotFound` if self does not have an entry for the given key.
+    /// - Throws: `DecodingError.valueNotFound` if self has a null entry for the given key.
     ///
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)

diff --git a/Sources/TMDb/Domain/Models/TVSeries.swift b/Sources/TMDb/Domain/Models/TVSeries.swift
@@ -295,9 +295,9 @@ extension TVSeries {
     ///
     /// - Parameter decoder: The decoder to read data from.
     ///
-    /// - Throws: ``DecodingError.typeMismatch`` if the encountered encoded value is not convertible to the requested type.
-    /// - Throws: ``DecodingError.keyNotFound`` if self does not have an entry for the given key.
-    /// - Throws: ``DecodingError.valueNotFound`` if self has a null entry for the given key.
+    /// - Throws: `DecodingError.typeMismatch` if the encountered encoded value is not convertible to the requested type.
+    /// - Throws: `DecodingError.keyNotFound` if self does not have an entry for the given key.
+    /// - Throws: `DecodingError.valueNotFound` if self has a null entry for the given key.
     ///
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)

diff --git a/Sources/TMDb/Domain/Models/TVSeriesExternalLinksCollection.swift b/Sources/TMDb/Domain/Models/TVSeriesExternalLinksCollection.swift
@@ -103,9 +103,9 @@ extension TVSeriesExternalLinksCollection {
     ///
     /// - Parameter decoder: The decoder to read data from.
     ///
-    /// - Throws: ``DecodingError.typeMismatch`` if the encountered encoded value is not convertible to the requested type.
-    /// - Throws: ``DecodingError.keyNotFound`` if self does not have an entry for the given key.
-    /// - Throws: ``DecodingError.valueNotFound`` if self has a null entry for the given key.
+    /// - Throws: `DecodingError.typeMismatch` if the encountered encoded value is not convertible to the requested type.
+    /// - Throws: `DecodingError.keyNotFound` if self does not have an entry for the given key.
+    /// - Throws: `DecodingError.valueNotFound` if self has a null entry for the given key.
     ///
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)

diff --git a/Sources/TMDb/Domain/Models/TVSeriesListItem.swift b/Sources/TMDb/Domain/Models/TVSeriesListItem.swift
@@ -178,9 +178,9 @@ extension TVSeriesListItem {
     ///
     /// - Parameter decoder: The decoder to read data from.
     ///
-    /// - Throws: ``DecodingError.typeMismatch`` if the encountered encoded value is not convertible to the requested type.
-    /// - Throws: ``DecodingError.keyNotFound`` if self does not have an entry for the given key.
-    /// - Throws: ``DecodingError.valueNotFound`` if self has a null entry for the given key.
+    /// - Throws: `DecodingError.typeMismatch` if the encountered encoded value is not convertible to the requested type.
+    /// - Throws: `DecodingError.keyNotFound` if self does not have an entry for the given key.
+    /// - Throws: `DecodingError.valueNotFound` if self has a null entry for the given key.
     ///
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)

diff --git a/Sources/TMDb/Domain/Models/VideoSize.swift b/Sources/TMDb/Domain/Models/VideoSize.swift
@@ -57,9 +57,9 @@ public enum VideoSize: Int, Codable, Equatable, Hashable, Sendable {
     ///
     /// - Parameter decoder: The decoder to read data from.
     ///
-    /// - Throws: ``DecodingError.typeMismatch`` if the encountered encoded value is not convertible to the requested type.
-    /// - Throws: ``DecodingError.keyNotFound`` if self does not have an entry for the given key.
-    /// - Throws: ``DecodingError.valueNotFound`` if self has a null entry for the given key.
+    /// - Throws: `DecodingError.typeMismatch` if the encountered encoded value is not convertible to the requested type.
+    /// - Throws: `DecodingError.keyNotFound` if self does not have an entry for the given key.
+    /// - Throws: `DecodingError.valueNotFound` if self has a null entry for the given key.
     ///
     public init(from decoder: Decoder) throws {
         self =

diff --git a/Sources/TMDb/Domain/Models/VideoType.swift b/Sources/TMDb/Domain/Models/VideoType.swift
@@ -72,9 +72,9 @@ public enum VideoType: String, Codable, Equatable, Hashable, Sendable {
     ///
     /// - Parameter decoder: The decoder to read data from.
     ///
-    /// - Throws: ``DecodingError.typeMismatch`` if the encountered encoded value is not convertible to the requested type.
-    /// - Throws: ``DecodingError.keyNotFound`` if self does not have an entry for the given key.
-    /// - Throws: ``DecodingError.valueNotFound`` if self has a null entry for the given key.
+    /// - Throws: `DecodingError.typeMismatch` if the encountered encoded value is not convertible to the requested type.
+    /// - Throws: `DecodingError.keyNotFound` if self does not have an entry for the given key.
+    /// - Throws: `DecodingError.valueNotFound` if self has a null entry for the given key.
     ///
     public init(from decoder: Decoder) throws {
         self =

diff --git a/Sources/TMDb/Networking/HTTPClient/HTTPClient.swift b/Sources/TMDb/Networking/HTTPClient/HTTPClient.swift
@@ -29,7 +29,7 @@ public protocol HTTPClient: Sendable {
     ///
     /// - Parameter request: The HTTP request.
     ///
-    /// - Throws: ``Error``.
+    /// - Throws: `Error`.
     ///
     /// - Returns: An HTTP response object.
     ///