Re: [PATCH v2] ipw2x00: Minor documentation update

[Randy Dunlap]

On 4/25/21 3:54 AM, Souptick Joarder wrote:
> Kernel test robot throws below warning ->
> 
> drivers/net/wireless/intel/ipw2x00/ipw2100.c:5359: warning: This comment
> starts with '/**', but isn't a kernel-doc comment. Refer
> Documentation/doc-guide/kernel-doc.rst
> 
> Minor update in documentation.
> 
> Reported-by: kernel test robot <lkp@xxxxxxxxx>
> Signed-off-by: Souptick Joarder <jrdr.linux@xxxxxxxxx>
> Cc: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Thanks.

> ---
> v2:
> 	Updated docs.
> 
>  drivers/net/wireless/intel/ipw2x00/ipw2100.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/net/wireless/intel/ipw2x00/ipw2100.c b/drivers/net/wireless/intel/ipw2x00/ipw2100.c
> index 23fbddd..eeac9e3 100644
> --- a/drivers/net/wireless/intel/ipw2x00/ipw2100.c
> +++ b/drivers/net/wireless/intel/ipw2x00/ipw2100.c
> @@ -5356,7 +5356,7 @@ struct ipw2100_wep_key {
>  #define WEP_STR_128(x) x[0],x[1],x[2],x[3],x[4],x[5],x[6],x[7],x[8],x[9],x[10]
>  
>  /**
> - * Set a the wep key
> + * ipw2100_set_key() - Set the wep key
>   *
>   * @priv: struct to work on
>   * @idx: index of the key we want to set
> 


-- 
~Randy