rock-n-code/amiibo-service
1
0
Fork 0
Code Issues Pull Requests Actions Releases 15 Activity

Improved the documentation for the Amiibo types in the library target.

Browse Source
This commit is contained in:
Javier Cicchelli
2025-11-09 21:06:52 +01:00
parent adaedcda07
commit d2146febc0
5 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/AmiiboService/Public/Models/Amiibo.swift
+1 -1
View File
@@ -14,7 +14,7 @@
import Foundation import Foundation
/// A model that represents an amiibo item. /// A model that represents an amiibo.
public struct Amiibo: Sendable { public struct Amiibo: Sendable {
// MARK: Properties // MARK: Properties
Sources/AmiiboService/Public/Models/Amiibo/Amiibo+Game.swift
+1 -1
View File
@@ -13,7 +13,7 @@
// ===----------------------------------------------------------------------=== // ===----------------------------------------------------------------------===
extension Amiibo { extension Amiibo {
/// A model that represents a game related to an amiibo item. /// A model that represents a game related to an amiibo.
public struct Game: Sendable { public struct Game: Sendable {
// MARK: Properties // MARK: Properties
Sources/AmiiboService/Public/Models/Amiibo/Amiibo+Platform.swift
+8 -8
View File
@@ -13,34 +13,34 @@
// ===----------------------------------------------------------------------=== // ===----------------------------------------------------------------------===
extension Amiibo { extension Amiibo {
/// A model that represents a collection of `WiiU`, `3DS`, and `Switch` games related to an amiibo item. /// A model that represents a collection of `Switch`, `Switch 2`, `3DS`, and `WiiU` games related to an amiibo.
public struct Platform: Sendable { public struct Platform: Sendable {
// MARK: Properties // MARK: Properties
/// A list of `Switch` games related to an amiibo item. /// A list of `Switch` games related to an amiibo.
public let `switch`: [Game] public let `switch`: [Game]
/// A list of `Switch 2` games related to an amiibo. /// A list of `Switch 2` games related to an amiibo.
public let switch2: [Game] public let switch2: [Game]
/// A list of `3DS` games related to an amiibo item. /// A list of `3DS` games related to an amiibo.
public let threeDS: [Game] public let threeDS: [Game]
/// A list of `WiiU` games related to an amiibo item. /// A list of `WiiU` games related to an amiibo.
public let wiiU: [Game] public let wiiU: [Game]
// MARK: Initialisers // MARK: Initializers
/// Initializes this model. /// Initializes this model.
/// ///
/// > important: In case no data is provided, then an instance of this model is not created. /// > important: In case no data is provided, then an instance of this model is not created.
/// ///
/// - Parameters: /// - Parameters:
/// - switch: A list of `Switch` games related to an amiibo item, if any. /// - switch: A list of `Switch` games related to an amiibo, 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.
/// - switch2: A list of `Switch 2` games related to an amiibo, if any. /// - switch2: A list of `Switch 2` games related to an amiibo, if any.
/// - threeDS: A list of `3DS` games related to an amiibo, if any.
/// - wiiU: A list of `WiiU` games related to an amiibo, if any.
init?( init?(
_ `switch`: [Components.Schemas.AmiiboGame]?, _ `switch`: [Components.Schemas.AmiiboGame]?,
_ switch2: [Components.Schemas.AmiiboGame]?, _ switch2: [Components.Schemas.AmiiboGame]?,
Sources/AmiiboService/Public/Models/Amiibo/Amiibo+Release.swift
+1 -1
View File
@@ -15,7 +15,7 @@
import Foundation import Foundation
extension Amiibo { extension Amiibo {
/// A model that represents a collection of release dates related to an amiibo item. /// A model that represents a collection of release dates related to an amiibo.
public struct Release: Sendable { public struct Release: Sendable {
// MARK: Properties // MARK: Properties
Sources/AmiiboService/Public/Models/Amiibo/Amiibo+Usage.swift
+3 -3
View File
@@ -13,15 +13,15 @@
// ===----------------------------------------------------------------------=== // ===----------------------------------------------------------------------===
extension Amiibo { extension Amiibo {
/// A model that represents the usage of an amiibo item within a certain game. /// A model that represents the usage of an amiibo within a certain game.
public struct Usage: Sendable { public struct Usage: Sendable {
// MARK: Properties // MARK: Properties
/// An explanation of how to use an amiibo item. /// An explanation of how to use an amiibo.
public let explanation: String public let explanation: String
/// A flag that indicates whether an amiibo item can save game data in it. /// A flag that indicates whether an amiibo can save game data in it.
public let isWriteable: Bool public let isWriteable: Bool
// MARK: Initializers // MARK: Initializers