ALSA: fix kernel-doc build warning
authorRandy Dunlap <rdunlap@infradead.org>
Mon, 30 Oct 2017 00:08:52 +0000 (17:08 -0700)
committerTakashi Iwai <tiwai@suse.de>
Mon, 30 Oct 2017 07:10:07 +0000 (08:10 +0100)
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>
sound/core/jack.c

index f652e90efd7e7a3a8ab38a254cdd50ba4b369dab..84c2a17c56ee3d645433358febe9a444d1fc5c41 100644 (file)
@@ -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.