[FFmpeg-devel] [PATCH] avutil/cast5: update Doxygen for av_castt_init with return information

[Ganesh Ajjanagadde]

On Thu, Oct 15, 2015 at 10:08 PM, Michael Niedermayer
<michael at niedermayer.cc> wrote:
> On Thu, Oct 15, 2015 at 05:44:49PM -0400, Ganesh Ajjanagadde wrote:
>> Signed-off-by: Ganesh Ajjanagadde <gajjanagadde at gmail.com>
>> ---
>>  libavutil/cast5.h | 1 +
>>  1 file changed, 1 insertion(+)
>>
>> diff --git a/libavutil/cast5.h b/libavutil/cast5.h
>> index e5cc8b1..68513e5 100644
>> --- a/libavutil/cast5.h
>> +++ b/libavutil/cast5.h
>> @@ -48,6 +48,7 @@ struct AVCAST5 *av_cast5_alloc(void);
>>    * @param ctx an AVCAST5 context
>>    * @param key a key of 5,6,...16 bytes used for encryption/decryption
>>    * @param key_bits number of keybits: possible are 40,48,...,128
>> +  * @return 0 on success, -1 if key_bits is not in the above list
>
> ", less than 0 on failure"
>
> APIs should allow extensions, in the supported values, and the
> information returned

Good point - I saw your change of -1 to AVERROR code for crc_init. If
you are interested, a lot of the crypto stuff (md5, sha, ripemd, etc)
returns -1 in libavutil.
Changed, and pushed.

>
>
> [...]
> --
> Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB
>
> If a bugfix only changes things apparently unrelated to the bug with no
> further explanation, that is a good sign that the bugfix is wrong.
>
> _______________________________________________
> ffmpeg-devel mailing list
> ffmpeg-devel at ffmpeg.org
> http://ffmpeg.org/mailman/listinfo/ffmpeg-devel
>