DocC documentation support #4

Merged
javier merged 28 commits from package/documentation into main 2025-09-09 17:30:20 +00:00

28 Commits

Author SHA1 Message Date
javier 2f1f9b829c Merge branch 'main' into package/documentation 2025-09-09 19:23:09 +02:00
javier 39e8e5c683 Renamed the Introduction article in the AmiiboService documentation catalog as Library. 2025-09-09 19:07:24 +02:00
javier 1b40ea5244 Amended the documentation tasks in the Makefile to use the DOCC_CATALOG_PATH variable. 2025-09-09 18:56:48 +02:00
javier 64033aff11 Written the Introduction article for the AmiiboService documentation catalog. 2025-09-09 18:56:13 +02:00
javier 8dabbd1d53 Defined the DOCC_CATALOG_PATH variable in the .env file. 2025-09-09 18:55:30 +02:00
javier f1177fd89b Created the DocC documentation catalog for the library. 2025-09-09 11:58:27 +02:00
javier 2c5b76d425 Added the documentation tasks to the Makefile file in the project. 2025-09-09 11:52:16 +02:00
javier f981349143 Added the .env file to the project. 2025-09-09 11:51:39 +02:00
javier 69c7308d87 Remove the .env from the library. 2025-09-09 11:49:22 +02:00
javier 4fe8c2b587 Added the .env file and the .doccarchive container to the .gitignore file. 2025-09-09 11:47:27 +02:00
javier 5e4ac4accc Added the Swift DocC plugin package dependency to the dependencies in the Package file. 2025-09-09 11:18:52 +02:00
javier 93afbb2c1e Documented the Amiibo model and its sub-models in the library target. 2025-09-09 11:11:06 +02:00
javier aaa0a7835e Documented the AmiiboSeries, AmiiboType, GameCharacter, and GameSeries models in the library target. 2025-09-09 09:54:00 +02:00
javier f7ae2f65f2 Documented the AmiiboFilter, AmiiboSeriesFilter, AmiiboTypeFilter, GameCharacterFilter, and the GameSeriesFilter types in the library target. 2025-09-09 09:49:43 +02:00
javier 36fd2c29ea Documented the AmiiboService service in the library target. 2025-09-09 09:36:42 +02:00
javier 9e42686b55 Documented the AmiiboClient enumeration and the AmiiboServiceError error in the library target. 2025-09-09 09:25:50 +02:00
javier 7f6607170a Documented the AmiiboLiveClient and the AmiiboMockClient clients in the library target. 2025-09-09 09:10:08 +02:00
javier 731a2585b4 Documented the APIClient protocol in the library target. 2025-09-09 08:40:34 +02:00
javier 71464a5bc0 Documented the internal KeyNameFilter and KeyNameModel protocols in the library target. 2025-09-09 07:44:41 +02:00
javier 21fba2612d Documented the ISOTimestampTranscoder transcoder in the library target. 2025-09-09 07:23:55 +02:00
javier 06ea92b72e Moved the AmiiboServiceLiveTests tests in the test target to another folder. 2025-09-09 06:56:02 +02:00
javier dc786e9fe3 Improved the readability of the Package file. 2025-09-09 06:54:35 +02:00
javier 1da86de0c9 Updated the header of almost all the files in the library and tests targets. 2025-09-08 20:35:28 +02:00
javier 4db0d42b3b Updated the cases for the AmiiboServiceLiveTests tests in the tests target. 2025-09-08 20:29:43 +02:00
javier 0428a252e4 Updated the client initialization inside the "init()" initializer for the AmiiboLiveClient type in the library target. 2025-09-08 19:51:54 +02:00
javier d11db6f425 Defined the naming strategy on the openapi-generator-config file in the library target. 2025-09-08 19:50:43 +02:00
javier dc0d410857 Removed the unnecessary Client+Properties extension from the library target. 2025-09-08 19:49:39 +02:00
javier 818588b7ce Renamed the package from "amiibo-api" to "amiibo-service". 2025-09-08 19:48:05 +02:00