From 8153637a0e6b072fc234a9b50686a56a6649ddda Mon Sep 17 00:00:00 2001 From: Adam Young Date: Tue, 19 Nov 2024 14:47:38 +0000 Subject: [PATCH] Fix DocC error --- Package.resolved | 24 +++++++++++++++++++ Sources/TMDb/Domain/Models/Company.swift | 6 ++--- Sources/TMDb/Domain/Models/Gender.swift | 6 ++--- Sources/TMDb/Domain/Models/Media.swift | 6 ++--- Sources/TMDb/Domain/Models/Movie.swift | 6 ++--- .../Models/MovieExternalLinksCollection.swift | 6 ++--- .../TMDb/Domain/Models/MovieListItem.swift | 6 ++--- Sources/TMDb/Domain/Models/Person.swift | 6 ++--- .../PersonExternalLinksCollection.swift | 6 ++--- Sources/TMDb/Domain/Models/Show.swift | 6 ++--- Sources/TMDb/Domain/Models/TVSeries.swift | 6 ++--- .../TVSeriesExternalLinksCollection.swift | 6 ++--- .../TMDb/Domain/Models/TVSeriesListItem.swift | 6 ++--- Sources/TMDb/Domain/Models/VideoSize.swift | 6 ++--- Sources/TMDb/Domain/Models/VideoType.swift | 6 ++--- .../Networking/HTTPClient/HTTPClient.swift | 2 +- 16 files changed, 67 insertions(+), 43 deletions(-) create mode 100644 Package.resolved diff --git a/Package.resolved b/Package.resolved new file mode 100644 index 00000000..fdac643d --- /dev/null +++ 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 index 294094cf..93ab4ed7 100644 --- 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 index ab83620a..ac4ea7c1 100644 --- 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 index 0404292e..823bbeca 100644 --- 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 index 1b6e068d..e9243b1a 100644 --- 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 index d8a61bac..b5fe9d85 100644 --- 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 index a319d5ad..cd8deac6 100644 --- 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 index 0ae0990f..305ec32a 100644 --- 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 index c924b62f..57b01c03 100644 --- 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 index 8a0a3692..7daac993 100644 --- 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 index 79948050..b4810f89 100644 --- 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 index 33e42f5c..332f1577 100644 --- 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 index cd061dc8..f41ea3f3 100644 --- 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 index 87b58f1e..11f85140 100644 --- 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 index 18c8c540..f861ba13 100644 --- 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 index 7d9002bd..d5fa20df 100644 --- 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. ///