]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
serdev: serdev.h: clean up kernel-doc comments
authorRandy Dunlap <rdunlap@infradead.org>
Wed, 11 Mar 2026 05:23:47 +0000 (22:23 -0700)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Thu, 12 Mar 2026 14:07:31 +0000 (15:07 +0100)
Correct kernel-doc comment format and add a missing to avoid
kernel-doc warnings:

Warning: include/linux/serdev.h:49 struct member 'write_comp' not
 described in 'serdev_device'
Warning: include/linux/serdev.h:49 struct member 'write_lock' not
 described in 'serdev_device'
Warning: include/linux/serdev.h:68 struct member 'shutdown' not described
 in 'serdev_device_driver'
Warning: include/linux/serdev.h:134 function parameter 'serdev' not
 described in 'serdev_device_put'
Warning: include/linux/serdev.h:162 function parameter 'ctrl' not
 described in 'serdev_controller_put'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://patch.msgid.link/20260311052347.305612-1-rdunlap@infradead.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
include/linux/serdev.h

index 5654c58eb73c07634a47d120d4074944c95c0c8b..090c93c08045d2f48c028fa811b8a3646d567c0d 100644 (file)
@@ -37,8 +37,8 @@ struct serdev_device_ops {
  * @nr:                Device number on serdev bus.
  * @ctrl:      serdev controller managing this device.
  * @ops:       Device operations.
- * @write_comp Completion used by serdev_device_write() internally
- * @write_lock Lock to serialize access when writing data
+ * @write_comp:        Completion used by serdev_device_write() internally
+ * @write_lock:        Lock to serialize access when writing data
  */
 struct serdev_device {
        struct device dev;
@@ -60,6 +60,7 @@ static inline struct serdev_device *to_serdev_device(struct device *d)
  *             structure.
  * @probe:     binds this driver to a serdev device.
  * @remove:    unbinds this driver from the serdev device.
+ * @shutdown:  shut down this serdev device.
  */
 struct serdev_device_driver {
        struct device_driver driver;
@@ -129,7 +130,7 @@ static inline void serdev_device_set_drvdata(struct serdev_device *serdev, void
 
 /**
  * serdev_device_put() - decrement serdev device refcount
- * @serdev     serdev device.
+ * @serdev:    serdev device.
  */
 static inline void serdev_device_put(struct serdev_device *serdev)
 {
@@ -157,7 +158,7 @@ static inline void serdev_controller_set_drvdata(struct serdev_controller *ctrl,
 
 /**
  * serdev_controller_put() - decrement controller refcount
- * @ctrl       serdev controller.
+ * @ctrl:      serdev controller.
  */
 static inline void serdev_controller_put(struct serdev_controller *ctrl)
 {