[tip: timers/core] timekeeping: Add missing kernel-doc function comments

From: tip-bot2 for Yang Li
Date: Sun Jun 23 2024 - 14:02:01 EST


The following commit has been merged into the timers/core branch of tip:

Commit-ID: e1b6a78b58aa859c66a32cfaeb121df87631d4ed
Gitweb: https://git.kernel.org/tip/e1b6a78b58aa859c66a32cfaeb121df87631d4ed
Author: Yang Li <yang.lee@xxxxxxxxxxxxxxxxx>
AuthorDate: Fri, 07 Jun 2024 17:06:56 +08:00
Committer: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
CommitterDate: Sun, 23 Jun 2024 19:57:30 +02:00

timekeeping: Add missing kernel-doc function comments

Fixup the incomplete kernel-doc style comments for do_adjtimex() and
hardpps() by documenting the function parameters.

Reported-by: Abaci Robot <abaci@xxxxxxxxxxxxxxxxx>
Signed-off-by: Yang Li <yang.lee@xxxxxxxxxxxxxxxxx>
Signed-off-by: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
Link: https://lore.kernel.org/r/20240607090656.104883-1-yang.lee@xxxxxxxxxxxxxxxxx
Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=9301
---
kernel/time/timekeeping.c | 3 +++
1 file changed, 3 insertions(+)

diff --git a/kernel/time/timekeeping.c b/kernel/time/timekeeping.c
index da984a3..2fa87dc 100644
--- a/kernel/time/timekeeping.c
+++ b/kernel/time/timekeeping.c
@@ -2547,6 +2547,7 @@ EXPORT_SYMBOL_GPL(random_get_entropy_fallback);

/**
* do_adjtimex() - Accessor function to NTP __do_adjtimex function
+ * @txc: Pointer to kernel_timex structure containing NTP parameters
*/
int do_adjtimex(struct __kernel_timex *txc)
{
@@ -2615,6 +2616,8 @@ int do_adjtimex(struct __kernel_timex *txc)
#ifdef CONFIG_NTP_PPS
/**
* hardpps() - Accessor function to NTP __hardpps function
+ * @phase_ts: Pointer to timespec64 structure representing phase timestamp
+ * @raw_ts: Pointer to timespec64 structure representing raw timestamp
*/
void hardpps(const struct timespec64 *phase_ts, const struct timespec64 *raw_ts)
{