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

Improved the overall documentation for the public and internal types in the package.

Browse Source
This commit is contained in:
Javier Cicchelli
2026-03-23 00:25:38 +01:00
parent 69d7681139
commit cd01c27544
15 changed files with 62 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/AmiiboService/Public/Models/Amiibo/Amiibo+Game.swift
+3 -3
View File
@@ -18,13 +18,13 @@ extension Amiibo {
// MARK: Properties
/// A list of identifiers.
/// A list of game identifiers associated with this game.
public let identifiers: [String]
/// A name.
/// The name of this game.
public let name: String
/// A list of amiibo usages, if any.
/// A list of amiibo usages within this game, if available.
public let usages: [Usage]?
// MARK: Initializers
Sources/AmiiboService/Public/Models/Amiibo/Amiibo+Platform.swift
+3 -3
View File
@@ -13,7 +13,7 @@
// ===----------------------------------------------------------------------===
extension Amiibo {
/// A model that represents a collection of `Switch`, `Switch 2`, `3DS`, and `WiiU` games related to an amiibo.
/// A model that represents a collection of `Switch`, `Switch 2`, `3DS`, and `Wii U` games related to an amiibo.
public struct Platform: Sendable, Hashable {
// MARK: Properties
@@ -27,7 +27,7 @@ extension Amiibo {
/// A list of `3DS` games related to an amiibo.
public let threeDS: [Game]
/// A list of `WiiU` games related to an amiibo.
/// A list of `Wii U` games related to an amiibo.
public let wiiU: [Game]
// MARK: Initializers
@@ -40,7 +40,7 @@ extension Amiibo {
/// - switch: A list of `Switch` 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.
/// - wiiU: A list of `Wii U` games related to an amiibo, if any.
init?(
_ `switch`: [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
extension Amiibo {
/// A model that represents a collection of release dates related to an amiibo.
/// A model that represents the regional release dates of an amiibo.
public struct Release: Sendable, Hashable {
// MARK: Properties
Sources/AmiiboService/Public/Models/Amiibo/Amiibo+Usage.swift
+2 -2
View File
@@ -18,10 +18,10 @@ extension Amiibo {
// MARK: Properties
/// An explanation of how to use an amiibo.
/// A description of how the amiibo is used within the game.
public let explanation: String
/// A flag that indicates whether an amiibo can save game data in it.
/// A flag that indicates whether the amiibo can save game data.
public let isWriteable: Bool
// MARK: Initializers