[PATCH net-next V2] net: xilinx: axienet: Fix kernel-doc warning for axienet_free_tx_chain return value

[PATCH net-next V2] net: xilinx: axienet: Fix kernel-doc warning for axienet_free_tx_chain return value

[Suraj Gupta]

Add proper "Return:" section in axienet_free_tx_chain() description.
The return value description was present in the function description
but not in the standardized format.
Move the return value description from the main description to a separate
"Return:" section to follow Linux kernel documentation standards.

Fixes below kernel-doc warning:
warning: No description found for return value of 'axienet_free_tx_chain'

Signed-off-by: Suraj Gupta <suraj.gupta2@amd.com>
Reviewed-by: Sean Anderson <sean.anderson@linux.dev>
Reviewed-by: Radhey Shyam Pandey <radhey.shyam.pandey@amd.com>
---
Changes in V2:
Drop mutex documentation patch.
Add Reviewed-by tags.
---
 drivers/net/ethernet/xilinx/xilinx_axienet_main.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/net/ethernet/xilinx/xilinx_axienet_main.c b/drivers/net/ethernet/xilinx/xilinx_axienet_main.c
index ec6d47dc984a..0cf776153508 100644
--- a/drivers/net/ethernet/xilinx/xilinx_axienet_main.c
+++ b/drivers/net/ethernet/xilinx/xilinx_axienet_main.c
@@ -773,7 +773,8 @@ static int axienet_device_reset(struct net_device *ndev)
  *
  * Would either be called after a successful transmit operation, or after
  * there was an error when setting up the chain.
- * Returns the number of packets handled.
+ *
+ * Return: The number of packets handled.
  */
 static int axienet_free_tx_chain(struct axienet_local *lp, u32 first_bd,
 				 int nr_bds, bool force, u32 *sizep, int budget)
-- 
2.25.1

Re: [PATCH net-next V2] net: xilinx: axienet: Fix kernel-doc warning for axienet_free_tx_chain return value

[Jakub Kicinski]

On Wed, 17 Sep 2025 18:19:48 +0530 Suraj Gupta wrote:
> Fixes below kernel-doc warning:
> warning: No description found for return value of 'axienet_free_tx_chain'

There are 4 warnings of this type in the file, could you fix all of
them in one patch?
-- 
pw-bot: cr