[PATCH v3 07/27] net/nfp: standard the comment style

Ferruh Yigit ferruh.yigit at amd.com
Fri Sep 15 15:44:35 CEST 2023


On 9/15/2023 10:15 AM, Chaoyong He wrote:
> Follow the DPDK coding style, use the kdoc comment style.
> Also add some comment to help understand logic.
> 
> Signed-off-by: Chaoyong He <chaoyong.he at corigine.com>
> Reviewed-by: Niklas Söderlund <niklas.soderlund at corigine.com>

<...>

>  
> -/*
> - * Set the model id
> - *
> - * @param   cpp     NFP CPP operations structure
> - * @param   model   Model ID
> - */
>  void nfp_cpp_model_set(struct nfp_cpp *cpp, uint32_t model);
>  

As I see some comments are removed in this patch, there is no enforced
comment style for internal functions, for API doxygen comments must
provided.

Of course consistency matters, but if comments are removed because of
the syntax, I think better option to keep them with their own syntax.



More information about the dev mailing list