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

Improved the documentation throughout the library (#30)

Browse Source 
This PR contains the work done to improve the overall documentation effort throughout the library.

Reviewed-on: #30
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
This commit was merged in pull request #30.
This commit is contained in:
javier
2026-09-14 10:13:41 +00:00
committed by javier
parent aa135cb04a
commit 44bfaca553
151 changed files with 304 additions and 286 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/AmiiboService/Public/Models/Amiibo.swift
+3 -1
View File
@@ -34,7 +34,9 @@ public struct Amiibo: Sendable, Hashable {
/// The name of this amiibo.
public let name: String
/// The game platform data for this amiibo, if available.
/// The related games of this amiibo, grouped by platform.
///
/// This value is `nil` unless the request sets ``AmiiboFilter/showGames`` or ``AmiiboFilter/showUsage``, or when the amiibo has no related games.
public let platform: Platform?
/// The release dates of this amiibo across different regions.
Sources/AmiiboService/Public/Models/Amiibo/Amiibo+Game.swift
+1 -1
View File
@@ -24,7 +24,7 @@ extension Amiibo {
/// The name of this game.
public let name: String
/// A list of amiibo usages within this game, if available.
/// A list of amiibo usages within this game, or `nil` unless the request sets ``AmiiboFilter/showUsage``.
public let usages: [Usage]?
// MARK: Initializers