rock-n-code/amiibo-service

DocC documentation support #4

Merged

javier merged 28 commits from package/documentation into main

2025-09-09 17:30:20 +00:00

javier commented

2025-09-09 17:30:11 +00:00

Owner

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.

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.

javier added the Kind/Documentation

labels 2025-09-09 17:30:11 +00:00

javier self-assigned this 2025-09-09 17:30:11 +00:00

javier added 28 commits 2025-09-09 17:30:12 +00:00

Renamed the package from "amiibo-api" to "amiibo-service". 818588b7ce

Removed the unnecessary Client+Properties extension from the library target. dc0d410857

Defined the naming strategy on the openapi-generator-config file in the library target. d11db6f425

Updated the client initialization inside the "init()" initializer for the AmiiboLiveClient type in the library target. 0428a252e4

Updated the cases for the AmiiboServiceLiveTests tests in the tests target. 4db0d42b3b

Updated the header of almost all the files in the library and tests targets. 1da86de0c9

Improved the readability of the Package file. dc786e9fe3

Moved the AmiiboServiceLiveTests tests in the test target to another folder. 06ea92b72e

Documented the ISOTimestampTranscoder transcoder in the library target. 21fba2612d

Documented the internal KeyNameFilter and KeyNameModel protocols in the library target. 71464a5bc0

Documented the APIClient protocol in the library target. 731a2585b4

Documented the AmiiboLiveClient and the AmiiboMockClient clients in the library target. 7f6607170a

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

Documented the AmiiboService service in the library target. 36fd2c29ea

Documented the AmiiboFilter, AmiiboSeriesFilter, AmiiboTypeFilter, GameCharacterFilter, and the GameSeriesFilter types in the library target. f7ae2f65f2

Documented the AmiiboSeries, AmiiboType, GameCharacter, and GameSeries models in the library target. aaa0a7835e

Documented the Amiibo model and its sub-models in the library target. 93afbb2c1e

Added the Swift DocC plugin package dependency to the dependencies in the Package file. 5e4ac4accc

Added the .env file and the .doccarchive container to the .gitignore file. 4fe8c2b587

Remove the .env from the library. 69c7308d87

Added the .env file to the project. f981349143

Added the documentation tasks to the Makefile file in the project. 2c5b76d425

Created the DocC documentation catalog for the library. f1177fd89b

Defined the DOCC_CATALOG_PATH variable in the .env file. 8dabbd1d53

Written the Introduction article for the AmiiboService documentation catalog. 64033aff11

Amended the documentation tasks in the Makefile to use the DOCC_CATALOG_PATH variable. 1b40ea5244

Renamed the Introduction article in the AmiiboService documentation catalog as Library. 39e8e5c683

Merge branch 'main' into package/documentation 2f1f9b829c

javier merged commit 37c0f3e322 into main

2025-09-09 17:30:20 +00:00

javier deleted branch package/documentation

2025-09-09 17:30:20 +00:00

javier referenced this issue from a commit

2025-09-09 17:30:20 +00:00

DocC documentation support (#4)

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Reference: rock-n-code/amiibo-service#4