Am 30.10.20 um 12:31 schrieb Matthew Wilcox:
On Fri, Oct 30, 2020 at 08:37:48AM +0100, Mauro Carvalho Chehab wrote:
Just changing the kernel-doc markup at kernel/futex.c:
/**
* futex_setup_timer - set up the sleeping hrtimer.
* @time: ptr to the given timeout value
* @timeout: the hrtimer_sleeper structure to be set up
* @flags: futex flags
* @range_ns: optional range in ns
*
* Return: Initialized hrtimer_sleeper structure or NULL if no timeout
* value given
*/
To:
...
* Return:
*
* Initialized hrtimer_sleeper structure or NULL if no timeout
* value given
*/
Should fix it.
Or just remove the indent.
* Return: Initialized hrtimer_sleeper structure or NULL if no timeout
* value given.
To add my 2 cent:
The return value should be described in a dedicated section
named "Return:", like shown im Mauro's example (compare [1]).
For on-liners I think it is OK to use the short form (compare [2]).
[1] https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#return-values
[2]
https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#function-documentation
-- Markus --
