Skip to content

Update setcontrolcallback.md #47

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

minosimo
Copy link
Contributor

@minosimo minosimo commented Feb 5, 2025

No description provided.

@davidhealey
Copy link
Collaborator

This applies to all components so I'm not sure it should be specified for each one individually in the docs.

Perhaps it would be better to include it in this section of the docs. This section currently refers only to the per processor on control callback but could be expanded out to explain that it's deprecated and it's now better to use individual control callbacks.

Also probably worth mentioning that the control callback will be triggered after on init completes if the component has saveInPreset enabled.

@minosimo
Copy link
Contributor Author

minosimo commented Feb 5, 2025

Riiight. That's tricky, I don't think I'd ever find it in onControl callback. The problem is that it's simultaneously documentation and an api reference, so almost none of the entries for the ui component Class Methods are useful without repeating the same descriptions for all controls.

I'd almost suggest hiding all the entries that are shared between controls, and expanding plugin-components with descriptions of the common functions? The shared properties are already there.

@davidhealey
Copy link
Collaborator

I'd almost suggest hiding all the entries that are shared between controls, and expanding plugin-components with descriptions of the common functions?

Seems sensible to me, I'm not sure how it would work with the auto doc generation though. That would require Christoph or Dominik I think

@minosimo
Copy link
Contributor Author

minosimo commented Mar 3, 2025

Are the .md files in this repo also autogenerated? I found the doc generator in the HISE source but I thought that was no longer used now this hand-crafted repo exists.

@davidhealey
Copy link
Collaborator

I think the doc generator is still used, but not sure how it all works together with the new system.

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

Successfully merging this pull request may close these issues.

2 participants