Patched (temporarily) the DocC documentation (#8)

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.

Reviewed-on: #8
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
This commit was merged in pull request #8.
This commit is contained in:
2025-09-10 19:47:45 +00:00
committed by Javier Cicchelli
parent b39fd8533b
commit 0af0e3056d
147 changed files with 290 additions and 173 deletions
@@ -1 +1 @@
{"metadata":{"role":"symbol","modules":[{"relatedModules":["Swift"],"name":"AmiiboService"}],"extendedModule":"Swift","title":"localizedDescription","externalID":"s:s5ErrorP10FoundationE20localizedDescriptionSSvp::SYNTHESIZED::s:13AmiiboService0aB5ErrorO","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"roleHeading":"Instance Property","platforms":[{"beta":false,"name":"iOS","unavailable":false,"introducedAt":"8.0","deprecated":false},{"beta":false,"name":"macOS","unavailable":false,"introducedAt":"10.10","deprecated":false},{"beta":false,"name":"tvOS","unavailable":false,"introducedAt":"9.0","deprecated":false},{"introducedAt":"2.0","beta":false,"deprecated":false,"unavailable":false,"name":"watchOS"}],"symbolKind":"property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiiboserviceerror\/localizeddescription"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Error.localizedDescription"},{"type":"text","text":"."}],"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/localizedDescription"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError"]]},"sections":[],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"navigatorTitle":[{"text":"AmiiboServiceError","kind":"identifier"}],"title":"AmiiboServiceError","url":"\/documentation\/amiiboservice\/amiiboserviceerror","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","abstract":[{"text":"A representation of all the possible errors that the ","type":"text"},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","type":"reference","isActive":true},{"type":"text","text":" service could throw."}],"type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboServiceError"}]},"doc://AmiiboService/documentation/AmiiboService":{"role":"collection","url":"\/documentation\/amiiboservice","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","type":"topic","abstract":[{"type":"text","text":"A library that provides everything the developer needs to interacts with the "},{"type":"strong","inlineContent":[{"text":"Amiibo API","type":"text"}]},{"type":"text","text":" backend service."}],"kind":"symbol","title":"AmiiboService"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AmiiboService"}],"type":"topic","abstract":[{"text":"A type that implements the service that uses a client to make calls.","type":"text"}],"kind":"symbol","title":"AmiiboService","url":"\/documentation\/amiiboservice\/amiiboservice","navigatorTitle":[{"text":"AmiiboService","kind":"identifier"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/localizedDescription":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/localizedDescription","role":"symbol","kind":"symbol","title":"localizedDescription","abstract":[],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"url":"\/documentation\/amiiboservice\/amiiboserviceerror\/localizeddescription","type":"topic"}}}
{"metadata":{"symbolKind":"property","extendedModule":"Swift","title":"localizedDescription","externalID":"s:s5ErrorP10FoundationE20localizedDescriptionSSvp::SYNTHESIZED::s:13AmiiboService0aB5ErrorO","platforms":[{"unavailable":false,"introducedAt":"8.0","name":"iOS","beta":false,"deprecated":false},{"unavailable":false,"introducedAt":"10.10","name":"macOS","beta":false,"deprecated":false},{"name":"tvOS","introducedAt":"9.0","deprecated":false,"unavailable":false,"beta":false},{"name":"watchOS","introducedAt":"2.0","deprecated":false,"unavailable":false,"beta":false}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"role":"symbol","roleHeading":"Instance Property","modules":[{"relatedModules":["Swift"],"name":"AmiiboService"}]},"sections":[],"variants":[{"paths":["\/documentation\/amiiboservice\/amiiboserviceerror\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError"]]},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/localizedDescription"},"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Error.localizedDescription"},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["macOS"]}]}],"references":{"doc://AmiiboService/documentation/AmiiboService":{"title":"AmiiboService","kind":"symbol","role":"collection","type":"topic","abstract":[{"type":"text","text":"A library that provides everything the developer needs to interacts with the "},{"type":"strong","inlineContent":[{"type":"text","text":"Amiibo API"}]},{"type":"text","text":" backend service."}],"url":"\/documentation\/amiiboservice","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","kind":"symbol","title":"AmiiboService","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AmiiboService"}],"abstract":[{"text":"A type that implements the service that uses a client to make calls.","type":"text"}],"url":"\/documentation\/amiiboservice\/amiiboservice","type":"topic","navigatorTitle":[{"text":"AmiiboService","kind":"identifier"}],"role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/localizedDescription":{"role":"symbol","abstract":[],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/localizedDescription","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"title":"localizedDescription","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/localizeddescription","type":"topic","kind":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"type":"topic","abstract":[{"text":"A representation of all the possible errors that the ","type":"text"},{"type":"reference","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","isActive":true},{"text":" service could throw.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboServiceError"}],"title":"AmiiboServiceError","url":"\/documentation\/amiiboservice\/amiiboserviceerror","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"AmiiboServiceError","kind":"identifier"}],"role":"symbol"}}}