Patched (temporarily) the DocC documentation (#8)

This PR contains the work done to: * Documented the public properties, initializers, and/or functions of those types conforming to the `APIClient`, `KeyNameFilter`, and `KeyNameModel` protocols, to fix the issue that the protocol documentations cannot be inherited; * Moved the `AmiiboService` DocC documentation catalog inside the library target; * Amended the folder structure of the library and test targets; * Fixed further documentation issues encountered while revising the written documentation; * Added the `lib-test` task in the `Makefile` file; * Improved the naming for the existing tasks in the `Makefile` file. Reviewed-on: #8 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-09-10 19:47:45 +00:00
parent b39fd8533b
commit 0af0e3056d
147 changed files with 290 additions and 173 deletions
@@ -0,0 +1,65 @@
+//===----------------------------------------------------------------------===
+//
+// This source file is part of the AmiiboService open source project
+//
+// Copyright (c) 2024-2025 Röck+Cöde VoF. and the AmiiboAPI project authors
+// Licensed under the EUPL 1.2 or later.
+//
+// See LICENSE for license information
+// See CONTRIBUTORS for the list of AmiiboAPI project authors
+//
+//===----------------------------------------------------------------------===
+
+extension Amiibo {
+    /// A model that represents a collection of `WiiU`, `3DS`, and `Switch` games related to an amiibo item.
+    public struct Platform: Sendable {
+        
+        // MARK: Properties
+        
+        /// A list of `Switch` games related to an amiibo item.
+        public let `switch`: [Game]
+
+        /// A list of `3DS` games related to an amiibo item.
+        public let threeDS: [Game]
+        
+        /// A list of `WiiU` games related to an amiibo item.
+        public let wiiU: [Game]
+        
+        // MARK: Initialisers
+        
+        /// Initializes this model.
+        ///
+        /// > important: In case no data is provided, then an instance of this model is not created.
+        ///
+        /// - Parameters:
+        ///   - switch: A list of `Switch` games related to an amiibo item, if any.
+        ///   - threeDS: A list of `3DS` games related to an amiibo item, if any.
+        ///   - wiiU: A list of `WiiU` games related to an amiibo item, if any.
+        init?(
+            _ `switch`: [Components.Schemas.AmiiboGame]?,
+            _ threeDS: [Components.Schemas.AmiiboGame]?,
+            _ wiiU: [Components.Schemas.AmiiboGame]?
+        ) {
+            guard (`switch` != nil && `switch`?.isEmpty == false)
+                    || (threeDS != nil && threeDS?.isEmpty == false)
+                    || (wiiU != nil && wiiU?.isEmpty == false)
+            else {
+                return nil
+            }
+            
+            self.switch = {
+                guard let `switch` else { return [] }
+                return `switch`.map { .init($0) }
+            }()
+            self.threeDS = {
+                guard let threeDS else { return [] }
+                return threeDS.map { .init($0) }
+            }()
+            self.wiiU = {
+                guard let wiiU else { return [] }
+                return wiiU.map { .init($0) }
+            }()
+        }
+
+    }
+}