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 all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

9

include/linux/rfkill.h

View file