Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

ath: dfs_pri_detector: Demote zero/half completed kernel-doc headers

There are only a couple of these and none of them are conformant.

Fixes the following W=1 kernel build warning(s):

drivers/net/wireless/ath/dfs_pri_detector.c:39: warning: Function parameter or member 'head' not described in 'pulse_elem'
drivers/net/wireless/ath/dfs_pri_detector.c:46: warning: Function parameter or member 'val' not described in 'pde_get_multiple'
drivers/net/wireless/ath/dfs_pri_detector.c:46: warning: Function parameter or member 'fraction' not described in 'pde_get_multiple'
drivers/net/wireless/ath/dfs_pri_detector.c:46: warning: Function parameter or member 'tolerance' not described in 'pde_get_multiple'

Cc: Kalle Valo <kvalo@codeaurora.org>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: linux-wireless@vger.kernel.org
Cc: netdev@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Kalle Valo <kvalo@codeaurora.org>
Link: https://lore.kernel.org/r/20201102112410.1049272-23-lee.jones@linaro.org

authored by

Lee Jones and committed by
Kalle Valo
748d2507 206cd580

+4 -5
+4 -5
drivers/net/wireless/ath/dfs_pri_detector.c
··· 29 29 (MIN + PRI_TOLERANCE == MAX - PRI_TOLERANCE ? \ 30 30 MIN + PRI_TOLERANCE : RUNTIME) 31 31 32 - /** 32 + /* 33 33 * struct pulse_elem - elements in pulse queue 34 - * @ts: time stamp in usecs 35 34 */ 36 35 struct pulse_elem { 37 36 struct list_head head; 38 37 u64 ts; 39 38 }; 40 39 41 - /** 40 + /* 42 41 * pde_get_multiple() - get number of multiples considering a given tolerance 43 - * @return factor if abs(val - factor*fraction) <= tolerance, 0 otherwise 42 + * Return value: factor if abs(val - factor*fraction) <= tolerance, 0 otherwise 44 43 */ 45 44 static u32 pde_get_multiple(u32 val, u32 fraction, u32 tolerance) 46 45 { ··· 69 70 return factor; 70 71 } 71 72 72 - /** 73 + /* 73 74 * DOC: Singleton Pulse and Sequence Pools 74 75 * 75 76 * Instances of pri_sequence and pulse_elem are kept in singleton pools to