pwm: omap-dmtimer: Repair pwm_omap_dmtimer_chip's broken kerneldoc header
authorLee Jones <lee.jones@linaro.org>
Mon, 29 Jun 2020 12:47:52 +0000 (13:47 +0100)
committerThierry Reding <thierry.reding@gmail.com>
Thu, 30 Jul 2020 09:27:12 +0000 (11:27 +0200)
Argument descriptions must be prepended with a '@' to be understood
by the kerneldoc tooling/parsers/validators.

Fixes the following W=1 warning:

  drivers/pwm/pwm-omap-dmtimer.c:70: warning: Function parameter or member 'dm_timer_pdev' not described in 'pwm_omap_dmtimer_chip'

Cc: Tony Lindgren <tony@atomide.com>
Cc: Joachim Eastwood <manabian@gmail.com>
Cc: NeilBrown <neilb@suse.de>
Cc: Grant Erickson <marathon96@gmail.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Thierry Reding <thierry.reding@gmail.com>
drivers/pwm/pwm-omap-dmtimer.c

index 0d31833db2e2cc335eced1030eae8348d8be2ab9..75cea7f2aff5eed3c5977c83601f55a97204492a 100644 (file)
@@ -58,7 +58,7 @@
  * @mutex:             Mutex to protect pwm apply state
  * @dm_timer:          Pointer to omap dm timer.
  * @pdata:             Pointer to omap dm timer ops.
- * dm_timer_pdev:      Pointer to omap dm timer platform device
+ * @dm_timer_pdev:     Pointer to omap dm timer platform device
  */
 struct pwm_omap_dmtimer_chip {
        struct pwm_chip chip;