control: complement comment for subscribe API

When minus value is given as a parameter, the API returns whether
the caller has already subscribed or not.

This commit adds a comment about this so as better documentation.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
This commit is contained in:
Takashi Sakamoto 2015-02-10 00:27:19 +09:00 committed by Takashi Iwai
parent 56499c30b7
commit 4e398ddfcf

View file

@ -213,7 +213,7 @@ int snd_ctl_poll_descriptors_revents(snd_ctl_t *ctl, struct pollfd *pfds, unsign
/** /**
* \brief Ask to be informed about events (poll, #snd_async_add_ctl_handler, #snd_ctl_read) * \brief Ask to be informed about events (poll, #snd_async_add_ctl_handler, #snd_ctl_read)
* \param ctl CTL handle * \param ctl CTL handle
* \param subscribe 0 = unsubscribe, 1 = subscribe * \param subscribe 0 = unsubscribe, 1 = subscribe, -1 = check subscribe or not
* \return 0 on success otherwise a negative error code * \return 0 on success otherwise a negative error code
*/ */
int snd_ctl_subscribe_events(snd_ctl_t *ctl, int subscribe) int snd_ctl_subscribe_events(snd_ctl_t *ctl, int subscribe)