Updated the project documentation in the package.

2026-03-23 00:20:44 +01:00
parent ee28f87d8d
commit 69d7681139
4 changed files with 143 additions and 5 deletions
@@ -0,0 +1,22 @@
+# ``AmiiboService``
+
+## Topics
+
+### Initializers
+
+- ``AmiiboService/init(client:)``
+
+### Amiibo endpoints
+
+- ``AmiiboService/getAmiibos(_:)``
+- ``AmiiboService/getAmiiboSeries(_:)``
+- ``AmiiboService/getAmiiboTypes(_:)``
+
+### Game endpoints
+
+- ``AmiiboService/getGameCharacters(_:)``
+- ``AmiiboService/getGameSeries(_:)``
+
+### System endpoints
+
+- ``AmiiboService/getLastUpdated()``
@@ -0,0 +1,19 @@
+# ``AmiiboServiceError``
+
+## Topics
+
+### Request errors
+
+- ``AmiiboServiceError/badRequest``
+- ``AmiiboServiceError/cancelled``
+
+### Response errors
+
+- ``AmiiboServiceError/decoding``
+- ``AmiiboServiceError/notFound``
+
+### Service errors
+
+- ``AmiiboServiceError/notAvailable``
+- ``AmiiboServiceError/undocumented(_:)``
+- ``AmiiboServiceError/unknown``