]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
timekeeping: Add missing kernel-doc function comments
authorYang Li <yang.lee@linux.alibaba.com>
Fri, 7 Jun 2024 09:06:56 +0000 (17:06 +0800)
committerThomas Gleixner <tglx@linutronix.de>
Sun, 23 Jun 2024 17:57:30 +0000 (19:57 +0200)
Fixup the incomplete kernel-doc style comments for do_adjtimex() and
hardpps() by documenting the function parameters.

Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/r/20240607090656.104883-1-yang.lee@linux.alibaba.com
Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=9301
kernel/time/timekeeping.c

index da984a368a9590e71b51413a5d36b3beb95b6e91..2fa87dcfeda9c2f16b3613544ce10f363145d181 100644 (file)
@@ -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)
 {