diff --git a/Sources/AmiiboService/Public/Models/AmiiboSeries.swift b/Sources/AmiiboService/Public/Models/AmiiboSeries.swift index d58c331..a7287b2 100644 --- a/Sources/AmiiboService/Public/Models/AmiiboSeries.swift +++ b/Sources/AmiiboService/Public/Models/AmiiboSeries.swift @@ -14,19 +14,19 @@ /// A model that represents an amiibo series. 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 - /// A key. + /// An amiibo series key. public let key: String - /// A name. + /// An amiibo series name. public let name: String // 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) { self.key = payload.key self.name = payload.name diff --git a/Sources/AmiiboService/Public/Models/AmiiboType.swift b/Sources/AmiiboService/Public/Models/AmiiboType.swift index ea8050c..5918a6f 100644 --- a/Sources/AmiiboService/Public/Models/AmiiboType.swift +++ b/Sources/AmiiboService/Public/Models/AmiiboType.swift @@ -15,18 +15,18 @@ /// A model that represents an amiibo type. 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 - /// A key. + /// An amiibo type key. public let key: String - /// A name. + /// An amiibo type name. public let name: String // 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) { self.key = payload.key self.name = payload.name diff --git a/Sources/AmiiboService/Public/Models/GameCharacter.swift b/Sources/AmiiboService/Public/Models/GameCharacter.swift index 6cf3920..db01e50 100644 --- a/Sources/AmiiboService/Public/Models/GameCharacter.swift +++ b/Sources/AmiiboService/Public/Models/GameCharacter.swift @@ -15,18 +15,18 @@ /// A model that represents a game character. 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 - /// A key. + /// A game character key. public let key: String - /// A name. + /// A game character name. public let name: String // 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) { self.key = payload.key self.name = payload.name diff --git a/Sources/AmiiboService/Public/Models/GameSeries.swift b/Sources/AmiiboService/Public/Models/GameSeries.swift index 5fb577c..472d05b 100644 --- a/Sources/AmiiboService/Public/Models/GameSeries.swift +++ b/Sources/AmiiboService/Public/Models/GameSeries.swift @@ -15,18 +15,18 @@ /// A model that represents a game series. 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 - /// A key. + /// A game series key. public let key: String - /// A name. + /// A game series name. public let name: String // 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) { self.key = payload.key self.name = payload.name