summaryrefslogtreecommitdiffstats
path: root/sound/core/jack.c
diff options
context:
space:
mode:
authorRandy Dunlap <rdunlap@infradead.org>2017-10-29 17:08:52 -0700
committerTakashi Iwai <tiwai@suse.de>2017-10-30 08:10:07 +0100
commit3f1185d6c9d3fe91aa85ec8d3f4d71207452c458 (patch)
tree3085c1979ccd1f4ea73c49134e7b651a29051184 /sound/core/jack.c
parent0202f5cd9aab127355f6b1de74058a670424d48a (diff)
downloadlinux-3f1185d6c9d3fe91aa85ec8d3f4d71207452c458.tar.gz
linux-3f1185d6c9d3fe91aa85ec8d3f4d71207452c458.tar.bz2
linux-3f1185d6c9d3fe91aa85ec8d3f4d71207452c458.zip
ALSA: fix kernel-doc build warning
Fix kernel-doc build error. A symbol that ends with an underscore character ('_') has special meaning in reST (reStructuredText), so add a '*' to prevent this error and to indicate that there are several of these values to choose from. ../sound/core/jack.c:312: ERROR: Unknown target name: "snd_jack_btn". Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Takashi Iwai <tiwai@suse.de>
Diffstat (limited to 'sound/core/jack.c')
-rw-r--r--sound/core/jack.c2
1 files changed, 1 insertions, 1 deletions
diff --git a/sound/core/jack.c b/sound/core/jack.c
index f652e90efd7e..84c2a17c56ee 100644
--- a/sound/core/jack.c
+++ b/sound/core/jack.c
@@ -310,7 +310,7 @@ EXPORT_SYMBOL(snd_jack_set_parent);
* @type: Jack report type for this key
* @keytype: Input layer key type to be reported
*
- * Map a SND_JACK_BTN_ button type to an input layer key, allowing
+ * Map a SND_JACK_BTN_* button type to an input layer key, allowing
* reporting of keys on accessories via the jack abstraction. If no
* mapping is provided but keys are enabled in the jack type then
* BTN_n numeric buttons will be reported.