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

Patched (temporarily) the DocC documentation #8

Merged
javier merged 12 commits from documentation/patch into main 2025-09-10 19:47:46 +00:00
Conversation 0 Commits 12 Files Changed 147
+290 -173
javier commented 2025-09-10 19:47:34 +00:00
Owner
Copy Link
Copy Source

This PR contains the work done to:

  • Documented the public properties, initializers, and/or functions of those types conforming to the APIClient, KeyNameFilter, and KeyNameModel protocols, to fix the issue that the protocol documentations cannot be inherited;
  • Moved the AmiiboService DocC documentation catalog inside the library target;
  • Amended the folder structure of the library and test targets;
  • Fixed further documentation issues encountered while revising the written documentation;
  • Added the lib-test task in the Makefile file;
  • Improved the naming for the existing tasks in the Makefile file.
This PR contains the work done to: * Documented the public properties, initializers, and/or functions of those types conforming to the `APIClient`, `KeyNameFilter`, and `KeyNameModel` protocols, to fix the issue that the protocol documentations cannot be inherited; * Moved the `AmiiboService` DocC documentation catalog inside the library target; * Amended the folder structure of the library and test targets; * Fixed further documentation issues encountered while revising the written documentation; * Added the `lib-test` task in the `Makefile` file; * Improved the naming for the existing tasks in the `Makefile` file.
javier added the Kind/BugKind/EnhancementKind/Documentation
Priority
High
 labels 2025-09-10 19:47:34 +00:00
javier self-assigned this 2025-09-10 19:47:34 +00:00
javier added 12 commits 2025-09-10 19:47:34 +00:00
Fixed a warning when building DocC documentation for the Amiibo.Platform model type in the library target. de7a91b181
Moved the VS Code definitions within the .gitignore file. 000e564250
Moved the AmiiboService DocC documentation catalog inside the library target. 2843ced0e9
Arranged the folder structure of the library and test targets in the Package. b7d3dbff58
Removed the unnecessary DOCC_CATALOG_PATH from the .env file and its use from the Makefile file. 1c6c1f64d9
Amended some documentation for the KeyNameFilter protocol in the library target. 57f92c7639
Added the "lib-test" task to the Make file file. ff1fa47290
Improved the naming for the existing tasks in the Makefile file. acd9d93964
Documented the functions for the AmiiboLiveClient and the AmiiboMockClients types in the library target. ca75993c63
Documented the properties and initializers of the types that conforms to the KeyNameFilter protocol in the library target. 7b879dff94
Documented the properties of the model types that conforms to the KeyNameModel protocol in the library target. 0bfc9addad
Updated the DocC library documentation for Github. fe541338fa
javier merged commit 0af0e3056d into main 2025-09-10 19:47:46 +00:00
javier deleted branch documentation/patch 2025-09-10 19:47:46 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
Compat/Breaking
Breaking change that won't be backward compatible
 Kind/Bug
Something is not working
 Kind/Documentation
Documentation changes
 Kind/Enhancement
Improve existing functionality
 Kind/Feature
New functionality
 Kind/Security
This is security issue
 Kind/Testing
Issue or pull request related to testing
Priority
Critical
The priority is critical
Priority
High
The priority is high
Priority
Low
The priority is low
Priority
Medium
The priority is medium
Reviewed
Confirmed
Issue has been confirmed
Reviewed
Duplicate
This issue or pull request already exists
Reviewed
Invalid
Invalid issue
Reviewed
Won't Fix
This issue won't be fixed
Status
Abandoned
Somebody has started to work on this but abandoned work
Status
Blocked
Something is blocking this issue or pull request
Status
Need More Info
Feedback is required to reproduce issue or to continue work
No labels Kind/Bug Kind/Documentation Kind/Enhancement
Priority
High
Milestone
No items
No Milestone
Assignees
Clear assignees
javier (Javier Cicchelli)
No Assignees javier
1 Participants
Notifications
Due Date
No due date set.
Reference: rock-n-code/amiibo-service#8