[dpdk-dev] [EXT] [PATCH] security: update doxygen fields
Thomas Monjalon
thomas at monjalon.net
Wed Sep 4 09:46:42 CEST 2019
04/09/2019 05:41, Anoob Joseph:
> Hi Radu,
>
> Most parts of the file(rte_security.h) follows 'description after item' methodology. Do you think we should stick to that?
>
> @Akhil, @Thomas, what is the recommended way of documenting individual members of structure? Is it 'description after the item' or 'description before the item'?
In general, it is better to have the description before.
The description "after" is preferred for short descriptions
of struct items which fit on the same line with the item.
More information about the dev
mailing list