[Setup] Documentation #10

Merged
javier merged 12 commits from setup/documentation into main 2023-04-23 13:16:23 +00:00
Showing only changes of commit e5f7e4ba84 - Show all commits

View File

@ -1,15 +1,30 @@
/// This model is a concrete genetic definition that represents the following models: ``AmiiboSeries``, ``AmiiboType``, ``Character`` and ``GameSeries``.
public struct KeyName {
// MARK: Properties
/// The key of the model.
public let key: String
public let name: String?
/// The name of the model.
public let name: String
}
// MARK: - Type aliases
/// This model represents the series an amiibo belongs to.
public typealias AmiiboSeries = KeyName
/// This model represents the type an amiibo belongs to.
public typealias AmiiboType = KeyName
/// This model represents the character an amiibo is associated to.
public typealias Character = KeyName
/// This model represents the games series an amiibo is associated to.
public typealias GameSeries = KeyName
// MARK: - Decodable
extension KeyName: Decodable {}
// MARK: - Type aliases
public typealias AmiiboType = KeyName
public typealias AmiiboSeries = KeyName
public typealias GameSeries = KeyName
public typealias Character = KeyName