[FFmpeg-cvslog] avutil/lfg: Minor doxy improvements
Marvin Scholz
git at videolan.org
Mon Oct 17 11:01:35 EEST 2022
ffmpeg | branch: master | Marvin Scholz <epirat07 at gmail.com> | Sun Sep 25 00:14:44 2022 +0200| [8bac3902b09f8a2e0467346f227e2f6528b7870e] | committer: Anton Khirnov
avutil/lfg: Minor doxy improvements
Use inline code for sizeof and use proper @return directive.
> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=8bac3902b09f8a2e0467346f227e2f6528b7870e
---
libavutil/lfg.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/libavutil/lfg.h b/libavutil/lfg.h
index 16917827c6..e75a986f12 100644
--- a/libavutil/lfg.h
+++ b/libavutil/lfg.h
@@ -27,7 +27,7 @@
/**
* Context structure for the Lagged Fibonacci PRNG.
* 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.
*/
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.
*
- * 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);
More information about the ffmpeg-cvslog
mailing list