> -----Original Message----- > From: lng-odp [mailto:[email protected]] On Behalf Of ext > Bill Fischofer > Sent: Thursday, June 04, 2015 7:23 AM > To: [email protected] > Subject: [lng-odp] [API-NEXT PATCHv2 2/3] api: buffer: clarify pool handle > on alloc > > Signed-off-by: Bill Fischofer <[email protected]> > --- > include/odp/api/buffer.h | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/include/odp/api/buffer.h b/include/odp/api/buffer.h > index 9ad08ea..83f06c3 100644 > --- a/include/odp/api/buffer.h > +++ b/include/odp/api/buffer.h > @@ -108,7 +108,7 @@ odp_pool_t odp_buffer_pool(odp_buffer_t buf); > * Buffer alloc > * > * The validity of a buffer can be cheked at any time with > odp_buffer_is_valid() > - * @param pool Pool handle > + * @param pool Handle for pool of type ODP_POOL_BUFFER > * > * @return Handle of allocated buffer > * @retval ODP_BUFFER_INVALID Buffer could not be allocated
I think it's better to mention the requirement (among other potential requirements) in the body of the documentation. This allows the 'pool' parameter to be named the same way in all the APIs. /** * Buffer alloc * Like this for example, " Allocates a buffer from the pool. The pool must be a buffer pool. The validity of a buffer can be checked at any time with odp_buffer_is_valid()" * @param pool Pool handle * * @return Handle of allocated buffer * @retval ODP_BUFFER_INVALID Buffer could not be allocated */ odp_buffer_t odp_buffer_alloc(odp_pool_t pool); -Petri _______________________________________________ lng-odp mailing list [email protected] https://lists.linaro.org/mailman/listinfo/lng-odp
