Commit 20d60f85 authored Jun 24, 2020 by Lee Jones

mfd: ab3100-otp: Add missing colon(s) for all documented kerneldoc arguments

Kerneldoc validation gets confused if syntax isn't "@.*: ".

Adding the missing colons squashes the following W=1 warnings:

drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'dev' not described in 'ab3100_otp'
drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'locked' not described in 'ab3100_otp'
drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'freq' not described in 'ab3100_otp'
drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'paf' not described in 'ab3100_otp'
drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'imeich' not described in 'ab3100_otp'
drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'cid' not described in 'ab3100_otp'
drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'tac' not described in 'ab3100_otp'
drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'fac' not described in 'ab3100_otp'
drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'svn' not described in 'ab3100_otp'
drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'debugfs' not described in 'ab3100_otp'

Cc: Linus Walleij <linus.walleij@linaro.org>
Signed-off-by: Lee Jones <lee.jones@linaro.org>

parent 4976bfb8

drivers/mfd/ab3100-otp.c

+10 −10

Original line number	Diff line number	Diff line
		@@ -29,22 +29,22 @@

		/**
		* struct ab3100_otp
		* @dev containing device
		* @locked whether the OTP is locked, after locking, no more bits
		* @dev: containing device
		* @locked: whether the OTP is locked, after locking, no more bits
		* can be changed but before locking it is still possible
		* to change bits from 1->0.
		* @freq clocking frequency for the OTP, this frequency is either
		* @freq: clocking frequency for the OTP, this frequency is either
		* 32768Hz or 1MHz/30
		* @paf product activation flag, indicates whether this is a real
		* @paf: product activation flag, indicates whether this is a real
		* product (paf true) or a lab board etc (paf false)
		* @imeich if this is set it is possible to override the
		* @imeich: if this is set it is possible to override the
		* IMEI number found in the tac, fac and svn fields with
		* (secured) software
		* @cid customer ID
		* @tac type allocation code of the IMEI
		* @fac final assembly code of the IMEI
		* @svn software version number of the IMEI
		* @debugfs a debugfs file used when dumping to file
		* @cid: customer ID
		* @tac: type allocation code of the IMEI
		* @fac: final assembly code of the IMEI
		* @svn: software version number of the IMEI
		* @debugfs: a debugfs file used when dumping to file
		*/
		struct ab3100_otp {
		struct device *dev;

Admin message