javier
0af0e3056d
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>
1 line
6.2 KiB
JSON
1 line
6.2 KiB
JSON
{"topicSections":[{"identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/live(_:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/mock(_:)"],"generated":true,"title":"Enumeration Cases","anchor":"Enumeration-Cases"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboClient"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"text":"Overview","anchor":"overview"},{"type":"aside","name":"Important","style":"important","content":[{"type":"paragraph","inlineContent":[{"text":"This enumeration has been defined as a way to avoid exposing the ","type":"text"},{"code":"APIClient","type":"codeVoice"},{"text":" protocol outside the boundaries of this library.","type":"text"}]}]}],"kind":"content"}],"metadata":{"title":"AmiiboClient","roleHeading":"Enumeration","modules":[{"name":"AmiiboService"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboClient","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"AmiiboClient"}],"symbolKind":"enum","externalID":"s:13AmiiboService0A6ClientO"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiiboclient"]}],"kind":"symbol","sections":[],"seeAlsoSections":[{"identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient"],"generated":true,"title":"Clients","anchor":"Clients"}],"abstract":[{"text":"A representation of the types of client that a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","type":"reference"},{"text":" service can utilize.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","interfaceLanguage":"swift"},"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/AmiiboClient/mock(_:)":{"kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"A mock Amiibo client, for testing purposes."}],"type":"topic","url":"\/documentation\/amiiboservice\/amiiboclient\/mock(_:)","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"mock","kind":"identifier"},{"text":"(","kind":"text"},{"text":"AmiiboMockClient","preciseIdentifier":"s:13AmiiboService0A10MockClientV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"title":"AmiiboClient.mock(_:)","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/mock(_:)"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient":{"title":"AmiiboLiveClient","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboLiveClient","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"text":"AmiiboLiveClient","kind":"identifier"}],"type":"topic","abstract":[{"text":"A type that implements a live client to the online service.","type":"text"}],"url":"\/documentation\/amiiboservice\/amiiboliveclient","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient"},"doc://AmiiboService/documentation/AmiiboService/AmiiboClient":{"abstract":[{"text":"A representation of the types of client that a ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService"},{"type":"text","text":" service can utilize."}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboClient","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/amiiboclient","title":"AmiiboClient","navigatorTitle":[{"kind":"identifier","text":"AmiiboClient"}],"type":"topic","kind":"symbol","role":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient"},"doc://AmiiboService/documentation/AmiiboService/AmiiboClient/live(_:)":{"kind":"symbol","role":"symbol","url":"\/documentation\/amiiboservice\/amiiboclient\/live(_:)","type":"topic","abstract":[{"text":"A live Amiibo client to interact with the online service.","type":"text"}],"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"live","kind":"identifier"},{"text":"(","kind":"text"},{"text":"AmiiboLiveClient","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A10LiveClientV"},{"text":")","kind":"text"}],"title":"AmiiboClient.live(_:)","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/live(_:)"},"doc://AmiiboService/documentation/AmiiboService/AmiiboMockClient":{"url":"\/documentation\/amiiboservice\/amiibomockclient","kind":"symbol","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboMockClient","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A type that implements a mock client, for testing purposes."}],"title":"AmiiboMockClient","navigatorTitle":[{"text":"AmiiboMockClient","kind":"identifier"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient"}}} |