hrtimer: Fix kernel-doc markups
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Mon, 16 Nov 2020 10:18:14 +0000 (11:18 +0100)
committerThomas Gleixner <tglx@linutronix.de>
Mon, 16 Nov 2020 14:20:01 +0000 (15:20 +0100)
commit66981c37b3199d293c58f84cf2366e86a06e1a3d
tree5441025bec62a2c9877f7c1d038d91854aeac1fe
parentcc947f2b9c04113d84eeef67cc7c6326e1982019
hrtimer: Fix kernel-doc markups

The hrtimer_get_remaining() markup is documenting, instead,
__hrtimer_get_remaining(), as it is placed at the C file.

In order to properly document it, a kernel-doc markup is needed together
with the function prototype. So, add a new one, while preserving the
existing one, just fixing the function name.

The hrtimer_is_queued prototype has a typo: it is using
'=' instead of '-' to split: identifier - description
as required by kernel-doc markup.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/r/9dc87808c2fd07b7e050bafcd033c5ef05808fea.1605521731.git.mchehab+huawei@kernel.org
include/linux/hrtimer.h
kernel/time/hrtimer.c