Skip to content
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

Open
mahal opened this issue Jan 18, 2024 · 2 comments
Open

Documentation: add more comments #27

mahal opened this issue Jan 18, 2024 · 2 comments

Comments

@mahal
Copy link
Contributor

mahal commented Jan 18, 2024

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

@mahal
Copy link
Contributor Author

mahal commented Jan 18, 2024

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.

@aure
Copy link
Member

aure commented Mar 5, 2024

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
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants