Commit Graph

17 Commits

Author SHA1 Message Date
javier 7b879dff94 Documented the properties and initializers of the types that conforms to the KeyNameFilter protocol in the library target. 2025-09-10 21:34:00 +02:00
javier ca75993c63 Documented the functions for the AmiiboLiveClient and the AmiiboMockClients types in the library target. 2025-09-10 21:28:26 +02:00
javier acd9d93964 Improved the naming for the existing tasks in the Makefile file. 2025-09-10 21:19:50 +02:00
javier ff1fa47290 Added the "lib-test" task to the Make file file. 2025-09-10 21:19:24 +02:00
javier 57f92c7639 Amended some documentation for the KeyNameFilter protocol in the library target. 2025-09-10 20:31:59 +02:00
javier 1c6c1f64d9 Removed the unnecessary DOCC_CATALOG_PATH from the .env file and its use from the Makefile file. 2025-09-10 20:04:37 +02:00
javier b7d3dbff58 Arranged the folder structure of the library and test targets in the Package. 2025-09-10 20:03:55 +02:00
javier 2843ced0e9 Moved the AmiiboService DocC documentation catalog inside the library target. 2025-09-10 19:39:56 +02:00
javier 000e564250 Moved the VS Code definitions within the .gitignore file. 2025-09-10 18:30:08 +02:00
javier de7a91b181 Fixed a warning when building DocC documentation for the Amiibo.Platform model type in the library target. 2025-09-10 18:27:56 +02:00
javier b39fd8533b DocC documentation content fixes. (#6)
This PR contains the work done to:
* Fix some documentation issues encountered in the `README` file;
* Fix some documentation issues encountered in the `Library` article of the DocC documentation catalog;
* Update the DocC documentation of the library for GitHub Pages.

Reviewed-on: #6
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-09-09 18:58:18 +00:00
javier 410a200661 GitHub Pages documentation support. (#5)
This PR contains the work done to:
* Update the `Library` article in the DocC documentation catalog in the project;
* Generate the DocC documentation of the library for GitHub Pages;
* Written the `README` file in the project.

Reviewed-on: #5
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-09-09 18:34:29 +00:00
javier 37c0f3e322 DocC documentation support (#4)
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>
2025-09-09 17:30:19 +00:00
javier 39c6d6e8d6 Basic update of the existing files in the project (#3)
This PR contains the work done to:
* update the `Package.swift` file;
* update the file headers of the existing file in the project;
* update the cases of the `AmiiboServiceLiveTests` tests.

Reviewed-on: #3
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-09-09 17:20:05 +00:00
javier da07ef7e4f Moved the Amiibo API implementation to its own package (#2)
This PR contains the work done to migrate the *almost* completed**Amiibo API** implementation done in another project to its own stand-alone package.

Reviewed-on: rock-n-code/amiibo-api#2
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
v1.0.0-rc.1
2024-09-14 22:26:39 +00:00
javier 5aa852a051 Basic package setup (#1)
This PR contains the work done to setup this Swift package, so development can start from here.

Reviewed-on: rock-n-code/amiibo-api#1
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2024-09-07 07:46:59 +00:00
javier b20f15366c Initial Commit 2024-09-07 08:40:54 +02:00