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
9.2 KiB
JSON
1 line
9.2 KiB
JSON
{"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Usage","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A model that represents the usage of an amiibo item within a certain game."}],"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Usage\/explanation","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Usage\/isWriteable"],"anchor":"Instance-Properties","generated":true}],"metadata":{"roleHeading":"Structure","externalID":"s:13AmiiboService0A0V5UsageV","extendedModule":"AmiiboService","navigatorTitle":[{"text":"Usage","kind":"identifier"}],"symbolKind":"struct","title":"Amiibo.Usage","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Usage","kind":"identifier"}],"role":"symbol","modules":[{"name":"AmiiboService"}]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Usage","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo"]]},"sections":[],"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/AmiiboService\/s8SendableP","doc:\/\/AmiiboService\/s16SendableMetatypeP"],"title":"Conforms To","type":"conformsTo"}],"seeAlsoSections":[{"anchor":"Models","generated":true,"identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Game","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Platform-swift.struct","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Release-swift.struct","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboType","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries"],"title":"Models"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiibo\/usage"]}],"references":{"doc://AmiiboService/documentation/AmiiboService/Amiibo/Release-swift.struct":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Release-swift.struct","abstract":[{"type":"text","text":"A model that represents a collection of release dates related to an amiibo item."}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Release"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Release","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/amiibo\/release-swift.struct","role":"symbol","type":"topic","title":"Amiibo.Release"},"doc://AmiiboService/documentation/AmiiboService/GameCharacter":{"url":"\/documentation\/amiiboservice\/gamecharacter","type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter","navigatorTitle":[{"kind":"identifier","text":"GameCharacter"}],"role":"symbol","abstract":[{"type":"text","text":"A model that represents a game character."}],"title":"GameCharacter","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"GameCharacter"}],"kind":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboSeries":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AmiiboSeries","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboSeries"}],"title":"AmiiboSeries","url":"\/documentation\/amiiboservice\/amiiboseries","type":"topic","abstract":[{"text":"A model that represents an amiibo series.","type":"text"}],"role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/Game":{"url":"\/documentation\/amiiboservice\/amiibo\/game","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Game","kind":"identifier"}],"navigatorTitle":[{"text":"Game","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"Amiibo.Game","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Game","abstract":[{"type":"text","text":"A model that represents a game related to an amiibo item."}]},"doc://AmiiboService/documentation/AmiiboService/Amiibo":{"url":"\/documentation\/amiiboservice\/amiibo","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Amiibo"}],"navigatorTitle":[{"kind":"identifier","text":"Amiibo"}],"kind":"symbol","role":"symbol","abstract":[{"text":"A model that represents an amiibo item.","type":"text"}],"title":"Amiibo","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/Usage/explanation":{"role":"symbol","url":"\/documentation\/amiiboservice\/amiibo\/usage\/explanation","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"explanation"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"title":"explanation","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Usage\/explanation","type":"topic","abstract":[{"text":"An explanation of how to use an amiibo item.","type":"text"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboType":{"url":"\/documentation\/amiiboservice\/amiibotype","type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboType","abstract":[{"type":"text","text":"A model that represents an amiibo type."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AmiiboType","kind":"identifier"}],"role":"symbol","title":"AmiiboType","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"AmiiboType"}]},"doc://AmiiboService/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/AmiiboService\/s8SendableP"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/Usage":{"role":"symbol","url":"\/documentation\/amiiboservice\/amiibo\/usage","kind":"symbol","navigatorTitle":[{"text":"Usage","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Usage","kind":"identifier"}],"title":"Amiibo.Usage","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Usage","type":"topic","abstract":[{"type":"text","text":"A model that represents the usage of an amiibo item within a certain game."}]},"doc://AmiiboService/documentation/AmiiboService/Amiibo/Platform-swift.struct":{"kind":"symbol","title":"Amiibo.Platform","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Platform"}],"navigatorTitle":[{"text":"Platform","kind":"identifier"}],"abstract":[{"type":"text","text":"A model that represents a collection of "},{"type":"codeVoice","code":"WiiU"},{"type":"text","text":", "},{"type":"codeVoice","code":"3DS"},{"type":"text","text":", and "},{"type":"codeVoice","code":"Switch"},{"type":"text","text":" games related to an amiibo item."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Platform-swift.struct","url":"\/documentation\/amiiboservice\/amiibo\/platform-swift.struct","type":"topic"},"doc://AmiiboService/documentation/AmiiboService/GameSeries":{"kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GameSeries","kind":"identifier"}],"navigatorTitle":[{"text":"GameSeries","kind":"identifier"}],"title":"GameSeries","url":"\/documentation\/amiiboservice\/gameseries","type":"topic","abstract":[{"type":"text","text":"A model that represents a game series."}],"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/Amiibo/Usage/isWriteable":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Usage\/isWriteable","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"isWriteable"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"A flag that indicates whether an amiibo item can save game data in it."}],"kind":"symbol","title":"isWriteable","url":"\/documentation\/amiiboservice\/amiibo\/usage\/iswriteable","type":"topic","role":"symbol"},"doc://AmiiboService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/AmiiboService\/s16SendableMetatypeP"}}} |