Sources/AmiiboService/Public/Clients/AmiiboLiveClient.swift

@@ -37,11 +37,16 @@ public struct AmiiboLiveClient {
 }
 
 // MARK: - APIClient
+// TODO: Remove the documentation from the functions inside the following extension as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?).
 
 extension AmiiboLiveClient: APIClient {
 
     // MARK: Functions
     
+    /// Gets a list of amiibo items based on a given filter.
+    /// - Parameter filter: A filter to remove unwanted items from the result.
+    /// - Returns: A list of filtered amiibo items.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
     public func getAmiibos(
         by filter: AmiiboFilter
     ) async throws(AmiiboServiceError) -> [Amiibo] {
@@ -85,6 +90,10 @@ extension AmiiboLiveClient: APIClient {
         }
     }
 
+    /// Gets a list of amiibo series based on a given filter.
+    /// - Parameter filter: A filter to remove unwanted items from the result.
+    /// - Returns: A list of filtered amiibo series.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
     public func getAmiiboSeries(
         by filter: AmiiboSeriesFilter
     ) async throws(AmiiboServiceError) -> [AmiiboSeries] {
@@ -122,6 +131,10 @@ extension AmiiboLiveClient: APIClient {
         }
     }
  
+    /// Gets a list of amiibo types based on a given filter.
+    /// - Parameter filter: A filter to remove unwanted items from the result.
+    /// - Returns: A list of filtered amiibo types.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
     public func getAmiiboTypes(
         by filter: AmiiboTypeFilter
     ) async throws(AmiiboServiceError) -> [AmiiboType] {
@@ -159,6 +172,10 @@ extension AmiiboLiveClient: APIClient {
         }
     }
 
+    /// Gets a list of game characters based on a given filter.
+    /// - Parameter filter: A filter to remove unwanted items from the result.
+    /// - Returns: A list of filtered game characters.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
     public func getGameCharacters(
         by filter: GameCharacterFilter
     ) async throws(AmiiboServiceError) -> [GameCharacter] {
@@ -196,6 +213,10 @@ extension AmiiboLiveClient: APIClient {
         }
     }
 
+    /// Gets a list of game series based on a given filter.
+    /// - Parameter filter: A filter to remove unwanted items from the result.
+    /// - Returns: A list of filtered game series.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
     public func getGameSeries(
         by filter: GameSeriesFilter
     ) async throws(AmiiboServiceError) -> [GameSeries] {
@@ -233,6 +254,9 @@ extension AmiiboLiveClient: APIClient {
         }
     }
 
+    /// Gets the date when the data was last updated.
+    /// - Returns: A last updated date.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
     public func getLastUpdated() async throws(AmiiboServiceError) -> Date {
         let response: Operations.getLastUpdated.Output
 

Sources/AmiiboService/Public/Clients/AmiiboMockClient.swift

@@ -70,11 +70,16 @@ public struct AmiiboMockClient {
 }
 
 // MARK: - APIClient
+// TODO: Remove the documentation from the functions inside the following extension as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?).
 
 extension AmiiboMockClient: APIClient {
     
     // MARK: Functions
 
+    /// Gets a list of amiibo items based on a given filter.
+    /// - Parameter filter: A filter to remove unwanted items from the result.
+    /// - Returns: A list of filtered amiibo items.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
     public func getAmiibos(by filter: AmiiboFilter) async throws(AmiiboServiceError) -> [Amiibo] {
         try throwErrorIfExists()
 
@@ -85,6 +90,10 @@ extension AmiiboMockClient: APIClient {
         return amiibos
     }
 
+    /// Gets a list of amiibo series based on a given filter.
+    /// - Parameter filter: A filter to remove unwanted items from the result.
+    /// - Returns: A list of filtered amiibo series.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
     public func getAmiiboSeries(by filter: AmiiboSeriesFilter) async throws(AmiiboServiceError) -> [AmiiboSeries] {
         try throwErrorIfExists()
 
@@ -95,6 +104,10 @@ extension AmiiboMockClient: APIClient {
         return amiiboSeries
     }
 
+    /// Gets a list of amiibo types based on a given filter.
+    /// - Parameter filter: A filter to remove unwanted items from the result.
+    /// - Returns: A list of filtered amiibo types.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
     public func getAmiiboTypes(by filter: AmiiboTypeFilter) async throws(AmiiboServiceError) -> [AmiiboType] {
         try throwErrorIfExists()
 
@@ -105,6 +118,10 @@ extension AmiiboMockClient: APIClient {
         return amiiboTypes
     }
 
+    /// Gets a list of game characters based on a given filter.
+    /// - Parameter filter: A filter to remove unwanted items from the result.
+    /// - Returns: A list of filtered game characters.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
     public func getGameCharacters(by filter: GameCharacterFilter) async throws(AmiiboServiceError) -> [GameCharacter] {
         try throwErrorIfExists()
 
@@ -115,6 +132,10 @@ extension AmiiboMockClient: APIClient {
         return gameCharacters
     }
 
+    /// Gets a list of game series based on a given filter.
+    /// - Parameter filter: A filter to remove unwanted items from the result.
+    /// - Returns: A list of filtered game series.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
     public func getGameSeries(by filter: GameSeriesFilter) async throws(AmiiboServiceError) -> [GameSeries] {
         try throwErrorIfExists()
 
@@ -125,6 +146,9 @@ extension AmiiboMockClient: APIClient {
         return gameSeries
     }
 
+    /// Gets the date when the data was last updated.
+    /// - Returns: A last updated date.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
     public func getLastUpdated() async throws(AmiiboServiceError) -> Date {
         try throwErrorIfExists()