diff options
| author | Alex Shi <alex.shi@linux.alibaba.com> | 2020-11-13 15:24:30 +0800 |
|---|---|---|
| committer | Thomas Gleixner <tglx@linutronix.de> | 2020-11-15 23:47:23 +0100 |
| commit | a0f5a65fa5faeef708d022698d5fcba290a35856 (patch) | |
| tree | 5631d4e28d0856846b81e332b79333d9caccb3d5 /kernel/time | |
| parent | c725dafc95f1b37027840aaeaa8b7e4e9cd20516 (diff) | |
time: Add missing colons for parameter documentation of time64_to_tm()
Address these kernel-doc warnings:
kernel/time/timeconv.c:79: warning: Function parameter or member
'totalsecs' not described in 'time64_to_tm'
kernel/time/timeconv.c:79: warning: Function parameter or member
'offset' not described in 'time64_to_tm'
kernel/time/timeconv.c:79: warning: Function parameter or member
'result' not described in 'time64_to_tm'
The parameters are described but lack colons after the parameter name.
[ tglx: Massaged changelog ]
Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/r/1605252275-63652-1-git-send-email-alex.shi@linux.alibaba.com
Diffstat (limited to 'kernel/time')
| -rw-r--r-- | kernel/time/timeconv.c | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/kernel/time/timeconv.c b/kernel/time/timeconv.c index 589e0a552129..62e3b46717a6 100644 --- a/kernel/time/timeconv.c +++ b/kernel/time/timeconv.c @@ -70,10 +70,10 @@ static const unsigned short __mon_yday[2][13] = { /** * time64_to_tm - converts the calendar time to local broken-down time * - * @totalsecs the number of seconds elapsed since 00:00:00 on January 1, 1970, + * @totalsecs: the number of seconds elapsed since 00:00:00 on January 1, 1970, * Coordinated Universal Time (UTC). - * @offset offset seconds adding to totalsecs. - * @result pointer to struct tm variable to receive broken-down time + * @offset: offset seconds adding to totalsecs. + * @result: pointer to struct tm variable to receive broken-down time */ void time64_to_tm(time64_t totalsecs, int offset, struct tm *result) { |