Commit 55dcf7a2 authored Nov 27, 2019 by Alexandre Belloni

rtc: interface: fix kerneldoc comments

Fix kerneldoc warnings:

drivers/rtc/interface.c:619: warning: Function parameter or member 'num' not described in 'rtc_handle_legacy_irq'
drivers/rtc/interface.c:619: warning: Function parameter or member 'mode' not described in 'rtc_handle_legacy_irq'
drivers/rtc/interface.c:804: warning: Function parameter or member 'rtc' not described in 'rtc_timer_enqueue'
drivers/rtc/interface.c:804: warning: Function parameter or member 'timer' not described in 'rtc_timer_enqueue'
drivers/rtc/interface.c:864: warning: Function parameter or member 'rtc' not described in 'rtc_timer_remove'
drivers/rtc/interface.c:864: warning: Function parameter or member 'timer' not described in 'rtc_timer_remove'
drivers/rtc/interface.c:900: warning: Function parameter or member 'work' not described in 'rtc_timer_do_work'
drivers/rtc/interface.c:1035: warning: Function parameter or member 'rtc' not described in 'rtc_read_offset'
drivers/rtc/interface.c:1035: warning: Function parameter or member 'offset' not described in 'rtc_read_offset'
drivers/rtc/interface.c:1070: warning: Function parameter or member 'rtc' not described in 'rtc_set_offset'
drivers/rtc/interface.c:1070: warning: Function parameter or member 'offset' not described in 'rtc_set_offset'

Link: https://lore.kernel.org/r/20191127082932.666869-1-alexandre.belloni@bootlin.com

Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>

parent 32c4d9e8

drivers/rtc/interface.c

+11 −10

Original line number	Diff line number	Diff line
		@@ -610,6 +610,8 @@ EXPORT_SYMBOL_GPL(rtc_update_irq_enable);
		/**
		* rtc_handle_legacy_irq - AIE, UIE and PIE event hook
		* @rtc: pointer to the rtc device
		* @num: number of occurence of the event
		* @mode: type of the event, RTC_AF, RTC_UF of RTC_PF
		*
		* This function is called when an AIE, UIE or PIE mode interrupt
		* has occurred (or been emulated).
		@@ -790,8 +792,8 @@ int rtc_irq_set_freq(struct rtc_device *rtc, int freq)

		/**
		* rtc_timer_enqueue - Adds a rtc_timer to the rtc_device timerqueue
		* @rtc rtc device
		* @timer timer being added.
		* @rtc: rtc device
		* @timer: timer being added.
		*
		* Enqueues a timer onto the rtc devices timerqueue and sets
		* the next alarm event appropriately.
		@@ -850,8 +852,8 @@ static void rtc_alarm_disable(struct rtc_device *rtc)

		/**
		* rtc_timer_remove - Removes a rtc_timer from the rtc_device timerqueue
		* @rtc rtc device
		* @timer timer being removed.
		* @rtc: rtc device
		* @timer: timer being removed.
		*
		* Removes a timer onto the rtc devices timerqueue and sets
		* the next alarm event appropriately.
		@@ -888,8 +890,7 @@ static void rtc_timer_remove(struct rtc_device rtc, struct rtc_timer timer)

		/**
		* rtc_timer_do_work - Expires rtc timers
		* @rtc rtc device
		* @timer timer being removed.
		* @work: work item
		*
		* Expires rtc timers. Reprograms next alarm event if needed.
		* Called via worktask.

Admin message