timekeeping: Fix up function documentation for the NMI safe accessors
authorThomas Gleixner <tglx@linutronix.de>
Sun, 15 Nov 2020 20:09:31 +0000 (21:09 +0100)
committerThomas Gleixner <tglx@linutronix.de>
Sun, 15 Nov 2020 22:47:24 +0000 (23:47 +0100)
commitc1ce406e80fb15fa52b2b48dfd48fad6f3d2a32f
treeba11b474ff09c3f20eee3d3f6f06986ca41a1a41
parente025b03113d27139ce2b28b82599018e4d8fa5f6
timekeeping: Fix up function documentation for the NMI safe accessors

Alex reported the following warning:

 kernel/time/timekeeping.c:464: warning: Function parameter or member
 'tkf' not described in '__ktime_get_fast_ns'

which is not entirely correct because the documented function is
ktime_get_mono_fast_ns() which does not have a parameter, but the
kernel-doc parser looks at the function declaration which follows the
comment and complains about the missing parameter documentation.

Aside of that the documentation for the rest of the NMI safe accessors is
either incomplete or missing.

  - Move the function documentation to the right place
  - Fixup the references and inconsistencies
  - Add the missing documentation for ktime_get_raw_fast_ns()

Reported-by: Alex Shi <alex.shi@linux.alibaba.com>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
kernel/time/timekeeping.c