[PATCH] macintosh: macio_asic: fix macio_add_one_device() kernel-doc

[PATCH] macintosh: macio_asic: fix macio_add_one_device() kernel-doc

[Rosen Penev]

The kernel-doc comment for macio_add_one_device() does not describe
@parent and @parent_res or the return value, and describes @in_bay as
a flag although it is the media-bay device the new device sits in.

Document the missing parameters and the return value, and correct the
@in_bay description.

Assisted-by: LLM
Signed-off-by: Rosen Penev <rosenp@gmail.com>
---
 drivers/macintosh/macio_asic.c | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/drivers/macintosh/macio_asic.c b/drivers/macintosh/macio_asic.c
index ee3caa3d87d1..04fb0ffc2301 100644
--- a/drivers/macintosh/macio_asic.c
+++ b/drivers/macintosh/macio_asic.c
@@ -349,11 +349,15 @@ static void macio_setup_resources(struct macio_dev *dev,
 /**
  * macio_add_one_device - Add one device from OF node to the device tree
  * @chip: pointer to the macio_chip holding the device
+ * @parent: device to register the new device under
  * @np: pointer to the device node in the OF tree
- * @in_bay: set to 1 if device is part of a media-bay
+ * @in_bay: media-bay device this one sits in, or NULL
+ * @parent_res: resource to insert the device's resources under
  *
  * When media-bay is changed to hotswap drivers, this function will
  * be exposed to the bay driver some way...
+ *
+ * Return: the new macio_dev, or NULL on failure.
  */
 static struct macio_dev * macio_add_one_device(struct macio_chip *chip,
 					       struct device *parent,
-- 
2.56.0