-
-
Notifications
You must be signed in to change notification settings - Fork 25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation: add more comments #27
Comments
Created Pull request #28 as a starting point, this is nowhere complete and I would like to invite others who have more experience with Keyboard for support and PRs. |
Sorry for the delay in accepting your pull request, it got lost in my mailbox. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Description
The package is lacking some substantial documentation. Keyboard is quite powerful but the documentation doesn't reflect it. It was quite irritating for me at the beginning on what to do with the Keyboard, how to use and interact with it.
Proposed Solution
Add comments to structs, attributes, classes and funcs so docc can generate more detailed documentation.
Describe Alternatives You've Considered
More examples in Cookbook for Keyboard, like MIDI-Monitoring, touch location for velocity, using latching keyboard,programmatically unpressing keys, reading pressed keys to describe the tonic, ...
Additional Context
Does the multitouch bug still exist? if yes, i've been hunting it as well before reading in the repo. Might also briefly explain it in the doc. It's quite irritating that some interaction is possible in touch down and other not. https://github.com/AudioKit/AppleBugDemos/tree/main#swiftuigesturesblockuikittouches
The text was updated successfully, but these errors were encountered: