summaryrefslogtreecommitdiff
path: root/libavutil/lfg.h
diff options
context:
space:
mode:
authorMarvin Scholz <epirat07@gmail.com>2022-09-25 00:14:44 +0200
committerAnton Khirnov <anton@khirnov.net>2022-10-17 09:56:47 +0200
commit8bac3902b09f8a2e0467346f227e2f6528b7870e (patch)
tree44b16a512de71883b68d0a6d6a447860ebb53548 /libavutil/lfg.h
parent6a1ad7a7524b5e80df214feddb65fb93f3e4ae6c (diff)
downloadffmpeg-8bac3902b09f8a2e0467346f227e2f6528b7870e.tar.gz
avutil/lfg: Minor doxy improvements
Use inline code for sizeof and use proper @return directive.
Diffstat (limited to 'libavutil/lfg.h')
-rw-r--r--libavutil/lfg.h4
1 files 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);