Skip to content

Commit 55dcf7a

Browse files
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/[email protected] Signed-off-by: Alexandre Belloni <[email protected]>
1 parent 32c4d9e commit 55dcf7a

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

drivers/rtc/interface.c

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -610,6 +610,8 @@ EXPORT_SYMBOL_GPL(rtc_update_irq_enable);
610610
/**
611611
* rtc_handle_legacy_irq - AIE, UIE and PIE event hook
612612
* @rtc: pointer to the rtc device
613+
* @num: number of occurence of the event
614+
* @mode: type of the event, RTC_AF, RTC_UF of RTC_PF
613615
*
614616
* This function is called when an AIE, UIE or PIE mode interrupt
615617
* has occurred (or been emulated).
@@ -790,8 +792,8 @@ int rtc_irq_set_freq(struct rtc_device *rtc, int freq)
790792

791793
/**
792794
* rtc_timer_enqueue - Adds a rtc_timer to the rtc_device timerqueue
793-
* @rtc rtc device
794-
* @timer timer being added.
795+
* @rtc: rtc device
796+
* @timer: timer being added.
795797
*
796798
* Enqueues a timer onto the rtc devices timerqueue and sets
797799
* the next alarm event appropriately.
@@ -850,8 +852,8 @@ static void rtc_alarm_disable(struct rtc_device *rtc)
850852

851853
/**
852854
* rtc_timer_remove - Removes a rtc_timer from the rtc_device timerqueue
853-
* @rtc rtc device
854-
* @timer timer being removed.
855+
* @rtc: rtc device
856+
* @timer: timer being removed.
855857
*
856858
* Removes a timer onto the rtc devices timerqueue and sets
857859
* the next alarm event appropriately.
@@ -888,8 +890,7 @@ static void rtc_timer_remove(struct rtc_device *rtc, struct rtc_timer *timer)
888890

889891
/**
890892
* rtc_timer_do_work - Expires rtc timers
891-
* @rtc rtc device
892-
* @timer timer being removed.
893+
* @work: work item
893894
*
894895
* Expires rtc timers. Reprograms next alarm event if needed.
895896
* Called via worktask.
@@ -1022,8 +1023,8 @@ void rtc_timer_cancel(struct rtc_device *rtc, struct rtc_timer *timer)
10221023

10231024
/**
10241025
* rtc_read_offset - Read the amount of rtc offset in parts per billion
1025-
* @ rtc: rtc device to be used
1026-
* @ offset: the offset in parts per billion
1026+
* @rtc: rtc device to be used
1027+
* @offset: the offset in parts per billion
10271028
*
10281029
* see below for details.
10291030
*
@@ -1051,8 +1052,8 @@ int rtc_read_offset(struct rtc_device *rtc, long *offset)
10511052

10521053
/**
10531054
* rtc_set_offset - Adjusts the duration of the average second
1054-
* @ rtc: rtc device to be used
1055-
* @ offset: the offset in parts per billion
1055+
* @rtc: rtc device to be used
1056+
* @offset: the offset in parts per billion
10561057
*
10571058
* Some rtc's allow an adjustment to the average duration of a second
10581059
* to compensate for differences in the actual clock rate due to temperature,

0 commit comments

Comments
 (0)