free-audio / clap

Audio Plugin API
https://cleveraudio.org/
MIT License
1.78k stars 100 forks source link

gui: lots of functions lack what return value means. #299

Closed atsushieno closed 1 year ago

atsushieno commented 1 year ago

Those functions in gui extension lacks documentation comment on what the return value means, for example in clap_plugin_gui :

It is not a comprehensive list. I think the entire specification should be reviewed and see if the overall documentation lacks description on parameters and return values, at least on non-draft ones.

abique commented 1 year ago

If those function return false, then it means they failed.

For example the GUI is on another computer, and your communication via the socket failed in get_size() so it returns false and the host should discard the with and height.

niswegmann commented 1 year ago

@abique, the function suggest_title in clap/ext/gui.h returns void and therefore shouldn't have the comment "Returns true on success.".