timekeeping: Add missing kernel-doc function comments for do_adjtimex and hardpps
PATCH 1/1 timekeeping: Add missing kernel-doc function comments for do_adjtimex and hardpps
Add kernel-doc style comments for the do_adjtimex and hardpps functions. These comments provide descriptions for the function parameters and a concise function description to enhance code readability and maintainability in accordance with the kernel coding standards.
Reported-by Abaci Robot <[email protected]>
Signed-off-by Yang Li <[email protected]>
--- kernel/time/timekeeping.c | 3 +++ 1 file changed, 3 insertions(+)
kernel/time/timekeeping.c +3 -0
@@ -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) {
Signature · 1 line
2.20.1.7.g153144c
[tip: timers/core] timekeeping: Add missing kernel-doc function comments
The following commit has been merged into the timers/core branch of tip:
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 <[email protected]> AuthorDate: Fri, 07 Jun 2024 17:06:56 +08:00 Committer: Thomas Gleixner <[email protected]> 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 <[email protected]>
Signed-off-by Yang Li <[email protected]>
Signed-off-by Thomas Gleixner <[email protected]>
--- kernel/time/timekeeping.c | 3 +++ 1 file changed, 3 insertions(+)
kernel/time/timekeeping.c +3 -0
@@ -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) {