aboutsummaryrefslogtreecommitdiff
path: root/example/l2fwd
diff options
context:
space:
mode:
authorBill Fischofer <bill.fischofer@linaro.org>2015-02-26 10:07:53 -0600
committerMaxim Uvarov <maxim.uvarov@linaro.org>2015-02-26 19:24:45 +0300
commit1eced4de7f8b12a040ecd5752904d68d477229aa (patch)
tree016ef653680cc9a5f9d73492db925840013d91ec /example/l2fwd
parentfdac7327486c4791f663f2ca56eac30aec59cb82 (diff)
example: l2fwd: add missing doxygen documentation
Reviewed-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
Diffstat (limited to 'example/l2fwd')
-rw-r--r--example/l2fwd/odp_l2fwd.c7
1 files changed, 7 insertions, 0 deletions
diff --git a/example/l2fwd/odp_l2fwd.c b/example/l2fwd/odp_l2fwd.c
index 0326a3ca3..887eb6b13 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)