Documented the AmiiboClient enumeration and the AmiiboServiceError error in the library target.

2025-09-09 09:25:50 +02:00
parent 7f6607170a
commit 9e42686b55
2 changed files with 28 additions and 0 deletions
@@ -10,12 +10,19 @@
 //
 //===----------------------------------------------------------------------===

+/// A representation of all the possible errors that the ``AmiiboService`` service could throw.
 public enum AmiiboServiceError: Error {
+    /// A bad request has been given to the client.
    case badRequest
+    /// A response cannot be decoded.
    case decoding
+    /// An online service is not currently available.
    case notAvailable
+    /// A response cannot be found.
    case notFound
+    /// An undocumented/unsupported error.
    case undocumented(_ statusCode: Int)
+    /// An unknown error.
    case unknown
 }