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

DocC documentation support (#4)

Browse Source 
This PR contains the work done to:
* Documented all the `private`, `internal`, and `public` interfaces on the existing codebase;
* Set the DocC documentation catalog in the project;
* Written the main `Library` article for the DocC documentation catalog;
* Added the documentation tasks in the `Makefile` file.

Reviewed-on: #4
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
This commit was merged in pull request #4.
This commit is contained in:
Javier Cicchelli
2025-09-09 17:30:19 +00:00
committed by Javier Cicchelli
parent 39c6d6e8d6
commit 37c0f3e322
30 changed files with 543 additions and 151 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/Public/Errors/AmiiboServiceError.swift
+7
View File
@@ -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 status code error.
case undocumented(_ statusCode: Int)
/// An unknown error.
case unknown
}