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

Improved the documentation for the AmiiboSeries, AmiiboType, GameCharacter, and GameSeries types in the library target.

Browse Source
This commit is contained in:
Javier Cicchelli
2025-10-28 16:28:30 +01:00
parent 88f9705532
commit cdf391a29f
4 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/AmiiboService/Public/Models/AmiiboSeries.swift
+5 -5
View File
@@ -14,19 +14,19 @@
/// A model that represents an amiibo series. /// A model that represents an amiibo series.
public struct AmiiboSeries: KeyNameModel { public struct AmiiboSeries: KeyNameModel {
// TODO: Remove the documentation from the properties of this type as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?).
// MARK: Properties // MARK: Properties
/// A key. /// An amiibo series key.
public let key: String public let key: String
/// A name. /// An amiibo series name.
public let name: String public let name: String
// MARK: Initializers // MARK: Initializers
/// Initializes this model from a given payload.
/// - Parameter payload: A payload that contains the values for the model.
init(_ payload: Components.Schemas.Tuple) { init(_ payload: Components.Schemas.Tuple) {
self.key = payload.key self.key = payload.key
self.name = payload.name self.name = payload.name
Sources/AmiiboService/Public/Models/AmiiboType.swift
+4 -4
View File
@@ -15,18 +15,18 @@
/// A model that represents an amiibo type. /// A model that represents an amiibo type.
public struct AmiiboType: KeyNameModel { public struct AmiiboType: KeyNameModel {
// TODO: Remove the documentation from the properties of this type as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?).
// MARK: Properties // MARK: Properties
/// A key. /// An amiibo type key.
public let key: String public let key: String
/// A name. /// An amiibo type name.
public let name: String public let name: String
// MARK: Initializers // MARK: Initializers
/// Initializes this model from a given payload.
/// - Parameter payload: A payload that contains the values for the model.
init(_ payload: Components.Schemas.Tuple) { init(_ payload: Components.Schemas.Tuple) {
self.key = payload.key self.key = payload.key
self.name = payload.name self.name = payload.name
Sources/AmiiboService/Public/Models/GameCharacter.swift
+5 -5
View File
@@ -15,18 +15,18 @@
/// A model that represents a game character. /// A model that represents a game character.
public struct GameCharacter: KeyNameModel { public struct GameCharacter: KeyNameModel {
// TODO: Remove the documentation from the properties of this type as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?).
// MARK: Properties // MARK: Properties
/// A key. /// A game character key.
public let key: String public let key: String
/// A name. /// A game character name.
public let name: String public let name: String
// MARK: Initializers // MARK: Initializers
/// Initializes this model from a given payload.
/// - Parameter payload: A payload that contains the values for the model.
init(_ payload: Components.Schemas.Tuple) { init(_ payload: Components.Schemas.Tuple) {
self.key = payload.key self.key = payload.key
self.name = payload.name self.name = payload.name
Sources/AmiiboService/Public/Models/GameSeries.swift
+4 -4
View File
@@ -15,18 +15,18 @@
/// A model that represents a game series. /// A model that represents a game series.
public struct GameSeries: KeyNameModel { public struct GameSeries: KeyNameModel {
// TODO: Remove the documentation from the properties of this type as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?).
// MARK: Properties // MARK: Properties
/// A key. /// A game series key.
public let key: String public let key: String
/// A name. /// A game series name.
public let name: String public let name: String
// MARK: Initializers // MARK: Initializers
/// Initializes this model from a given payload.
/// - Parameter payload: A payload that contains the values for the model.
init(_ payload: Components.Schemas.Tuple) { init(_ payload: Components.Schemas.Tuple) {
self.key = payload.key self.key = payload.key
self.name = payload.name self.name = payload.name