1
0
mirror of https://github.com/FFmpeg/FFmpeg.git synced 2025-08-10 06:10:52 +02:00

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.
This commit is contained in:
Anton Khirnov
2022-06-30 16:20:09 +02:00
parent 693c1e631c
commit c9b6fd27bf

View File

@@ -18,7 +18,8 @@
/** /**
* @file * @file
* a very simple circular buffer FIFO implementation * @ingroup lavu_fifo
* A generic FIFO API
*/ */
#ifndef AVUTIL_FIFO_H #ifndef AVUTIL_FIFO_H
@@ -30,6 +31,14 @@
#include "attributes.h" #include "attributes.h"
#include "version.h" #include "version.h"
/**
* @defgroup lavu_fifo AVFifo
* @ingroup lavu_data
*
* @{
* A generic FIFO API
*/
typedef struct AVFifo AVFifo; typedef struct AVFifo AVFifo;
/** /**
@@ -423,4 +432,8 @@ static inline uint8_t *av_fifo_peek2(const AVFifoBuffer *f, int offs)
#endif #endif
#endif #endif
/**
* @}
*/
#endif /* AVUTIL_FIFO_H */ #endif /* AVUTIL_FIFO_H */