diff mbox series

[v4,11/12] eventdev: drop comment for anon union from doxygen

Message ID 20240221103221.933238-12-bruce.richardson@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Jerin Jacob
Headers
Series improve eventdev API specification/documentation |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Bruce Richardson Feb. 21, 2024, 10:32 a.m. UTC 
  Make the comments on the unnamed unions in the rte_event structure
regular comments rather than doxygen ones. The comments do not add
anything meaningful to the doxygen output.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 lib/eventdev/rte_eventdev.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Pavan Nikhilesh Bhagavatula Feb. 26, 2024, 6:52 a.m. UTC | #1 
> Make the comments on the unnamed unions in the rte_event structure
> regular comments rather than doxygen ones. The comments do not add
> anything meaningful to the doxygen output.
> 
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>

Acked-by: Pavan Nikhilesh <pbhagavatula@marvell.com>

> ---
>  lib/eventdev/rte_eventdev.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h
> index 7e7e275620..03748eb437 100644
> --- a/lib/eventdev/rte_eventdev.h
> +++ b/lib/eventdev/rte_eventdev.h
> @@ -1571,7 +1571,7 @@ struct rte_event_vector {
>   * for dequeue and enqueue operation
>   */
>  struct rte_event {
> -	/** WORD0 */
> +	/* WORD0 */
>  	union {
>  		uint64_t event;
>  		/** Event attributes for dequeue or enqueue operation */
> @@ -1683,7 +1683,7 @@ struct rte_event {
>  			 */
>  		};
>  	};
> -	/** WORD1 */
> +	/* WORD1 */
>  	union {
>  		uint64_t u64;
>  		/**< Opaque 64-bit value */
> --
> 2.40.1
diff mbox series

Patch

diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h
index 7e7e275620..03748eb437 100644
--- a/lib/eventdev/rte_eventdev.h
+++ b/lib/eventdev/rte_eventdev.h
@@ -1571,7 +1571,7 @@  struct rte_event_vector {
  * for dequeue and enqueue operation
  */
 struct rte_event {
-	/** WORD0 */
+	/* WORD0 */
 	union {
 		uint64_t event;
 		/** Event attributes for dequeue or enqueue operation */
@@ -1683,7 +1683,7 @@  struct rte_event {
 			 */
 		};
 	};
-	/** WORD1 */
+	/* WORD1 */
 	union {
 		uint64_t u64;
 		/**< Opaque 64-bit value */