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
@@ -11,15 +11,21 @@
 //===----------------------------------------------------------------------===

 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: 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.AmiiboUsage) {
            self.explanation = payload.Usage
            self.isWriteable = payload.write