[dpdk-dev] [PATCH v2] ethdev: fix comments of packet integrity flow item

Ferruh Yigit ferruh.yigit at intel.com
Wed May 19 19:47:31 CEST 2021


On 5/19/2021 6:33 PM, Thomas Monjalon wrote:
> The Doxygen comments are placed before the related lines,
> but the markers were /**< instead of /**
> 
> The struct rte_flow_item_integrity did not appear in Doxygen output
> because there was no general comment for the struct.
> 
> Fixes: b10a421a1f3b ("ethdev: add packet integrity check flow rules")
> 
> Signed-off-by: Thomas Monjalon <thomas at monjalon.net>
> Acked-by: Andrew Rybchenko <andrew.rybchenko at oktetlabs.ru>
> Acked-by: Ajit Khaparde <ajit.khaparde at broadcom.com>

Reviewed-by: Ferruh Yigit <ferruh.yigit at intel.com>


btw, there are some related issues for other structs, do you think should we fix
them in this release?

Following are missing doxygen comment for its item:
* "struct rte_flow_item_conntrack"
* "struct rte_flow_item_ecpri"

* Following are missing doxygen comments for its items, and missing experimental
tag.
  * "struct rte_flow_item_geneve_opt"
  * "struct rte_flow_item_ipv6_frag_ext"

And I suspect we can see similar issues with more structs as we check them all.


More information about the dev mailing list