diff mbox

[PATCHv2] example: l2fwd: add missing doxygen documentation

Message ID 1424966873-704-1-git-send-email-bill.fischofer@linaro.org
State Accepted
Commit 1eced4de7f8b12a040ecd5752904d68d477229aa
Headers show

Commit Message

Bill Fischofer Feb. 26, 2015, 4:07 p.m. UTC
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
---
 example/l2fwd/odp_l2fwd.c | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Mike Holmes Feb. 26, 2015, 4:16 p.m. UTC | #1
On 26 February 2015 at 11:07, Bill Fischofer <bill.fischofer@linaro.org>
wrote:

> Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
>

Reviewed-by: Mike Holmes <mike.holmes@linaro.org>


> ---
>  example/l2fwd/odp_l2fwd.c | 7 +++++++
>  1 file changed, 7 insertions(+)
>
> diff --git a/example/l2fwd/odp_l2fwd.c b/example/l2fwd/odp_l2fwd.c
> index 0326a3c..887eb6b 100644
> --- a/example/l2fwd/odp_l2fwd.c
> +++ b/example/l2fwd/odp_l2fwd.c
> @@ -240,6 +240,13 @@ static void *pktio_ifburst_thread(void *arg)
>
>  /**
>   * Create a pktio handle, optionally associating a default input queue.
> + *
> + * @param dev Name of device to open
> + * @param pool Pool to associate with device for packet RX/TX
> + * @param mode Packet processing mode for this device (BURST or QUEUE)
> + *
> + * @return The handle of the created pktio object.
> + * @retval ODP_PKTIO_INVALID if the create fails.
>   */
>  static odp_pktio_t create_pktio(const char *dev, odp_pool_t pool,
>                                 int mode)
> --
> 2.1.0
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
>
Maxim Uvarov Feb. 26, 2015, 4:26 p.m. UTC | #2
Merged.
Maxim.

On 02/26/2015 07:16 PM, Mike Holmes wrote:
>
>
> On 26 February 2015 at 11:07, Bill Fischofer 
> <bill.fischofer@linaro.org <mailto:bill.fischofer@linaro.org>> wrote:
>
>     Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org
>     <mailto:bill.fischofer@linaro.org>>
>
>
> Reviewed-by: Mike Holmes <mike.holmes@linaro.org 
> <mailto:mike.holmes@linaro.org>>
>
>     ---
>      example/l2fwd/odp_l2fwd.c | 7 +++++++
>      1 file changed, 7 insertions(+)
>
>     diff --git a/example/l2fwd/odp_l2fwd.c b/example/l2fwd/odp_l2fwd.c
>     index 0326a3c..887eb6b 100644
>     --- a/example/l2fwd/odp_l2fwd.c
>     +++ b/example/l2fwd/odp_l2fwd.c
>     @@ -240,6 +240,13 @@ static void *pktio_ifburst_thread(void *arg)
>
>      /**
>       * Create a pktio handle, optionally associating a default input
>     queue.
>     + *
>     + * @param dev Name of device to open
>     + * @param pool Pool to associate with device for packet RX/TX
>     + * @param mode Packet processing mode for this device (BURST or
>     QUEUE)
>     + *
>     + * @return The handle of the created pktio object.
>     + * @retval ODP_PKTIO_INVALID if the create fails.
>       */
>      static odp_pktio_t create_pktio(const char *dev, odp_pool_t pool,
>                                     int mode)
>     --
>     2.1.0
>
>
>     _______________________________________________
>     lng-odp mailing list
>     lng-odp@lists.linaro.org <mailto:lng-odp@lists.linaro.org>
>     http://lists.linaro.org/mailman/listinfo/lng-odp
>
>
>
>
> -- 
> *Mike Holmes*
> Linaro  Sr Technical Manager
> LNG - ODP
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
diff mbox

Patch

diff --git a/example/l2fwd/odp_l2fwd.c b/example/l2fwd/odp_l2fwd.c
index 0326a3c..887eb6b 100644
--- a/example/l2fwd/odp_l2fwd.c
+++ b/example/l2fwd/odp_l2fwd.c
@@ -240,6 +240,13 @@  static void *pktio_ifburst_thread(void *arg)
 
 /**
  * Create a pktio handle, optionally associating a default input queue.
+ *
+ * @param dev Name of device to open
+ * @param pool Pool to associate with device for packet RX/TX
+ * @param mode Packet processing mode for this device (BURST or QUEUE)
+ *
+ * @return The handle of the created pktio object.
+ * @retval ODP_PKTIO_INVALID if the create fails.
  */
 static odp_pktio_t create_pktio(const char *dev, odp_pool_t pool,
 				int mode)