diff mbox series

eventdev: fix doxygen for function declaration

Message ID 20210409132043.949-1-pbhagavatula@marvell.com (mailing list archive)
State Not Applicable
Delegated to: Jerin Jacob
Headers show
Series eventdev: fix doxygen for function declaration | expand

Checks

Context Check Description
ci/intel-Testing success Testing PASS
ci/Intel-compilation fail Compilation issues
ci/iol-testing success Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/checkpatch success coding style OK

Commit Message

Pavan Nikhilesh Bhagavatula April 9, 2021, 1:20 p.m. UTC
From: Pavan Nikhilesh <pbhagavatula@marvell.com>

Fix missing parameters in doxygen of function declaration.

Fixes: 5b1337f0a08a ("eventdev: introduce event vector Rx capability")

Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
---
 lib/librte_eventdev/rte_event_eth_rx_adapter.h | 3 +++
 1 file changed, 3 insertions(+)

Comments

Jerin Jacob April 12, 2021, 7:27 a.m. UTC | #1
On Fri, Apr 9, 2021 at 6:50 PM <pbhagavatula@marvell.com> wrote:
>
> From: Pavan Nikhilesh <pbhagavatula@marvell.com>
>
> Fix missing parameters in doxygen of function declaration.
>
> Fixes: 5b1337f0a08a ("eventdev: introduce event vector Rx capability")

Squashed to this change in the next-eventdev tree.

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


> ---
>  lib/librte_eventdev/rte_event_eth_rx_adapter.h | 3 +++
>  1 file changed, 3 insertions(+)
>
> diff --git a/lib/librte_eventdev/rte_event_eth_rx_adapter.h b/lib/librte_eventdev/rte_event_eth_rx_adapter.h
> index 7407cde00..182dd2e5d 100644
> --- a/lib/librte_eventdev/rte_event_eth_rx_adapter.h
> +++ b/lib/librte_eventdev/rte_event_eth_rx_adapter.h
> @@ -563,6 +563,9 @@ int rte_event_eth_rx_adapter_vector_limits_get(
>   *  If rx_queue_id is -1, then all Rx queues configured for the ethernet device
>   *  are configured with event vectorization.
>   *
> + * @param config
> + *  Event vector configuration structure.
> + *
>   * @return
>   *  - 0: Success, Receive queue configured correctly.
>   *  - <0: Error code on failure.
> --
> 2.17.1
>
diff mbox series

Patch

diff --git a/lib/librte_eventdev/rte_event_eth_rx_adapter.h b/lib/librte_eventdev/rte_event_eth_rx_adapter.h
index 7407cde00..182dd2e5d 100644
--- a/lib/librte_eventdev/rte_event_eth_rx_adapter.h
+++ b/lib/librte_eventdev/rte_event_eth_rx_adapter.h
@@ -563,6 +563,9 @@  int rte_event_eth_rx_adapter_vector_limits_get(
  *  If rx_queue_id is -1, then all Rx queues configured for the ethernet device
  *  are configured with event vectorization.
  *
+ * @param config
+ *  Event vector configuration structure.
+ *
  * @return
  *  - 0: Success, Receive queue configured correctly.
  *  - <0: Error code on failure.