Re: [FFmpeg-devel] [PATCH v3 2/3] avutil/random_seed: add av_random_bytes()

From: Anton Khirnov <anton@khirnov.net>
To: FFmpeg development discussions and patches <ffmpeg-devel@ffmpeg.org>
Subject: Re: [FFmpeg-devel] [PATCH v3 2/3] avutil/random_seed: add av_random_bytes()
Date: Wed, 05 Jul 2023 12:24:21 +0200
Message-ID: <168855266183.542.7703623237832964766@lain.khirnov.net> (raw)
In-Reply-To: <20230704232614.2785-2-jamrial@gmail.com>

Quoting James Almer (2023-07-05 01:26:13)
> diff --git a/libavutil/random_seed.h b/libavutil/random_seed.h
> index 0462a048e0..8df37da8f8 100644
> --- a/libavutil/random_seed.h
> +++ b/libavutil/random_seed.h
> @@ -36,6 +36,18 @@
>   */
>  uint32_t av_get_random_seed(void);
>  
> +/**
> + * Generate cryptographically secure random data, i.e. suitable for use as
> + * encryption keys and similar.
> + *
> + * @param buf buffer into which the random data will be written
> + * @param len size of buf in bytes
> + *
> + * @retval 0 success, and len bytes of random data was written into buf, or
> + *         a negative AVERROR code if random data could not be generated.

@retval declares behavior for a specific return value out of several, so
there should be a separate @retval for each of those

See e.g. doxy for avcodec_send_packet() [1] for an example of what it
looks like.

[1] http://ffmpeg.org/doxygen/trunk/group__lavc__decoding.html#ga58bc4bf1e0ac59e27362597e467efff3

-- 
Anton Khirnov
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".