[PATCH v2 01/83] lib: update documentation of XXX_free() functions
Thomas Monjalon
thomas at monjalon.net
Sat Jan 29 19:51:47 CET 2022
28/01/2022 23:51, Stephen Hemminger:
> On Fri, 28 Jan 2022 22:47:15 +0100
> Thomas Monjalon <thomas at monjalon.net> wrote:
>
> > 24/01/2022 18:45, Stephen Hemminger:
> > > These functions all behave like libc free() and do
> > > nothing if handed a NULL pointer. The code is already doing
> > > this, this patch just documents the behavior.
> > >
> > > Signed-off-by: Stephen Hemminger <stephen at networkplumber.org>
> > > ---
> > > /**
> > > * De-allocate all memory used by hash table.
> > > + *
> > > + * If the pointer is NULL, the function does nothing.
> >
> > Would be better to move in the context of the parameter
>
> I copied text from rte_free to other functions...
> For consistency, lets document it one way in all cases.
> Don't care which one...
I prefer to have comments about a parameter inside the @param please.
More information about the dev
mailing list