[FFmpeg-cvslog] lavu/fifo: add the header to its own doxy group
Anton Khirnov
git at videolan.org
Mon Sep 5 10:01:26 EEST 2022
ffmpeg | branch: master | Anton Khirnov <anton at khirnov.net> | Thu Jun 30 16:20:09 2022 +0200| [c9b6fd27bfbd2c4c99c1af8e86b70eeb47991124] | committer: Anton Khirnov
lavu/fifo: add the header to its own doxy group
Also, drop mentions of it being a circular buffer, as this is an
internal implementation detail that should be invisible to the caller.
> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=c9b6fd27bfbd2c4c99c1af8e86b70eeb47991124
---
libavutil/fifo.h | 15 ++++++++++++++-
1 file changed, 14 insertions(+), 1 deletion(-)
diff --git a/libavutil/fifo.h b/libavutil/fifo.h
index 4eed364afc..6c6bd78842 100644
--- a/libavutil/fifo.h
+++ b/libavutil/fifo.h
@@ -18,7 +18,8 @@
/**
* @file
- * a very simple circular buffer FIFO implementation
+ * @ingroup lavu_fifo
+ * A generic FIFO API
*/
#ifndef AVUTIL_FIFO_H
@@ -30,6 +31,14 @@
#include "attributes.h"
#include "version.h"
+/**
+ * @defgroup lavu_fifo AVFifo
+ * @ingroup lavu_data
+ *
+ * @{
+ * A generic FIFO API
+ */
+
typedef struct AVFifo AVFifo;
/**
@@ -423,4 +432,8 @@ static inline uint8_t *av_fifo_peek2(const AVFifoBuffer *f, int offs)
#endif
#endif
+/**
+ * @}
+ */
+
#endif /* AVUTIL_FIFO_H */
More information about the ffmpeg-cvslog
mailing list