Patched (temporarily) the DocC documentation #8
@@ -10,7 +10,7 @@
|
|||||||
//
|
//
|
||||||
//===----------------------------------------------------------------------===
|
//===----------------------------------------------------------------------===
|
||||||
|
|
||||||
/// A concrete representation of the types of client that a ``AmiiboService`` service can utilize.
|
/// A representation of the types of client that a ``AmiiboService`` service can utilize.
|
||||||
///
|
///
|
||||||
/// > important: This enumeration has been defined as a way to avoid exposing the `APIClient` protocol outside the boundaries of this library.
|
/// > important: This enumeration has been defined as a way to avoid exposing the `APIClient` protocol outside the boundaries of this library.
|
||||||
public enum AmiiboClient {
|
public enum AmiiboClient {
|
||||||
|
|||||||
@@ -13,9 +13,14 @@
|
|||||||
/// A model that represents an amiibo series.
|
/// A model that represents an amiibo series.
|
||||||
public struct AmiiboSeries: KeyNameModel {
|
public struct AmiiboSeries: KeyNameModel {
|
||||||
|
|
||||||
// MARK: Properties
|
// TODO: Remove the documentation from the properties of this type as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?).
|
||||||
|
|
||||||
|
// MARK: Properties
|
||||||
|
|
||||||
|
/// A key.
|
||||||
public let key: String
|
public let key: String
|
||||||
|
|
||||||
|
/// A name.
|
||||||
public let name: String
|
public let name: String
|
||||||
|
|
||||||
// MARK: Initializers
|
// MARK: Initializers
|
||||||
|
|||||||
@@ -12,10 +12,15 @@
|
|||||||
|
|
||||||
/// A model that represents an amiibo type.
|
/// A model that represents an amiibo type.
|
||||||
public struct AmiiboType: KeyNameModel {
|
public struct AmiiboType: KeyNameModel {
|
||||||
|
|
||||||
|
// TODO: Remove the documentation from the properties of this type as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?).
|
||||||
|
|
||||||
// MARK: Properties
|
// MARK: Properties
|
||||||
|
|
||||||
|
/// A key.
|
||||||
public let key: String
|
public let key: String
|
||||||
|
|
||||||
|
/// A name.
|
||||||
public let name: String
|
public let name: String
|
||||||
|
|
||||||
// MARK: Initializers
|
// MARK: Initializers
|
||||||
|
|||||||
@@ -12,10 +12,15 @@
|
|||||||
|
|
||||||
/// A model that represents a game character.
|
/// A model that represents a game character.
|
||||||
public struct GameCharacter: KeyNameModel {
|
public struct GameCharacter: KeyNameModel {
|
||||||
|
|
||||||
|
// TODO: Remove the documentation from the properties of this type as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?).
|
||||||
|
|
||||||
// MARK: Properties
|
// MARK: Properties
|
||||||
|
|
||||||
|
/// A key.
|
||||||
public let key: String
|
public let key: String
|
||||||
|
|
||||||
|
/// A name.
|
||||||
public let name: String
|
public let name: String
|
||||||
|
|
||||||
// MARK: Initializers
|
// MARK: Initializers
|
||||||
|
|||||||
@@ -12,10 +12,15 @@
|
|||||||
|
|
||||||
/// A model that represents a game series.
|
/// A model that represents a game series.
|
||||||
public struct GameSeries: KeyNameModel {
|
public struct GameSeries: KeyNameModel {
|
||||||
|
|
||||||
|
// TODO: Remove the documentation from the properties of this type as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?).
|
||||||
|
|
||||||
// MARK: Properties
|
// MARK: Properties
|
||||||
|
|
||||||
|
/// A key.
|
||||||
public let key: String
|
public let key: String
|
||||||
|
|
||||||
|
/// A name.
|
||||||
public let name: String
|
public let name: String
|
||||||
|
|
||||||
// MARK: Initializers
|
// MARK: Initializers
|
||||||
|
|||||||
Reference in New Issue
Block a user