diff --git a/Sources/AmiiboService/Public/Enumerations/AmiiboClient.swift b/Sources/AmiiboService/Public/Enumerations/AmiiboClient.swift index 79efe29..c293758 100644 --- a/Sources/AmiiboService/Public/Enumerations/AmiiboClient.swift +++ b/Sources/AmiiboService/Public/Enumerations/AmiiboClient.swift @@ -10,7 +10,7 @@ // //===----------------------------------------------------------------------=== -/// A concrete representation of the types of client that a ``AmiiboService`` service can utilize. +/// A representation of the types of client that a ``AmiiboService`` service can utilize. /// /// > important: This enumeration has been defined as a way to avoid exposing the `APIClient` protocol outside the boundaries of this library. public enum AmiiboClient { diff --git a/Sources/AmiiboService/Public/Models/AmiiboSeries.swift b/Sources/AmiiboService/Public/Models/AmiiboSeries.swift index 92eefff..2b6b106 100644 --- a/Sources/AmiiboService/Public/Models/AmiiboSeries.swift +++ b/Sources/AmiiboService/Public/Models/AmiiboSeries.swift @@ -13,9 +13,14 @@ /// A model that represents an amiibo series. public struct AmiiboSeries: KeyNameModel { - // MARK: Properties + // 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. public let key: String + + /// A name. public let name: String // MARK: Initializers diff --git a/Sources/AmiiboService/Public/Models/AmiiboType.swift b/Sources/AmiiboService/Public/Models/AmiiboType.swift index 11f5235..5031ddd 100644 --- a/Sources/AmiiboService/Public/Models/AmiiboType.swift +++ b/Sources/AmiiboService/Public/Models/AmiiboType.swift @@ -12,10 +12,15 @@ /// 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. public let key: String + + /// A name. public let name: String // MARK: Initializers diff --git a/Sources/AmiiboService/Public/Models/GameCharacter.swift b/Sources/AmiiboService/Public/Models/GameCharacter.swift index 1189b4a..5928154 100644 --- a/Sources/AmiiboService/Public/Models/GameCharacter.swift +++ b/Sources/AmiiboService/Public/Models/GameCharacter.swift @@ -12,10 +12,15 @@ /// 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. public let key: String + + /// A name. public let name: String // MARK: Initializers diff --git a/Sources/AmiiboService/Public/Models/GameSeries.swift b/Sources/AmiiboService/Public/Models/GameSeries.swift index 40b03aa..eef5dbd 100644 --- a/Sources/AmiiboService/Public/Models/GameSeries.swift +++ b/Sources/AmiiboService/Public/Models/GameSeries.swift @@ -12,10 +12,15 @@ /// 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. public let key: String + + /// A name. public let name: String // MARK: Initializers