Javier Cicchelli
36eecc15fb
This PR contains the work done to address the issue #14, that recommends some tweaks to the generated documentation targeting Xcode and Github pages. To provide further details about the work done: - [x] written the *Getting Started* article in the documentation catalog; - [x] written the *AmiiboService* article in the documentation catalog; - [x] updated the text of the `README` file; - [x] downgraded the Swift tool version in the `Package` file to v5.5; - [x] added the missing header file to the `Package` file; - [x] updated the `SwiftLibs` package dependency to its latest release; - [x] re-generated the documentation targeting Xcode and Github pages. Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Reviewed-on: #15
1 line
6.2 KiB
JSON
1 line
6.2 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"wiiu"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","preciseIdentifier":"s:13AmiiboService0A0V","text":"Amiibo"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Game","preciseIdentifier":"s:13AmiiboService0A0V4GameV","text":"Game"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/amiiboservice\/amiibo\/games-swift.struct\/wiiu"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Games-swift.struct\/wiiu","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A list of "},{"type":"reference","isActive":true,"identifier":"https:\/\/en.wikipedia.org\/wiki\/Wii_U"},{"type":"text","text":" games the amiibo can be used with."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"wiiu"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"Amiibo","preciseIdentifier":"s:13AmiiboService0A0V"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Game","preciseIdentifier":"s:13AmiiboService0A0V4GameV"},{"kind":"text","text":"]"}],"title":"wiiu","roleHeading":"Instance Property","role":"symbol","symbolKind":"property","externalID":"s:13AmiiboService0A0V5GamesV4wiiuSayAC4GameVGvp","modules":[{"name":"AmiiboService"}]},"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Games-swift.struct"]]},"references":{"doc://AmiiboService/documentation/AmiiboService/Amiibo/Game":{"role":"symbol","title":"Amiibo.Game","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Game"}],"abstract":[{"type":"text","text":"This model structs represents a game that is related to an amiibo, when requested to the respective "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.amiiboapi.com\/docs\/#showGames"},{"type":"text","text":"."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Game","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Game"}],"url":"\/documentation\/amiiboservice\/amiibo\/game"},"https://www.amiiboapi.com/docs/#amiibo":{"title":"remote API endpoint","titleInlineContent":[{"type":"text","text":"remote API endpoint"}],"type":"link","identifier":"https:\/\/www.amiiboapi.com\/docs\/#amiibo","url":"https:\/\/www.amiiboapi.com\/docs\/#amiibo"},"https://en.wikipedia.org/wiki/Wii_U":{"title":"Nintendo WiiU system","titleInlineContent":[{"type":"text","text":"Nintendo WiiU system"}],"type":"link","identifier":"https:\/\/en.wikipedia.org\/wiki\/Wii_U","url":"https:\/\/en.wikipedia.org\/wiki\/Wii_U"},"https://www.amiiboapi.com":{"title":"Amiibo API","titleInlineContent":[{"type":"text","text":"Amiibo API"}],"type":"link","identifier":"https:\/\/www.amiiboapi.com","url":"https:\/\/www.amiiboapi.com"},"https://www.amiiboapi.com/docs/#showGames":{"title":"remote API endpoint","titleInlineContent":[{"type":"text","text":"remote API endpoint"}],"type":"link","identifier":"https:\/\/www.amiiboapi.com\/docs\/#showGames","url":"https:\/\/www.amiiboapi.com\/docs\/#showGames"},"doc://AmiiboService/documentation/AmiiboService":{"role":"collection","title":"AmiiboService","abstract":[{"type":"text","text":"Ready-to-use service that retrieves decoded entities from any of the "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.amiiboapi.com"},{"type":"text","text":" available endpoints."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice"},"doc://AmiiboService/documentation/AmiiboService/Amiibo":{"role":"symbol","title":"Amiibo","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Amiibo"}],"abstract":[{"type":"text","text":"This model struct represents an amiibo that is retrieved from the respective "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.amiiboapi.com\/docs\/#amiibo"},{"type":"text","text":"."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Amiibo"}],"url":"\/documentation\/amiiboservice\/amiibo"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/Games-swift.struct/wiiu":{"role":"symbol","title":"wiiu","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"wiiu"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"Amiibo","preciseIdentifier":"s:13AmiiboService0A0V"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Game","preciseIdentifier":"s:13AmiiboService0A0V4GameV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"A list of "},{"type":"reference","isActive":true,"identifier":"https:\/\/en.wikipedia.org\/wiki\/Wii_U"},{"type":"text","text":" games the amiibo can be used with."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Games-swift.struct\/wiiu","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiibo\/games-swift.struct\/wiiu"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/Games-swift.struct":{"role":"symbol","title":"Amiibo.Games","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Games"}],"abstract":[{"type":"text","text":"This model represents the list of games related to a particular amiibo, grouped by system."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Games-swift.struct","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Games"}],"url":"\/documentation\/amiiboservice\/amiibo\/games-swift.struct"}}} |