[PATCH] serdev: serdev.h: clean up kernel-doc comments

From: Randy Dunlap

Date: Wed Mar 11 2026 - 01:23:57 EST


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@xxxxxxxxxxxxx>
---
Cc: Rob Herring <robh@xxxxxxxxxx>
Cc: linux-serial@xxxxxxxxxxxxxxx
Cc: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>

include/linux/serdev.h | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)

--- linux-next-20260309.orig/include/linux/serdev.h
+++ linux-next-20260309/include/linux/serdev.h
@@ -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_s
* 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_drv

/**
* 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

/**
* serdev_controller_put() - decrement controller refcount
- * @ctrl serdev controller.
+ * @ctrl: serdev controller.
*/
static inline void serdev_controller_put(struct serdev_controller *ctrl)
{