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

Patched (temporarily) the DocC documentation #8

Merged
javier merged 12 commits from documentation/patch into main 2025-09-10 19:47:46 +00:00
Conversation 0 Commits 12 Files Changed 147
+56 -16
4 changed files with 56 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 7b879dff94 - Show all commits
Sources/AmiiboService/Public/Filters/AmiiboSeriesFilter.swift
+10
View File
@@ -13,23 +13,33 @@
/// A type that contains values to fine-tune a response when requesting amiibo series. /// A type that contains values to fine-tune a response when requesting amiibo series.
public struct AmiiboSeriesFilter: KeyNameFilter { 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 // MARK: Properties
/// A key to return, if any.
public let key: String? public let key: String?
/// A name to return, if any.
public let name: String? public let name: String?
// MARK: Initializers // MARK: Initializers
/// Initializes this filter without key or name values.
public init() { public init() {
self.key = nil self.key = nil
self.name = nil self.name = nil
} }
/// Initializes this filter with a key value.
/// - Parameter key: A key to return.
public init(key: String) { public init(key: String) {
self.key = key self.key = key
self.name = nil self.name = nil
} }
/// Initializes this filter with a name value.
/// - Parameter name: A name to return.
public init(name: String) { public init(name: String) {
self.key = nil self.key = nil
self.name = name self.name = name
Sources/AmiiboService/Public/Filters/AmiiboTypeFilter.swift
+10
View File
@@ -13,23 +13,33 @@
/// A type that contains values to fine-tune a response when requesting amiibo types. /// A type that contains values to fine-tune a response when requesting amiibo types.
public struct AmiiboTypeFilter: KeyNameFilter { 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 // MARK: Properties
/// A key to return, if any.
public let key: String? public let key: String?
/// A name to return, if any.
public let name: String? public let name: String?
// MARK: Initializers // MARK: Initializers
/// Initializes this filter without key or name values.
public init() { public init() {
self.key = nil self.key = nil
self.name = nil self.name = nil
} }
/// Initializes this filter with a key value.
/// - Parameter key: A key to return.
public init(key: String) { public init(key: String) {
self.key = key self.key = key
self.name = nil self.name = nil
} }
/// Initializes this filter with a name value.
/// - Parameter name: A name to return.
public init(name: String) { public init(name: String) {
self.key = nil self.key = nil
self.name = name self.name = name
Sources/AmiiboService/Public/Filters/GameCharacterFilter.swift
+10
View File
@@ -13,23 +13,33 @@
/// A type that contains values to fine-tune a response when requesting game characters. /// A type that contains values to fine-tune a response when requesting game characters.
public struct GameCharacterFilter: KeyNameFilter { public struct GameCharacterFilter: 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 // MARK: Properties
/// A key to return, if any.
public let key: String? public let key: String?
/// A name to return, if any.
public let name: String? public let name: String?
// MARK: Initializers // MARK: Initializers
/// Initializes this filter without key or name values.
public init() { public init() {
self.key = nil self.key = nil
self.name = nil self.name = nil
} }
/// Initializes this filter with a key value.
/// - Parameter key: A key to return.
public init(key: String) { public init(key: String) {
self.key = key self.key = key
self.name = nil self.name = nil
} }
/// Initializes this filter with a name value.
/// - Parameter name: A name to return.
public init(name: String) { public init(name: String) {
self.key = nil self.key = nil
self.name = name self.name = name
Sources/AmiiboService/Public/Filters/GameSeriesFilter.swift
+10
View File
@@ -13,23 +13,33 @@
/// A type that contains values to fine-tune a response when requesting game series. /// A type that contains values to fine-tune a response when requesting game series.
public struct GameSeriesFilter: KeyNameFilter { public struct GameSeriesFilter: 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 // MARK: Properties
/// A key to return, if any.
public let key: String? public let key: String?
/// A name to return, if any.
public let name: String? public let name: String?
// MARK: Initializers // MARK: Initializers
/// Initializes this filter without key or name values.
public init() { public init() {
self.key = nil self.key = nil
self.name = nil self.name = nil
} }
/// Initializes this filter with a key value.
/// - Parameter key: A key to return.
public init(key: String) { public init(key: String) {
self.key = key self.key = key
self.name = nil self.name = nil
} }
/// Initializes this filter with a name value.
/// - Parameter name: A name to return.
public init(name: String) { public init(name: String) {
self.key = nil self.key = nil
self.name = name self.name = name