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,45 @@
+//===----------------------------------------------------------------------===
+//
+// 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 game related to an amiibo item.
+    public struct Game: Sendable {
+        
+        // MARK: Properties
+        
+        /// A list of identifiers.
+        public let identifiers: [String]
+        
+        /// A name.
+        public let name: String
+        
+        /// A list of amiibo usages, if any.
+        public let usages: [Usage]?
+        
+        // MARK: Initializers
+
+        /// Initializes this model from a given payload.
+        /// - Parameter payload: A payload that contains the values for the model.
+        init(_ payload: Components.Schemas.AmiiboGame) {
+            self.identifiers = payload.gameID
+            self.name = payload.gameName
+            self.usages = {
+                guard let usages = payload.amiiboUsage else {
+                    return nil
+                }
+                
+                return usages.map { .init($0) }
+            }()
+        }
+        
+    }
+}