From d6fea2ef221a2f438cc55e82c61d0375750edf94 Mon Sep 17 00:00:00 2001
From: Michael Niedermayer <michael@niedermayer.cc>
Date: Sun, 20 Oct 2019 12:12:12 +0200
Subject: avutil/lfg: Document the AVLFG struct

Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
---
 libavutil/lfg.h | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/libavutil/lfg.h b/libavutil/lfg.h
index 03f779a..ab38a8a 100644
--- a/libavutil/lfg.h
+++ b/libavutil/lfg.h
@@ -24,6 +24,12 @@
 
 #include <stdint.h>
 
+/**
+ * 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 guranteed to stay the same
+ * to allow easy instanciation.
+ */
 typedef struct AVLFG {
     unsigned int state[64];
     int index;
-- 
cgit v1.1