Improved the documentation throughout the library (#30)

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:
2026-09-14 10:13:41 +00:00
committed by javier
parent aa135cb04a
commit 44bfaca553
151 changed files with 304 additions and 286 deletions
@@ -14,9 +14,9 @@
import Foundation
/// A protocol that defines API clients containing all available endpoints to interact with.
/// A protocol that defines a client that fetches data from the Amiibo API.
///
/// Conforming types must be `Sendable`, as clients are expected to be used safely across concurrency domains.
/// ``AmiiboLiveClient`` is the default implementation. Conform to this protocol to provide another one, such as a mock for tests. Conforming types must be `Sendable`.
public protocol AmiiboClient: Sendable {
// MARK: Functions