[FFmpeg-devel] [PATCH] Improve metadata documentation

[Cyril Russo]

Le 26/05/2010 01:05, Stefano Sabatini a ?crit :
>
> "Do not" - contractions are better avoided in official docs.
>    
Done. Changed existing "don't" to "Do not" too.
>    
>>   #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
>>      
> It's preferable to just say AV_METADATA_* flags, otherwise this will
> result in macros / function docs desynchronization.
>
>    
Done.
>>    * @return>= 0 on success otherwise an error code<0
>>      
>    
>> + * @sa AV_METADATA_DONT_OVERWRITE
>>      
> duplication
>    
I've kept it because it'll generate a link (while AV_METADATA_* won't), 
so it's easier for documentation navigation.
Cheers,
Cyril RUSSO
-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: fixMDDoc.patch
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20100526/41ae40a0/attachment.asc>