[FFmpeg-devel] [PATCH] Improve av_metadata_set2 documentation

[Michael Niedermayer]

On Sat, May 01, 2010 at 05:23:54PM +0200, Cyril Russo wrote:
> Hi all,
>
> Attached patch add the description of the flags in av_metadata_set2 
> function. I've also added per-flag description and linked the two.
> Best regards,
> Cyril

>  avformat.h |    7 +++++--
>  1 file changed, 5 insertions(+), 2 deletions(-)
> 013922b4b90847cbbc26e46610dafcb07dd16297  addMetadataDoc.patch
> Index: libavformat/avformat.h
> ===================================================================
> --- libavformat/avformat.h      (revision 23003)
> +++ libavformat/avformat.h      (working copy)
> @@ -117,8 +117,8 @@
> 
>  #define AV_METADATA_MATCH_CASE      1
>  #define AV_METADATA_IGNORE_SUFFIX   2
> -#define AV_METADATA_DONT_STRDUP_KEY 4
> -#define AV_METADATA_DONT_STRDUP_VAL 8
> +#define AV_METADATA_DONT_STRDUP_KEY 4   ///< Don't duplicate tag key's string
> +#define AV_METADATA_DONT_STRDUP_VAL 8   ///< Don't duplicate tag value's string

that just duplicates whats alraedy in the variable name


>  #define AV_METADATA_DONT_OVERWRITE 16   ///< Don't overwrite existing tags.
> 
>  typedef struct {
> @@ -154,7 +154,10 @@
>   * Sets the given tag in m, overwriting an existing tag.
>   * @param key tag key to add to m (will be av_strduped depending on flags)
>   * @param value tag value to add to m (will be av_strduped depending on flags)
> + * @param flags any combination of AV_METADATA_DONT_OVERWRITE, AV_METADATA_DONT_STRDUP_KEY,
> + *              AV_METADATA_DONT_STRDUP_VAL

thats guranteed to become out of sync with the addition of the next falg and
then its outright wrong

[...]
-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

Opposition brings concord. Out of discord comes the fairest harmony.
-- Heraclitus
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20100503/6979b967/attachment.pgp>