Added more detailed functionality to vino/wiiu APIs. #6
Conversation
There was a problem hiding this comment.
Generally looks pretty good, thanks 👍 There's just a number of formatting, grammar, and description issues to work out. Where did all of this info come from as well?
You also did not update any of the README files, as that's where things like detailed docs/examples are located at the moment (see https://github.com/PretendoNetwork/applet-types/tree/master/3ds/cave for an example)
Also it seems pretty clear that you didn't read the contributing guide. Please read https://github.com/PretendoNetwork/.github/blob/master/.github/CONTRIBUTING.md before making any further changes or PRs
| * @param soundDevice - 1 for GamePad, 2 for TV, 3 for both | ||
| * @returns An object. Always empty | ||
| */ | ||
| playSound: (unk1: number, unk2: number) => {}; | ||
| playSound: (unk1: number, soundDevice: number) => {}; | ||
|
|
||
| /** | ||
| * Plays the given sound | ||
| * @param label - Label for the sound | ||
| * @param unk - Unknown | ||
| * @param soundDevice - 1 for GamePad, 2 for TV, 3 for both | ||
| * @returns An object. Always empty | ||
| * | ||
| * @remark | ||
| * | ||
| * Not all labels are available in every applet. Using an unsupported label plays no sound | ||
| */ | ||
| playSoundByName: (label: SoundEffect, unk: number) => {}; | ||
| playSoundByName: (label: SoundEffect, soundDevice: number) => {}; |
There was a problem hiding this comment.
soundDevice should be an enum if it's limited to certain values
| * @param unk - Unknown. Maybe a screen ID? | ||
| * @returns Unknown | ||
| * Returns a JPEG base64 screenshot | ||
| * @param screen - True for TV screen, False for GamePad screen |
There was a problem hiding this comment.
Why is False capitalized here? Also this sounds like it may be more of a number than a boolean now. Where did this information come from?
This might be better as an enum too tbh?
| * Unknown | ||
| * @param unk - Unknown. Maybe a screen ID? | ||
| * @returns Unknown | ||
| * Returns a JPEG base64 screenshot |
There was a problem hiding this comment.
Slight reword for clarity
| * Returns a JPEG base64 screenshot | |
| * Returns a base64 encoded JPEG screenshot of the selected screen |
| @@ -9,7 +9,7 @@ export default interface WiiUKeyboardAPI { | |||
|
|
|||
| /** | |||
| * Sets the keyboard language | |||
| * @param language - Keyboard language. Allowed values unknown | |||
| * @param language - Keyboard language. Result from wiiuSystemSetting.getLanguage().code | |||
There was a problem hiding this comment.
If you know what the allowed values are, they should be in an enum. The parameters should only document their types, values, and descriptions. They should not dictate the source of the values. That should be left for an example script or something, which is out of scope of this repository atm. There is an @example tag in TSDoc but I'm not sure it's worth adding to these types atm
| @@ -39,7 +39,7 @@ export default interface WiiULocalStorageAPI { | |||
| clear: () => void; | |||
|
|
|||
| /** | |||
| * Unknown | |||
| * Flushes the localStorage elements | |||
There was a problem hiding this comment.
This doesn't make much sense. The method name is write, however typically phrases like flush tend to mean something more like "purge" or "empty" when it comes to stored data. That contradicts the method name
| * @param left - Left position in screen | ||
| * @param top - Top position in screen |
There was a problem hiding this comment.
Same comments as before with in screen, extra spaces, etc.
| * Unknown | ||
| * @param unk - Unknown | ||
| * Delays emulated click | ||
| * @param seconds -Seconds to delay |
There was a problem hiding this comment.
| * @param seconds -Seconds to delay | |
| * @param seconds - Seconds to delay |
| * @param unk3 - Unknown | ||
| * @param unk4 - Unknown | ||
| * @param unk5 - Unknown | ||
| * @param unk6 - Unknown | ||
| * @returns Unknown | ||
| * @param type - 1 if show on top normally, 2 if hide clock, 3 if show on top normally but move clock to the top |
| * @param unk1 - Unknown | ||
| * @param unk2 - Unknown | ||
| * Sets an image in the title screen | ||
| * @param URL - PNG image URL |
There was a problem hiding this comment.
You've used URL before to seemingly only mean parts of a URL. IS this a fully qualified URL? Also do not fully caps the parameter names
| * Unknown | ||
| * @param unk1 - Unknown | ||
| * @param unk2 - Unknown | ||
| * Sets an image in the title screen |
There was a problem hiding this comment.
What is the "title screen" in this context? The screen that shows when the app is launched? Some screen in the app? Etc?
Added some more detailed explanations for functionality on the vino API (Nintendo TVii) and the other wiiu APIs (Miiverse, Nintendo eShop, Account Settings)
I have tested every function on all applets with different params and then added everything i could find for now here.
Changes: