diff options
| author | Anton Khirnov <anton@khirnov.net> | 2022-06-30 16:20:09 +0200 |
|---|---|---|
| committer | Anton Khirnov <anton@khirnov.net> | 2022-09-05 08:58:51 +0200 |
| commit | c9b6fd27bfbd2c4c99c1af8e86b70eeb47991124 (patch) | |
| tree | e62468506b99e9843b6dc0d080110fa470f60cbc | |
| parent | 693c1e631c4957acd2fe9d9650d757fd8d3d1239 (diff) | |
| download | ffmpeg-c9b6fd27bfbd2c4c99c1af8e86b70eeb47991124.tar.gz | |
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.
| -rw-r--r-- | libavutil/fifo.h | 15 |
1 files changed, 14 insertions, 1 deletions
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 */ |