diff mbox series

[FFmpeg-devel,v3,39/54] avutil/lfg: Minor doxy improvements

Message ID 20220925001121.37721-40-epirat07@gmail.com
State Accepted
Commit 8bac3902b09f8a2e0467346f227e2f6528b7870e
Headers show
Series Various Doxygen fixes | expand

Checks

Context Check Description
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Marvin Scholz Sept. 25, 2022, 12:11 a.m. UTC 
Use inline code for sizeof and use proper @return directive.
---
 libavutil/lfg.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
diff mbox series

Patch

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);