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>

Sources/AmiiboService/Public/Models/Amiibo.swift

@@ -0,0 +1,83 @@
+//===----------------------------------------------------------------------===
+//
+// 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
+//
+//===----------------------------------------------------------------------===
+
+import Foundation
+
+/// A model that represents an amiibo item.
+public struct Amiibo: Sendable {
+    
+    // MARK: Properties
+    
+    /// A game character.
+    public let gameCharacter: String
+    
+    /// A game series.
+    public let gameSeries: String
+
+    /// The first 8 hexadecimal characters of an identifier.
+    public let head: String
+    
+    /// An image link.
+    public let image: String
+
+    /// An amiibo name.
+    public let name: String
+
+    /// A game platform type, if any.
+    public let platform: Platform?
+    
+    /// A release date.
+    public let release: Release
+
+    /// An amiibo series.
+    public let series: String
+    
+    /// The last 8 hexadecimal characters of an identifier.
+    public let tail: String
+    
+    /// An amiibo type.
+    public let type: String
+    
+    // MARK: Initializers
+    
+    /// Initializes this model from a given payload.
+    /// - Parameter payload: A payload that contains the values for the model.
+    init(_ payload: Components.Schemas.Amiibo) {
+        self.gameCharacter = payload.character
+        self.gameSeries = payload.gameSeries
+        self.head = payload.head
+        self.image = payload.image
+        self.name = payload.name
+        self.platform = .init(
+            payload.gamesSwitch,
+            payload.games3DS,
+            payload.gamesWiiU
+        )
+        self.release = .init(payload.release)
+        self.series = payload.amiiboSeries
+        self.tail = payload.tail
+        self.type = payload._type
+    }
+    
+    // MARK: Computed
+    
+    /// An identifier.
+    public var identifier: String {
+        head + tail
+    }
+    
+    /// A URL related to an image link, if any.
+    public var imageURL: URL? {
+        .init(string: image)
+    }
+
+}

Sources/AmiiboService/Public/Models/Amiibo/Amiibo+Game.swift

@@ -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) }
+            }()
+        }
+        
+    }
+}

Sources/AmiiboService/Public/Models/Amiibo/Amiibo+Platform.swift

@@ -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) }
+            }()
+        }
+
+    }
+}

Sources/AmiiboService/Public/Models/Amiibo/Amiibo+Release.swift

@@ -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
+//
+//===----------------------------------------------------------------------===
+
+import Foundation
+
+extension Amiibo {
+    /// A model that represents a collection of release dates related to an amiibo item.
+    public struct Release: Sendable {
+        
+        // MARK: Properties
+        
+        /// A release date for North America, if any.
+        public let america: Date?
+
+        /// A release date for Australia, if any.
+        public let australia: Date?
+
+        /// A release date for Europe, if any.
+        public let europe: Date?
+
+        /// A release date for Japan, if any.
+        public let japan: Date?
+        
+        // MARK: Initializers
+
+        /// Initializes this model from a given payload.
+        /// - Parameter payload: A payload that contains the values for the model.
+        init(_ payload: Components.Schemas.AmiiboRelease) {
+            self.america = payload.na
+            self.australia = payload.au
+            self.europe = payload.eu
+            self.japan = payload.jp
+        }
+        
+    }
+}

Sources/AmiiboService/Public/Models/Amiibo/Amiibo+Usage.swift

@@ -0,0 +1,35 @@
+//===----------------------------------------------------------------------===
+//
+// 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 the usage of an amiibo item within a certain game.
+    public struct Usage: Sendable {
+        
+        // MARK: Properties
+        
+        /// An explanation of how to use an amiibo item.
+        public let explanation: String
+        
+        /// A flag that indicates whether an amiibo item can save game data in it.
+        public let isWriteable: Bool
+        
+        // MARK: Initializers
+
+        /// Initializes this model from a given payload.
+        /// - Parameter payload: A payload that contains the values for the model.
+        init(_ payload: Components.Schemas.AmiiboUsage) {
+            self.explanation = payload.Usage
+            self.isWriteable = payload.write
+        }
+        
+    }
+}

Sources/AmiiboService/Public/Models/AmiiboSeries.swift

@@ -0,0 +1,33 @@
+//===----------------------------------------------------------------------===
+//
+// 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
+//
+//===----------------------------------------------------------------------===
+
+/// A model that represents an amiibo series.
+public struct AmiiboSeries: KeyNameModel {
+    
+    // TODO: Remove the documentation from the properties of this type as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?).
+    
+    // MARK: Properties
+
+    /// A key.
+    public let key: String
+
+    /// A name.
+    public let name: String
+    
+    // MARK: Initializers
+    
+    init(_ payload: Components.Schemas.Tuple) {
+        self.key = payload.key
+        self.name = payload.name
+    }
+    
+}

Sources/AmiiboService/Public/Models/AmiiboType.swift

@@ -0,0 +1,33 @@
+//===----------------------------------------------------------------------===
+//
+// 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
+//
+//===----------------------------------------------------------------------===
+
+/// A model that represents an amiibo type.
+public struct AmiiboType: KeyNameModel {
+
+    // TODO: Remove the documentation from the properties of this type as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?).
+
+    // MARK: Properties
+
+    /// A key.
+    public let key: String
+
+    /// A name.
+    public let name: String
+    
+    // MARK: Initializers
+    
+    init(_ payload: Components.Schemas.Tuple) {
+        self.key = payload.key
+        self.name = payload.name
+    }
+    
+}

Sources/AmiiboService/Public/Models/GameCharacter.swift

@@ -0,0 +1,33 @@
+//===----------------------------------------------------------------------===
+//
+// 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
+//
+//===----------------------------------------------------------------------===
+
+/// A model that represents a game character.
+public struct GameCharacter: KeyNameModel {
+
+    // TODO: Remove the documentation from the properties of this type as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?).
+
+    // MARK: Properties
+
+    /// A key.
+    public let key: String
+
+    /// A name.
+    public let name: String
+    
+    // MARK: Initializers
+    
+    init(_ payload: Components.Schemas.Tuple) {
+        self.key = payload.key
+        self.name = payload.name
+    }
+    
+}

Sources/AmiiboService/Public/Models/GameSeries.swift

@@ -0,0 +1,33 @@
+//===----------------------------------------------------------------------===
+//
+// 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
+//
+//===----------------------------------------------------------------------===
+
+/// A model that represents a game series.
+public struct GameSeries: KeyNameModel {
+
+    // TODO: Remove the documentation from the properties of this type as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?).
+
+    // MARK: Properties
+
+    /// A key.
+    public let key: String
+
+    /// A name.
+    public let name: String
+    
+    // MARK: Initializers
+    
+    init(_ payload: Components.Schemas.Tuple) {
+        self.key = payload.key
+        self.name = payload.name
+    }
+    
+}