Documented the Amiibo model and its sub-models in the library target.

2025-09-09 11:06:34 +02:00
parent aaa0a7835e
commit 93afbb2c1e
6 changed files with 71 additions and 9 deletions
@@ -13,17 +13,27 @@
 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: Initialisers
-        
+        // 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