diff mbox

[2/2] example: packet: add more missing doxygen documentation

Message ID 1424971069-16432-2-git-send-email-bill.fischofer@linaro.org
State Accepted
Commit ef841db251fa6e8ea0923bc90fb66766e30e9108
Headers show

Commit Message

Bill Fischofer Feb. 26, 2015, 5:17 p.m. UTC 
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
---
 example/packet/odp_pktio.c | 10 ++++++++++
 1 file changed, 10 insertions(+)

Comments

Mike Holmes Feb. 26, 2015, 6:17 p.m. UTC | #1 
On 26 February 2015 at 12:17, 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/packet/odp_pktio.c | 10 ++++++++++
>  1 file changed, 10 insertions(+)
>
> diff --git a/example/packet/odp_pktio.c b/example/packet/odp_pktio.c
> index 5eec796..bb07726 100644
> --- a/example/packet/odp_pktio.c
> +++ b/example/packet/odp_pktio.c
> @@ -100,6 +100,16 @@ static void parse_args(int argc, char *argv[],
> appl_args_t *appl_args);
>  static void print_info(char *progname, appl_args_t *appl_args);
>  static void usage(char *progname);
>
> +/**
> + * 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)
>  {
>         odp_pktio_t pktio;
> --
> 2.1.0
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
>
diff mbox

Patch

diff --git a/example/packet/odp_pktio.c b/example/packet/odp_pktio.c
index 5eec796..bb07726 100644
--- a/example/packet/odp_pktio.c
+++ b/example/packet/odp_pktio.c
@@ -100,6 +100,16 @@  static void parse_args(int argc, char *argv[], appl_args_t *appl_args);
 static void print_info(char *progname, appl_args_t *appl_args);
 static void usage(char *progname);
 
+/**
+ * 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)
 {
 	odp_pktio_t pktio;