[PATCH v6 3/5] fpga: fpga-mgr: fix kernel-doc warnings
Nava kishore Manne
nava.manne at xilinx.com
Sat Apr 23 10:02:33 PDT 2022
warnings: No description found for return value of 'xxx'
In-order to fix the above kernel-doc warnings added the
'Return' description for 'devm_fpga_mgr_register_full()'
and 'devm_fpga_mgr_register()' APIs.
Signed-off-by: Nava kishore Manne <nava.manne at xilinx.com>
Acked-by: Xu Yilun <yilun.xu at intel.com>
---
Changes for v2:
-Replaced s/@return:/Return:/
Changes for v3:
-Updated commit description.
Changes for v4:
-Updated commit description.
Changes for v5:
-Updated commit description.
Changes for v6:
-None.
drivers/fpga/fpga-mgr.c | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/drivers/fpga/fpga-mgr.c b/drivers/fpga/fpga-mgr.c
index 24dee27c7897..a3595ecc3f79 100644
--- a/drivers/fpga/fpga-mgr.c
+++ b/drivers/fpga/fpga-mgr.c
@@ -731,6 +731,8 @@ static void devm_fpga_mgr_unregister(struct device *dev, void *res)
* @parent: fpga manager device from pdev
* @info: parameters for fpga manager
*
+ * Return: fpga manager pointer on success, negative error code otherwise.
+ *
* This is the devres variant of fpga_mgr_register_full() for which the unregister
* function will be called automatically when the managing device is detached.
*/
@@ -764,6 +766,8 @@ EXPORT_SYMBOL_GPL(devm_fpga_mgr_register_full);
* @mops: pointer to structure of fpga manager ops
* @priv: fpga manager private data
*
+ * Return: fpga manager pointer on success, negative error code otherwise.
+ *
* This is the devres variant of fpga_mgr_register() for which the
* unregister function will be called automatically when the managing
* device is detached.
--
2.25.1
More information about the linux-arm-kernel
mailing list