Improved the overall documentation for the public and internal types in the package.
This commit is contained in:
@@ -12,15 +12,15 @@
|
||||
//
|
||||
// ===----------------------------------------------------------------------===
|
||||
|
||||
/// A protocol that defines decodable models containing the `key` and `name` properties.
|
||||
/// A protocol that defines models containing a `key` and `name` pair.
|
||||
protocol KeyNameModel: Sendable, Hashable {
|
||||
|
||||
// MARK: Properties
|
||||
|
||||
/// A key.
|
||||
/// A hexadecimal key that uniquely identifies this model.
|
||||
var key: String { get }
|
||||
|
||||
/// A name.
|
||||
/// A display name for this model.
|
||||
var name: String { get }
|
||||
|
||||
// MARK: Initializers
|
||||
|
||||
Reference in New Issue
Block a user