videolan
/
ffmpeg
mirror of https://git.videolan.org/git/ffmpeg.git
1
Fork 0
Code Releases Activity

avutil/lfg: Minor doxy improvements 

Use inline code for sizeof and use proper @return directive.
This commit is contained in:
Marvin Scholz 2022-09-25 00:14:44 +02:00 committed by Anton Khirnov
parent 6a1ad7a752
commit 8bac3902b0
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
libavutil/lfg.h
View File

@ -27,7 +27,7 @@
/** /**
* Context structure for the Lagged Fibonacci PRNG. * Context structure for the Lagged Fibonacci PRNG.
* The exact layout, types and content of this struct may change and should * The exact layout, types and content of this struct may change and should
* not be accessed directly. Only its sizeof() is guaranteed to stay the same * not be accessed directly. Only its `sizeof()` is guaranteed to stay the same
* to allow easy instanciation. * to allow easy instanciation.
*/ */
typedef struct AVLFG { typedef struct AVLFG {
@ -40,7 +40,7 @@ void av_lfg_init(AVLFG *c, unsigned int seed);
/** /**
* Seed the state of the ALFG using binary data. * Seed the state of the ALFG using binary data.
* *
* Return value: 0 on success, negative value (AVERROR) on failure. * @return 0 on success, negative value (AVERROR) on failure.
*/ */
int av_lfg_init_from_data(AVLFG *c, const uint8_t *data, unsigned int length); int av_lfg_init_from_data(AVLFG *c, const uint8_t *data, unsigned int length);