[PATCH v2] fpga: dfl: fme: revise kernel-doc comments for some functions

From: Peter Colberg
Date: Tue Apr 02 2024 - 16:48:08 EST


From: Xu Yilun <yilun.xu@xxxxxxxxx>

This amends commit 782d8e61b5d6 ("fpga: dfl: kernel-doc corrections"),
which separately addressed the kernel-doc warnings below. Add a more
precise description of the feature argument to dfl_fme_create_mgr(),
and also use plural in the description of dfl_fme_destroy_bridges().

lkp reported 2 build warnings:

drivers/fpga/dfl/dfl-fme-pr.c:175: warning: Function parameter or member 'feature' not described in 'dfl_fme_create_mgr'

>> drivers/fpga/dfl/dfl-fme-pr.c:280: warning: expecting prototype for
>> dfl_fme_destroy_bridge(). Prototype was for dfl_fme_destroy_bridges()
>> instead

Fixes: 29de76240e86 ("fpga: dfl: fme: add partial reconfiguration sub feature support")
Reported-by: kernel test robot <lkp@xxxxxxxxx>
Signed-off-by: Xu Yilun <yilun.xu@xxxxxxxxx>
Signed-off-by: Peter Colberg <peter.colberg@xxxxxxxxx>
---
v2:
- Correctly rebase patch onto commit 782d8e61b5d6.
---
drivers/fpga/dfl-fme-pr.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/fpga/dfl-fme-pr.c b/drivers/fpga/dfl-fme-pr.c
index cdcf6dea4cc9..b66f2c1e10a9 100644
--- a/drivers/fpga/dfl-fme-pr.c
+++ b/drivers/fpga/dfl-fme-pr.c
@@ -164,7 +164,7 @@ static int fme_pr(struct platform_device *pdev, unsigned long arg)

/**
* dfl_fme_create_mgr - create fpga mgr platform device as child device
- * @feature: sub feature info
+ * @feature: the dfl fme PR sub feature
* @pdata: fme platform_device's pdata
*
* Return: mgr platform device if successful, and error code otherwise.
@@ -273,7 +273,7 @@ static void dfl_fme_destroy_bridge(struct dfl_fme_bridge *fme_br)
}

/**
- * dfl_fme_destroy_bridges - destroy all fpga bridge platform device
+ * dfl_fme_destroy_bridges - destroy all fpga bridge platform devices
* @pdata: fme platform device's pdata
*/
static void dfl_fme_destroy_bridges(struct dfl_feature_platform_data *pdata)
--
2.44.0