time/timecounter: Fix inline documentation
authorRandy Dunlap <rdunlap@infradead.org>
Sun, 31 Mar 2024 17:26:47 +0000 (10:26 -0700)
committerIngo Molnar <mingo@kernel.org>
Mon, 1 Apr 2024 08:36:34 +0000 (10:36 +0200)
commitaa7cbefe65e455178c33eca308349e687d262ea7
tree5768598812c55309531f9d5cf6342ff3e4e32eac
parent39cd87c4eb2b893354f3b850f916353f2658ae6f
time/timecounter: Fix inline documentation

Fix kernel-doc warnings, text punctuation, and a kernel-doc marker
(change '%' to '&' to indicate a struct):

  timecounter.h:72: warning: No description found for return value of 'cyclecounter_cyc2ns'
  timecounter.h:85: warning: Function parameter or member 'tc' not described in 'timecounter_adjtime'
  timecounter.h:111: warning: No description found for return value of 'timecounter_read'
  timecounter.h:128: warning: No description found for return value of 'timecounter_cyc2time'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Ingo Molnar <mingo@kernel.org>
Link: https://lore.kernel.org/r/20240331172652.14086-2-rdunlap@infradead.org
include/linux/timecounter.h