Commit a0f5a65f authored Nov 13, 2020 by Alex Shi Committed by Thomas Gleixner Nov 15, 2020

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

parent c725dafc

kernel/time/timeconv.c

+3 −3

Original line number	Diff line number	Diff line
		@@ -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)
		{

Admin message