From: Jaroslav Kysela <perex@perex.cz>
Date: Thu, 11 Apr 2013 11:36:56 +0000 (+0200)
Subject: control: enhance doc for snd_ctl_ascii_value_parse() function
X-Git-Tag: v1.0.27~1
X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=201f28a008179e774a355f2f9e7cdadfe09fd63f;p=alsa-lib.git

control: enhance doc for snd_ctl_ascii_value_parse() function

Signed-off-by: Jaroslav Kysela <perex@perex.cz>
---

diff --git a/src/control/ctlparse.c b/src/control/ctlparse.c
index c442c44c..978977db 100644
--- a/src/control/ctlparse.c
+++ b/src/control/ctlparse.c
@@ -302,6 +302,9 @@ static int get_ctl_enum_item_index(snd_ctl_t *handle,
  * \param info CTL element info structure
  * \param value source ASCII string
  * \return zero on success, otherwise a negative error code
+ *
+ * Note: For toggle command, the dst must contain previous (current)
+ * state (do the #snd_ctl_elem_read call to obtain it).
  */
 int snd_ctl_ascii_value_parse(snd_ctl_t *handle,
 			      snd_ctl_elem_value_t *dst,