From 0461e65a9c06ccf8a39be0c3a0817f56d6367619 Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Sun, 23 Apr 2023 13:23:17 +0200 Subject: [PATCH] Written the documentation for the KeyNameFilter filter. --- Sources/Filters/KeyNameFilter.swift | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/Sources/Filters/KeyNameFilter.swift b/Sources/Filters/KeyNameFilter.swift index 554033b..c8c09c9 100644 --- a/Sources/Filters/KeyNameFilter.swift +++ b/Sources/Filters/KeyNameFilter.swift @@ -1,3 +1,4 @@ +/// This filter provides all the possible parameters (and combinations) available at the remote API applies when filtering amiibos series (``AmiiboSeriesFilter``), amiibo types (``AmiiboTypeFilter``), characters (``CharacterFilter``), or game series (``GameSeriesFilter``). public struct KeyNameFilter { // MARK: Properties @@ -7,6 +8,10 @@ public struct KeyNameFilter { // MARK: Initialisers + /// Initialises this filter. + /// - Parameters: + /// - key: A `key` value to match against. + /// - name: A `name` value to match against. public init( key: String? = nil, name: String? = nil @@ -17,6 +22,20 @@ public struct KeyNameFilter { } +// MARK: - Type aliases + +/// This filter provides all the possible parameters (and combinations) available at the remote API applies when filtering amiibos series. +public typealias AmiiboSeriesFilter = KeyNameFilter + +/// This filter provides all the possible parameters (and combinations) available at the remote API applies when filtering amiibo types. +public typealias AmiiboTypeFilter = KeyNameFilter + +/// This filter provides all the possible parameters (and combinations) available at the remote API applies when filtering characters. +public typealias CharacterFilter = KeyNameFilter + +/// This filter provides all the possible parameters (and combinations) available at the remote API applies when filtering game series. +public typealias GameSeriesFilter = KeyNameFilter + // MARK: - Filter extension KeyNameFilter: Filter { @@ -39,13 +58,6 @@ extension KeyNameFilter: Filter { } -// MARK: - Type aliases - -public typealias AmiiboSeriesFilter = KeyNameFilter -public typealias AmiiboTypeFilter = KeyNameFilter -public typealias CharacterFilter = KeyNameFilter -public typealias GameSeriesFilter = KeyNameFilter - // MARK: - String+Key private extension String {