[FFmpeg-devel] [PATCH 1/3] lavu/fifo: add the header to its own doxy group

From: Anton Khirnov <anton@khirnov.net>
To: ffmpeg-devel@ffmpeg.org
Subject: [FFmpeg-devel] [PATCH 1/3] lavu/fifo: add the header to its own doxy group
Date: Mon, 29 Aug 2022 16:07:15 +0200
Message-ID: <20220829140717.26557-1-anton@khirnov.net> (raw)

Also, drop mentions of it being a circular buffer, as this is an
internal implementation detail that should be invisible to the caller.
---
 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 */
-- 
2.35.1

_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
