math64: favor kernel-doc from header files
authorLiam Beguin <liambeguin@gmail.com>
Fri, 18 Nov 2022 18:23:07 +0000 (13:23 -0500)
committerJonathan Corbet <corbet@lwn.net>
Mon, 21 Nov 2022 21:30:53 +0000 (14:30 -0700)
commitd28a1de5d1128d6caef15fdc04d3f6484dc7264b
tree6ec0faaf031cbffa1cb6f54f067e472588ed923d
parent1f050e904dd6f2955eecbd22031d912ccb2e7683
math64: favor kernel-doc from header files

Fix the kernel-doc markings for div64 functions to point to the header
file instead of the lib/ directory.  This avoids having implementation
specific comments in generic documentation.  Furthermore, given that
some kernel-doc comments are identical, drop them from lib/math64 and
only keep there comments that add implementation details.

Signed-off-by: Liam Beguin <liambeguin@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20221118182309.3824530-1-liambeguin@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/core-api/kernel-api.rst
include/linux/math64.h
lib/math/div64.c