[FFmpeg-devel] [PATCH] lavu/dict.h: apply various fixes/extensions to doxy

[Stefano Sabatini]

On date Friday 2013-11-22 13:40:47 +0100, Clément Bœsch encoded:
> On Fri, Nov 22, 2013 at 01:26:34PM +0100, Stefano Sabatini wrote:
> > On date Thursday 2013-11-21 12:46:32 +0100, Clément Bœsch encoded:
> > > On Wed, Nov 20, 2013 at 05:44:55PM +0100, Stefano Sabatini wrote:
> > > > In particular, document AV_DICT_MATCH_CASE, AV_DICT_IGNORE_SUFFIX, and
> > > > extend documentation for av_dict_get().
> > > > ---
> > > >  libavutil/dict.h | 13 +++++++++----
> > > >  1 file changed, 9 insertions(+), 4 deletions(-)
> > > > 
> > > > diff --git a/libavutil/dict.h b/libavutil/dict.h
> > > > index 38f03a4..1381bcb 100644
> > > > --- a/libavutil/dict.h
> > > > +++ b/libavutil/dict.h
> > > > @@ -64,12 +64,13 @@
> > > >   *
> > > >   */
> > > >  
> > > > -#define AV_DICT_MATCH_CASE      1
> > > > -#define AV_DICT_IGNORE_SUFFIX   2
> > > > +#define AV_DICT_MATCH_CASE      1   /**< Only get an entry with exact-case key match. Only relevant in av_dict_get(). */
> > > > +#define AV_DICT_IGNORE_SUFFIX   2   /**< Return first entry in a dictionary whose first part corresponds to the search key,
> > > > +                                         ignoring the suffix of the found key string. Only relevant in av_dict_get(). */
> > > >  #define AV_DICT_DONT_STRDUP_KEY 4   /**< Take ownership of a key that's been
> > > > -                                         allocated with av_malloc() and children. */
> > > > +                                         allocated with av_malloc() or another memory allocation function. */
> > > >  #define AV_DICT_DONT_STRDUP_VAL 8   /**< Take ownership of a value that's been
> > > > -                                         allocated with av_malloc() and chilren. */
> > > > +                                         allocated with av_malloc() or another memory allocation function. */
> > > 
> > 
> > > Did you check if this allocation was correct btw? Since we can't mix our malloc & realloc...
> > 
> > How is this related to this patch?
> > 
> 
> It's not, unless the function needs to be adjusted to use realloc()
> instead of av_malloc() everywhere to fix a potential problem, in which
> case that documentation would be even more wrong.
> 
> There might not even be a problem, so feel free to ignore.

Applied.
-- 
FFmpeg = Formidable Fast Multimedia Prodigious Ephemeral God