avutil/lfg: Document the AVLFG struct
authorMichael Niedermayer <michael@niedermayer.cc>
Sun, 20 Oct 2019 10:12:12 +0000 (12:12 +0200)
committerMichael Niedermayer <michael@niedermayer.cc>
Sat, 9 Nov 2019 15:10:02 +0000 (16:10 +0100)
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
libavutil/lfg.h

index 03f779a..ab38a8a 100644 (file)
 
 #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;