From 7b879dff94715cb2ffd3f16f6d0dc11a6f97bfe4 Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Wed, 10 Sep 2025 21:34:00 +0200 Subject: [PATCH] Documented the properties and initializers of the types that conforms to the KeyNameFilter protocol in the library target. --- .../Public/Filters/AmiiboSeriesFilter.swift | 18 ++++++++++++++---- .../Public/Filters/AmiiboTypeFilter.swift | 18 ++++++++++++++---- .../Public/Filters/GameCharacterFilter.swift | 18 ++++++++++++++---- .../Public/Filters/GameSeriesFilter.swift | 18 ++++++++++++++---- 4 files changed, 56 insertions(+), 16 deletions(-) diff --git a/Sources/AmiiboService/Public/Filters/AmiiboSeriesFilter.swift b/Sources/AmiiboService/Public/Filters/AmiiboSeriesFilter.swift index 3df3abe..ab0a9b7 100644 --- a/Sources/AmiiboService/Public/Filters/AmiiboSeriesFilter.swift +++ b/Sources/AmiiboService/Public/Filters/AmiiboSeriesFilter.swift @@ -13,23 +13,33 @@ /// A type that contains values to fine-tune a response when requesting amiibo series. public struct AmiiboSeriesFilter: KeyNameFilter { + // TODO: Remove the documentation from the properties and initializers of this type as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?). + // MARK: Properties - + + /// A key to return, if any. public let key: String? + + /// A name to return, if any. public let name: String? // MARK: Initializers - + + /// Initializes this filter without key or name values. public init() { self.key = nil self.name = nil } - + + /// Initializes this filter with a key value. + /// - Parameter key: A key to return. public init(key: String) { self.key = key self.name = nil } - + + /// Initializes this filter with a name value. + /// - Parameter name: A name to return. public init(name: String) { self.key = nil self.name = name diff --git a/Sources/AmiiboService/Public/Filters/AmiiboTypeFilter.swift b/Sources/AmiiboService/Public/Filters/AmiiboTypeFilter.swift index 11a6ae3..24b7ada 100644 --- a/Sources/AmiiboService/Public/Filters/AmiiboTypeFilter.swift +++ b/Sources/AmiiboService/Public/Filters/AmiiboTypeFilter.swift @@ -13,23 +13,33 @@ /// A type that contains values to fine-tune a response when requesting amiibo types. public struct AmiiboTypeFilter: KeyNameFilter { + // TODO: Remove the documentation from the properties and initializers of this type as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?). + // MARK: Properties - + + /// A key to return, if any. public let key: String? + + /// A name to return, if any. public let name: String? // MARK: Initializers - + + /// Initializes this filter without key or name values. public init() { self.key = nil self.name = nil } - + + /// Initializes this filter with a key value. + /// - Parameter key: A key to return. public init(key: String) { self.key = key self.name = nil } - + + /// Initializes this filter with a name value. + /// - Parameter name: A name to return. public init(name: String) { self.key = nil self.name = name diff --git a/Sources/AmiiboService/Public/Filters/GameCharacterFilter.swift b/Sources/AmiiboService/Public/Filters/GameCharacterFilter.swift index 3298feb..ef9082a 100644 --- a/Sources/AmiiboService/Public/Filters/GameCharacterFilter.swift +++ b/Sources/AmiiboService/Public/Filters/GameCharacterFilter.swift @@ -13,23 +13,33 @@ /// A type that contains values to fine-tune a response when requesting game characters. public struct GameCharacterFilter: KeyNameFilter { - // MARK: Properties + // TODO: Remove the documentation from the properties and initializers of this type as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?). + // MARK: Properties + + /// A key to return, if any. public let key: String? + + /// A name to return, if any. public let name: String? // MARK: Initializers - + + /// Initializes this filter without key or name values. public init() { self.key = nil self.name = nil } - + + /// Initializes this filter with a key value. + /// - Parameter key: A key to return. public init(key: String) { self.key = key self.name = nil } - + + /// Initializes this filter with a name value. + /// - Parameter name: A name to return. public init(name: String) { self.key = nil self.name = name diff --git a/Sources/AmiiboService/Public/Filters/GameSeriesFilter.swift b/Sources/AmiiboService/Public/Filters/GameSeriesFilter.swift index d45a73f..aeba39e 100644 --- a/Sources/AmiiboService/Public/Filters/GameSeriesFilter.swift +++ b/Sources/AmiiboService/Public/Filters/GameSeriesFilter.swift @@ -13,23 +13,33 @@ /// A type that contains values to fine-tune a response when requesting game series. public struct GameSeriesFilter: KeyNameFilter { - // MARK: Properties + // TODO: Remove the documentation from the properties and initializers of this type as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?). + // MARK: Properties + + /// A key to return, if any. public let key: String? + + /// A name to return, if any. public let name: String? // MARK: Initializers - + + /// Initializes this filter without key or name values. public init() { self.key = nil self.name = nil } - + + /// Initializes this filter with a key value. + /// - Parameter key: A key to return. public init(key: String) { self.key = key self.name = nil } - + + /// Initializes this filter with a name value. + /// - Parameter name: A name to return. public init(name: String) { self.key = nil self.name = name