summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLiam Beguin <liambeguin@gmail.com>2022-11-18 13:23:09 -0500
committerJonathan Corbet <corbet@lwn.net>2022-11-21 14:30:54 -0700
commita898db21cc8ff4205784253355d330517983bbbb (patch)
tree74d31424fcfbddc322fa0f61a646ebe5187aee35
parent090f13cac84d618d8d391e72646bea462aae9486 (diff)
downloadlinux-a898db21cc8ff4205784253355d330517983bbbb.tar.bz2
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>
-rw-r--r--include/linux/math64.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/include/linux/math64.h b/include/linux/math64.h
index cf3b0099674a..8958f4c005c1 100644
--- a/include/linux/math64.h
+++ b/include/linux/math64.h
@@ -120,6 +120,8 @@ extern s64 div64_s64(s64 dividend, s64 divisor);
* This is the most common 64bit divide and should be used if possible,
* as many 32bit archs can optimize this variant better than a full 64bit
* divide.
+ *
+ * Return: dividend / divisor
*/
#ifndef div_u64
static inline u64 div_u64(u64 dividend, u32 divisor)
@@ -133,6 +135,8 @@ static inline u64 div_u64(u64 dividend, u32 divisor)
* div_s64 - signed 64bit divide with 32bit divisor
* @dividend: signed 64bit dividend
* @divisor: signed 32bit divisor
+ *
+ * Return: dividend / divisor
*/
#ifndef div_s64
static inline s64 div_s64(s64 dividend, s32 divisor)