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

math64.h: kernel-docs: Convert some markups into normal comments

There are several functions at math64.h that are also
defined at div64.c. As both are included at kernel-api.rst,
Sphinx 3.x complains about symbol duplication:

./lib/math/div64.c:73: WARNING: Duplicate C declaration, also defined in 'core-api/kernel-api'.
Declaration is 'div_s64_rem'.
./lib/math/div64.c:104: WARNING: Duplicate C declaration, also defined in 'core-api/kernel-api'.
Declaration is 'div64_u64_rem'.
./lib/math/div64.c:144: WARNING: Duplicate C declaration, also defined in 'core-api/kernel-api'.
Declaration is 'div64_u64'.
./lib/math/div64.c:172: WARNING: Duplicate C declaration, also defined in 'core-api/kernel-api'.
Declaration is 'div64_s64'.

In order to avoid Sphinx warnings about duplication, change the kernel-doc
markups to just comments at math64.h.

Reviewed-by: Vincenzo Frascino <vincenzo.frascino@arm.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

+4 -4
+4 -4
include/linux/math64.h
··· 28 28 return dividend / divisor; 29 29 } 30 30 31 - /** 31 + /* 32 32 * div_s64_rem - signed 64bit divide with 32bit divisor with remainder 33 33 * @dividend: signed 64bit dividend 34 34 * @divisor: signed 32bit divisor ··· 42 42 return dividend / divisor; 43 43 } 44 44 45 - /** 45 + /* 46 46 * div64_u64_rem - unsigned 64bit divide with 64bit divisor and remainder 47 47 * @dividend: unsigned 64bit dividend 48 48 * @divisor: unsigned 64bit divisor ··· 56 56 return dividend / divisor; 57 57 } 58 58 59 - /** 59 + /* 60 60 * div64_u64 - unsigned 64bit divide with 64bit divisor 61 61 * @dividend: unsigned 64bit dividend 62 62 * @divisor: unsigned 64bit divisor ··· 68 68 return dividend / divisor; 69 69 } 70 70 71 - /** 71 + /* 72 72 * div64_s64 - signed 64bit divide with 64bit divisor 73 73 * @dividend: signed 64bit dividend 74 74 * @divisor: signed 64bit divisor