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