github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-09-22 12:44:03 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

rfkill: repair malformed kernel-doc and add some descriptions

Browse Source 
Use kernel-doc format for function descriptions and add the missing
function parameter descriptions to avoid kernel-doc warnings:

Warning: ../include/linux/rfkill.h:102 This comment starts with '/**',
 but isn't a kernel-doc comment.
 * rfkill_pause_polling(struct rfkill *rfkill)
Warning: include/linux/rfkill.h:109 function parameter 'rfkill' not
 described in 'rfkill_pause_polling'
Warning: ../include/linux/rfkill.h:112 This comment starts with '/**',
 but isn't a kernel-doc comment.
 * rfkill_resume_polling(struct rfkill *rfkill)
Warning: include/linux/rfkill.h:117 function parameter 'rfkill' not
 described in 'rfkill_resume_polling'
Warning: ../include/linux/rfkill.h:330 function parameter 'rfkill' not
 described in 'rfkill_get_led_trigger_name'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://patch.msgid.link/20260723162750.167914-1-rdunlap@infradead.org
Signed-off-by: Johannes Berg <johannes.berg@intel.com>
This commit is contained in:
Randy Dunlap 2026-07-23 09:27:50 -07:00 committed by Johannes Berg
parent c706dc5da6
commit 36743788d6
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
include/linux/rfkill.h
View File

@ -100,7 +100,8 @@ struct rfkill * __must_check rfkill_alloc(const char *name,
int __must_check rfkill_register(struct rfkill *rfkill);
/**
* rfkill_pause_polling(struct rfkill *rfkill)
* rfkill_pause_polling - Pause polling
* @rfkill: rfkill struct
*
* Pause polling -- say transmitter is off for other reasons.
* NOTE: not necessary for suspend/resume -- in that case the
@ -110,9 +111,9 @@ int __must_check rfkill_register(struct rfkill *rfkill);
void rfkill_pause_polling(struct rfkill *rfkill);
/**
* rfkill_resume_polling(struct rfkill *rfkill)
* rfkill_resume_polling - Resume polling
* @rfkill: rfkill struct
*
* Resume polling
* NOTE: not necessary for suspend/resume -- in that case the
* core stops polling anyway
*/
@ -325,6 +326,8 @@ static inline enum rfkill_type rfkill_find_type(const char *name)
#ifdef CONFIG_RFKILL_LEDS
/**
* rfkill_get_led_trigger_name - Get the LED trigger name for the button's LED.
* @rfkill: rfkill struct
*
* This function might return a NULL pointer if registering of the
* LED trigger failed. Use this as "default_trigger" for the LED.
*/