[alsa-devel] [PATCH v2] control: complement comment for subscribe API

[Takashi Sakamoto]

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 at sakamocchi.jp>
---
 src/control/control.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/control/control.c b/src/control/control.c
index dd428a1..4a28cf6 100644
--- a/src/control/control.c
+++ b/src/control/control.c
@@ -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)
  * \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
  */
 int snd_ctl_subscribe_events(snd_ctl_t *ctl, int subscribe)
-- 
2.1.0