On Tue, Feb 24, 2015 at 4:00 PM, Mike Holmes <[email protected]> wrote:
> > > On 23 February 2015 at 12:27, Mike Holmes <[email protected]> wrote: > >> On 2015-02-23 19:48, [email protected] wrote: >> > From: Balasubramanian Manoharan <[email protected]> >> > >> > Adds documentation for ODP_PMR_INVAL and ODP_PMR_SET_INVAL macros >> > https://bugs.linaro.org/show_bug.cgi?id=1208 >> > >> > Signed-off-by: Balasubramanian Manoharan <[email protected]> >> >> > --- >> > include/odp/api/classification.h | 12 ++++++++++++ >> > 1 file changed, 12 insertions(+) >> > >> > diff --git a/include/odp/api/classification.h >> b/include/odp/api/classification.h >> > index 8758fb5..7db3645 100644 >> > --- a/include/odp/api/classification.h >> > +++ b/include/odp/api/classification.h >> > @@ -48,6 +48,18 @@ extern "C" { >> > */ >> > >> > /** >> > + * @def ODP_PMR_INVAL >> > + * Invalid odp_pmr_t value. >> > + * This value is returned from odp_pmr_create_match() and >> > + * odp_pmr_create_range() functions on failure. >> > > Is listing the function names a good idea, what this gets returned form > another fun in future, will it get updated ? > Any API change (that includes renames) requires careful planning. Given the impact of renames, doc updates are a minor thing. > > >> > + */ >> > + >> > +/** >> > + * @def ODP_PMR_SET_INVAL >> > + * Invalid odp_pmr_set_t value. >> >> The comment on ODP_PMR_IVAL gives a greater indication what the >> definition is used for, the text here does not add anything or >> crossrefernece to further information, can this have a better description >> in some way ? >> >> > + */ >> > + >> > +/** >> > * Class-of-service packet drop policies >> > */ >> > typedef enum odp_cos_drop { >> > -- >> > 2.0.1.472.g6f92e5f >> > >> > >> > _______________________________________________ >> > lng-odp mailing list >> > [email protected] >> > http://lists.linaro.org/mailman/listinfo/lng-odp >> > > > > -- > *Mike Holmes* > Linaro Sr Technical Manager > LNG - ODP > > _______________________________________________ > lng-odp mailing list > [email protected] > http://lists.linaro.org/mailman/listinfo/lng-odp > >
_______________________________________________ lng-odp mailing list [email protected] http://lists.linaro.org/mailman/listinfo/lng-odp
