[FFmpeg-devel] [PATCH 09/17] avutil/lfg: add Doxy @file and group
Timothy Gu
timothygu99 at gmail.com
Sat Nov 2 23:03:23 CET 2013
Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
---
libavutil/lfg.c | 7 +++++++
libavutil/lfg.h | 13 +++++++++++++
2 files changed, 20 insertions(+)
diff --git a/libavutil/lfg.c b/libavutil/lfg.c
index ffa2f1f..8e0f91d 100644
--- a/libavutil/lfg.c
+++ b/libavutil/lfg.c
@@ -19,6 +19,13 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
+/**
+ * @file
+ * @brief Lagged Fibonacci generator
+ * @author Michael Niedermayer
+ * @ingroup lavu_lfg
+ */
+
#include <inttypes.h>
#include <limits.h>
#include <math.h>
diff --git a/libavutil/lfg.h b/libavutil/lfg.h
index ec90562..ce79c15 100644
--- a/libavutil/lfg.h
+++ b/libavutil/lfg.h
@@ -22,6 +22,15 @@
#ifndef AVUTIL_LFG_H
#define AVUTIL_LFG_H
+/**
+ * @file
+ * Public header for libavutil Lagged Fibonacci Generator
+ * @author Michael Niedermayer
+ * @defgroup lavu_lfg LFG
+ * @ingroup lavu_crypto
+ * @{
+ */
+
typedef struct AVLFG {
unsigned int state[64];
int index;
@@ -59,4 +68,8 @@ static inline unsigned int av_mlfg_get(AVLFG *c){
*/
void av_bmg_get(AVLFG *lfg, double out[2]);
+/**
+ * @}
+ */
+
#endif /* AVUTIL_LFG_H */
--
1.8.1.2
More information about the ffmpeg-devel
mailing list