diff options
author | Bill Fischofer <bill.fischofer@linaro.org> | 2015-02-23 11:44:29 -0600 |
---|---|---|
committer | Maxim Uvarov <maxim.uvarov@linaro.org> | 2015-02-25 00:12:34 +0300 |
commit | 1f4b7b7181d82feef8cbe399887429a7d6961715 (patch) | |
tree | b8c3e7214d8ec8067950754f800e5ae21037053b /example | |
parent | 9c4a1435468e97a04f11ad4cedec34c54aaee715 (diff) |
example: generator: add missing doxygen documentation
Add missing doxygen documentation to resolve
Bug https://bugs.linaro.org/show_bug.cgi?id=1249
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
Reviewed-by: Mike Holmes <mike.holmes@linaro.org>
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
Diffstat (limited to 'example')
-rw-r--r-- | example/generator/odp_generator.c | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/example/generator/odp_generator.c b/example/generator/odp_generator.c index db9e0c2..47cab6c 100644 --- a/example/generator/odp_generator.c +++ b/example/generator/odp_generator.c @@ -287,6 +287,15 @@ static odp_packet_t pack_icmp_pkt(odp_pool_t pool) return pkt; } +/** + * Create a pktio object + * + * @param dev Name of device to open + * @param pool Pool to associate with device for packet RX/TX + * + * @return The handle of the created pktio object. + * @warning This routine aborts if the create is unsuccessful. + */ static odp_pktio_t create_pktio(const char *dev, odp_pool_t pool) { odp_queue_param_t qparam; |