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

DocC documentation content fixes. (#6)

Browse Source 
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:
Javier Cicchelli
2025-09-09 18:58:18 +00:00
committed by Javier Cicchelli
parent 410a200661
commit b39fd8533b
117 changed files with 128 additions and 120 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/data/documentation/amiiboservice/amiiboservice/getamiibos(_:).json
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/data/documentation/amiiboservice/amiiboservice/getamiiboseries(_:).json
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/data/documentation/amiiboservice/amiiboservice/getamiibotypes(_:).json
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/data/documentation/amiiboservice/amiiboservice/getgamecharacters(_:).json
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/data/documentation/amiiboservice/amiiboservice/getgameseries(_:).json
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/data/documentation/amiiboservice/amiiboservice/getlastupdated().json
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/data/documentation/amiiboservice/amiiboservice/init(_:).json
+1 -1
View File
@@ -1 +1 @@
{"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/init(_:)","interfaceLanguage":"swift"},"abstract":[{"text":"Initializes this service with a specific client type.","type":"text"}],"kind":"symbol","sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"client"},{"kind":"text","text":": "},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","preciseIdentifier":"s:13AmiiboService0A6ClientO","kind":"typeIdentifier","text":"AmiiboClient"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A representation of a client to use to interact with the endpoints."}]}],"name":"client"}]}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService"]]},"metadata":{"modules":[{"name":"AmiiboService"}],"title":"init(_:)","symbolKind":"init","externalID":"s:13AmiiboServiceAAVyAbA0A6ClientOcfc","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13AmiiboService0A6ClientO","kind":"typeIdentifier","text":"AmiiboClient"},{"kind":"text","text":")"}],"roleHeading":"Initializer"},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiiboservice\/init(_:)"]}],"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/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/AmiiboService/init(_:)":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/init(_:)","abstract":[{"text":"Initializes this service with a specific client type.","type":"text"}],"title":"init(_:)","url":"\/documentation\/amiiboservice\/amiiboservice\/init(_:)","kind":"symbol","type":"topic","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A6ClientO","text":"AmiiboClient"},{"kind":"text","text":")"}]}}}
{"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"text":"Initializes this service with a specific client type.","type":"text"}],"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"client","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","text":"AmiiboClient","preciseIdentifier":"s:13AmiiboService0A6ClientO","kind":"typeIdentifier"},{"text":")","kind":"text"}],"platforms":["macOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A representation of a client to use to interact with the endpoints."}]}],"name":"client"}],"kind":"parameters"}],"variants":[{"paths":["\/documentation\/amiiboservice\/amiiboservice\/init(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService"]]},"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/init(_:)","interfaceLanguage":"swift"},"metadata":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"AmiiboClient","preciseIdentifier":"s:13AmiiboService0A6ClientO","kind":"typeIdentifier"},{"text":")","kind":"text"}],"externalID":"s:13AmiiboServiceAAVyAbA0A6ClientOcfc","roleHeading":"Initializer","title":"init(_:)","role":"symbol","modules":[{"name":"AmiiboService"}],"symbolKind":"init"},"sections":[],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboService/init(_:)":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"AmiiboClient","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A6ClientO"},{"text":")","kind":"text"}],"type":"topic","kind":"symbol","title":"init(_:)","url":"\/documentation\/amiiboservice\/amiiboservice\/init(_:)","role":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/init(_:)","abstract":[{"type":"text","text":"Initializes this service with a specific client type."}]},"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/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":{"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"}}}