[PATCH] platform/raspberrypi: vchiq: Fix kernel-doc Return section

[PATCH] platform/raspberrypi: vchiq: Fix kernel-doc Return section

[Tomasz Unger]

scripts/kernel-doc -Wall reports that vchiq_register_chrdev() has no
description of its return value:

  Warning: drivers/platform/raspberrypi/vchiq-interface/vchiq_dev.c:1341
  No description found for return value of 'vchiq_register_chrdev'

The comment does describe it, but in a free-form "Returns 0 on success
..." sentence that kernel-doc does not recognize. Convert it to a
"Return:" section.

No functional change.

Signed-off-by: Tomasz Unger <tomasz.unger@yahoo.pl>
---
 drivers/platform/raspberrypi/vchiq-interface/vchiq_dev.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/platform/raspberrypi/vchiq-interface/vchiq_dev.c b/drivers/platform/raspberrypi/vchiq-interface/vchiq_dev.c
index f1c9c0d4b96a..7dfeebbf34d3 100644
--- a/drivers/platform/raspberrypi/vchiq-interface/vchiq_dev.c
+++ b/drivers/platform/raspberrypi/vchiq-interface/vchiq_dev.c
@@ -1336,7 +1336,7 @@ static struct miscdevice vchiq_miscdev = {
  *				device files in userspace.
  *	@parent:	The parent of the char device.
  *
- *	Returns 0 on success else returns the error code.
+ *	Return: 0 on success, or a negative error code on failure.
  */
 int vchiq_register_chrdev(struct device *parent)
 {

---
base-commit: 6628e7d4c6b25c8d18f1345e3a20d21829aae7e4
change-id: 20261110-vchiq-dev-kdoc-return-5ba9491d7f0c

Best regards,
--  
Tomasz Unger <tomasz.unger@yahoo.pl>