Subject: Re: [PATCH net-next v3 1/6] net: libwx: Add malibox api for wangxun pf drivers

From: Simon Horman <[email-masked]>
Date: Wed, 15 May 2024 16:28:13 +0100

On Wed, May 15, 2024 at 05:50:04PM +0800, Mengyuan Lou wrote:
> Implements the mailbox interfaces for wangxun pf drivers
> ngbe and txgbe.
> 
> Signed-off-by: Mengyuan Lou <[email-masked]>

...

> diff --git a/drivers/net/ethernet/wangxun/libwx/wx_mbx.c b/drivers/net/ethernet/wangxun/libwx/wx_mbx.c
> new file mode 100644
> index 000000000000..26842043630b
> --- /dev/null
> +++ b/drivers/net/ethernet/wangxun/libwx/wx_mbx.c
> @@ -0,0 +1,191 @@
> +// SPDX-License-Identifier: GPL-2.0
> +/* Copyright (c) 2015 - 2024 Beijing WangXun Technology Co., Ltd. */
> +#include <linux/pci.h>
> +#include "wx_type.h"
> +#include "wx_mbx.h"
> +
> +/**
> + *  wx_obtain_mbx_lock_pf - obtain mailbox lock
> + *  @wx: pointer to the HW structure
> + *  @vf: the VF index
> + *
> + *  return SUCCESS if we obtained the mailbox lock
> + **/

Thanks for including a return section in Kernel docs.
It seems that the correct format is (case insensitive)
one of:

* return: ...
* returns: ...

So I think you need to add a ':'.

Likewise elsewhere in this patch-set.

Flagged by ./scripts/kernel-doc -none -Wall

...