| Message ID | 1424712070-13955-1-git-send-email-bill.fischofer@linaro.org |
|---|---|
| State | New |
| Headers | show |
On 23 February 2015 at 12:21, Bill Fischofer <bill.fischofer@linaro.org> wrote: > Add missing doxygen documentation to resolve > Bug https://bugs.linaro.org/show_bug.cgi?id=1250 > > Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> --- > example/l2fwd/odp_l2fwd.c | 6 ++++++ > 1 file changed, 6 insertions(+) > > diff --git a/example/l2fwd/odp_l2fwd.c b/example/l2fwd/odp_l2fwd.c > index 0326a3c..4b71822 100644 > --- a/example/l2fwd/odp_l2fwd.c > +++ b/example/l2fwd/odp_l2fwd.c > @@ -240,6 +240,12 @@ 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 > need @param for mode > + * > + * @return The handle of the created pktio object. > + * #retval ODP_PKTIO_INVALID if the create fails. > should be @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 >
Sorry about that. v2 posted. On Thu, Feb 26, 2015 at 7:47 AM, Mike Holmes <mike.holmes@linaro.org> wrote: > > > On 23 February 2015 at 12:21, Bill Fischofer <bill.fischofer@linaro.org> > wrote: > >> Add missing doxygen documentation to resolve >> Bug https://bugs.linaro.org/show_bug.cgi?id=1250 >> >> Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> > > --- >> example/l2fwd/odp_l2fwd.c | 6 ++++++ >> 1 file changed, 6 insertions(+) >> >> diff --git a/example/l2fwd/odp_l2fwd.c b/example/l2fwd/odp_l2fwd.c >> index 0326a3c..4b71822 100644 >> --- a/example/l2fwd/odp_l2fwd.c >> +++ b/example/l2fwd/odp_l2fwd.c >> @@ -240,6 +240,12 @@ 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 >> > > need @param for mode > > >> + * >> + * @return The handle of the created pktio object. >> + * #retval ODP_PKTIO_INVALID if the create fails. >> > > should be @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 >> > > > > -- > *Mike Holmes* > Linaro Sr Technical Manager > LNG - ODP >
diff --git a/example/l2fwd/odp_l2fwd.c b/example/l2fwd/odp_l2fwd.c index 0326a3c..4b71822 100644 --- a/example/l2fwd/odp_l2fwd.c +++ b/example/l2fwd/odp_l2fwd.c @@ -240,6 +240,12 @@ 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 + * + * @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)
Add missing doxygen documentation to resolve Bug https://bugs.linaro.org/show_bug.cgi?id=1250 Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> --- example/l2fwd/odp_l2fwd.c | 6 ++++++ 1 file changed, 6 insertions(+)