diff mbox series

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

Message ID 20220829140717.26557-1-anton@khirnov.net
State Accepted
Commit c9b6fd27bfbd2c4c99c1af8e86b70eeb47991124
Headers show
Series [FFmpeg-devel,1/3] lavu/fifo: add the header to its own doxy group | expand

Checks

Context Check Description
yinshiyou/make_loongarch64 success Make finished
yinshiyou/make_fate_loongarch64 success Make fate finished
andriy/configure_x86 warning Failed to run configure

Commit Message

Anton Khirnov Aug. 29, 2022, 2:07 p.m. UTC 
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(-)

Comments

Michael Niedermayer Aug. 29, 2022, 8:30 p.m. UTC | #1 
On Mon, Aug 29, 2022 at 04:07:15PM +0200, Anton Khirnov wrote:
> 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(-)

agree

thx

[...]
diff mbox series

Patch

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 */