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

math64: fix kernel-doc return value warnings

Fix the following kernel-doc warnings by adding a description for return
values of div_[us]64.

math64.h:126: warning: No description found for return value of 'div_u64'
math64.h:139: warning: No description found for return value of 'div_s64'

Signed-off-by: Liam Beguin <liambeguin@gmail.com>
Link: https://lore.kernel.org/r/20221118182309.3824530-3-liambeguin@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Liam Beguin and committed by
Jonathan Corbet
a898db21 090f13ca

+4
+4
include/linux/math64.h
··· 120 120 * This is the most common 64bit divide and should be used if possible, 121 121 * as many 32bit archs can optimize this variant better than a full 64bit 122 122 * divide. 123 + * 124 + * Return: dividend / divisor 123 125 */ 124 126 #ifndef div_u64 125 127 static inline u64 div_u64(u64 dividend, u32 divisor) ··· 135 133 * div_s64 - signed 64bit divide with 32bit divisor 136 134 * @dividend: signed 64bit dividend 137 135 * @divisor: signed 32bit divisor 136 + * 137 + * Return: dividend / divisor 138 138 */ 139 139 #ifndef div_s64 140 140 static inline s64 div_s64(s64 dividend, s32 divisor)