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>
This commit was merged in pull request #6.
This commit is contained in:
@@ -1 +1 @@
|
||||
{"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiiboclient\/live(_:)"]}],"metadata":{"modules":[{"name":"AmiiboService"}],"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"}],"roleHeading":"Case","externalID":"s:13AmiiboService0A6ClientO4liveyAcA0a4LiveC0VcACmF","title":"AmiiboClient.live(_:)","role":"symbol","symbolKind":"case"},"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/live(_:)","interfaceLanguage":"swift"},"sections":[],"abstract":[{"type":"text","text":"A live Amiibo client to interact with the online service."}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"live","kind":"identifier"},{"text":"(","kind":"text"},{"text":"AmiiboLiveClient","kind":"typeIdentifier","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient","preciseIdentifier":"s:13AmiiboService0A10LiveClientV"},{"text":" = .init())","kind":"text"}],"platforms":["macOS"],"languages":["swift"]}]}],"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/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"},"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":{"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/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"}}}
|
||||
{"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"A live Amiibo client to interact with the online service."}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"live","kind":"identifier"},{"text":"(","kind":"text"},{"text":"AmiiboLiveClient","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A10LiveClientV"},{"text":" = .init())","kind":"text"}]}]}],"variants":[{"paths":["\/documentation\/amiiboservice\/amiiboclient\/live(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient"]]},"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/live(_:)","interfaceLanguage":"swift"},"metadata":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"live"},{"kind":"text","text":"("},{"text":"AmiiboLiveClient","preciseIdentifier":"s:13AmiiboService0A10LiveClientV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"externalID":"s:13AmiiboService0A6ClientO4liveyAcA0a4LiveC0VcACmF","roleHeading":"Case","title":"AmiiboClient.live(_:)","role":"symbol","modules":[{"name":"AmiiboService"}],"symbolKind":"case"},"sections":[],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboClient/live(_:)":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/live(_:)","role":"symbol","kind":"symbol","title":"AmiiboClient.live(_:)","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","preciseIdentifier":"s:13AmiiboService0A10LiveClientV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"url":"\/documentation\/amiiboservice\/amiiboclient\/live(_:)","type":"topic"},"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":{"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/AmiiboClient":{"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"AmiiboClient","kind":"identifier"}],"type":"topic","kind":"symbol","title":"AmiiboClient","url":"\/documentation\/amiiboservice\/amiiboclient","navigatorTitle":[{"text":"AmiiboClient","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/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"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient","url":"\/documentation\/amiiboservice\/amiiboliveclient","abstract":[{"type":"text","text":"A type that implements a live client to the online service."}],"navigatorTitle":[{"text":"AmiiboLiveClient","kind":"identifier"}],"type":"topic","title":"AmiiboLiveClient","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"AmiiboLiveClient","kind":"identifier"}],"kind":"symbol"}}}
|
||||
@@ -1 +1 @@
|
||||
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/mock(_:)"},"sections":[],"metadata":{"modules":[{"name":"AmiiboService"}],"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"mock"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"AmiiboMockClient","preciseIdentifier":"s:13AmiiboService0A10MockClientV"},{"kind":"text","text":")"}],"roleHeading":"Case","externalID":"s:13AmiiboService0A6ClientO4mockyAcA0a4MockC0VcACmF","title":"AmiiboClient.mock(_:)","symbolKind":"case","role":"symbol"},"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiiboclient\/mock(_:)"]}],"abstract":[{"text":"A mock Amiibo client, for testing purposes.","type":"text"}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"mock"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13AmiiboService0A10MockClientV","kind":"typeIdentifier","text":"AmiiboMockClient","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient"},{"kind":"text","text":")"}],"languages":["swift"]}]}],"references":{"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/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/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/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/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"}}}
|
||||
{"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"text":"A mock Amiibo client, for testing purposes.","type":"text"}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"mock","kind":"identifier"},{"text":"(","kind":"text"},{"text":"AmiiboMockClient","preciseIdentifier":"s:13AmiiboService0A10MockClientV","kind":"typeIdentifier","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient"},{"text":")","kind":"text"}],"platforms":["macOS"]}]}],"variants":[{"paths":["\/documentation\/amiiboservice\/amiiboclient\/mock(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient"]]},"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/mock(_:)","interfaceLanguage":"swift"},"metadata":{"symbolKind":"case","roleHeading":"Case","modules":[{"name":"AmiiboService"}],"externalID":"s:13AmiiboService0A6ClientO4mockyAcA0a4MockC0VcACmF","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"mock"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A10MockClientV","text":"AmiiboMockClient"},{"kind":"text","text":")"}],"role":"symbol","title":"AmiiboClient.mock(_:)"},"sections":[],"references":{"doc://AmiiboService/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"}],"type":"topic","url":"\/documentation\/amiiboservice\/amiiboclient\/mock(_:)","title":"AmiiboClient.mock(_:)","kind":"symbol","role":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/mock(_:)","abstract":[{"text":"A mock Amiibo client, for testing purposes.","type":"text"}]},"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":{"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/AmiiboClient":{"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"AmiiboClient","kind":"identifier"}],"type":"topic","kind":"symbol","title":"AmiiboClient","url":"\/documentation\/amiiboservice\/amiiboclient","navigatorTitle":[{"text":"AmiiboClient","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/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"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboMockClient":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient","role":"symbol","abstract":[{"text":"A type that implements a mock client, for testing purposes.","type":"text"}],"kind":"symbol","title":"AmiiboMockClient","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboMockClient","kind":"identifier"}],"navigatorTitle":[{"text":"AmiiboMockClient","kind":"identifier"}],"type":"topic","url":"\/documentation\/amiiboservice\/amiibomockclient"}}}
|
||||
Reference in New Issue
Block a user