aboutsummaryrefslogtreecommitdiffstats
path: root/libavutil/fifo.h
diff options
context:
space:
mode:
authorDiego Biurrun <diego@biurrun.de>2009-01-28 00:16:05 +0000
committerDiego Biurrun <diego@biurrun.de>2009-01-28 00:16:05 +0000
commit89c9ff504b29d03cf266aa3598ccb8d2cf1ddd13 (patch)
tree340147cb9f4382a838ae971bf991c2f42482077c /libavutil/fifo.h
parentd972e56cf21e9fa12922704da276d26111b5dbc1 (diff)
downloadffmpeg-89c9ff504b29d03cf266aa3598ccb8d2cf1ddd13.tar.gz
spelling/grammar/consistency review part I
Originally committed as revision 16840 to svn://svn.ffmpeg.org/ffmpeg/trunk
Diffstat (limited to 'libavutil/fifo.h')
-rw-r--r--libavutil/fifo.h14
1 files changed, 7 insertions, 7 deletions
diff --git a/libavutil/fifo.h b/libavutil/fifo.h
index 7901972968..7d76efb956 100644
--- a/libavutil/fifo.h
+++ b/libavutil/fifo.h
@@ -18,7 +18,7 @@
/**
* @file fifo.h
- * A very simple circular buffer FIFO implementation.
+ * a very simple circular buffer FIFO implementation
*/
#ifndef AVUTIL_FIFO_H
@@ -64,7 +64,7 @@ int av_fifo_size(AVFifoBuffer *f);
int av_fifo_read(AVFifoBuffer *f, uint8_t *buf, int buf_size);
/**
- * Feeds data from an AVFifoBuffer to a user supplied callback.
+ * Feeds data from an AVFifoBuffer to a user-supplied callback.
* @param *f AVFifoBuffer to read from
* @param buf_size number of bytes to read
* @param *func generic read function
@@ -83,16 +83,16 @@ attribute_deprecated void av_fifo_write(AVFifoBuffer *f, const uint8_t *buf, int
#endif
/**
- * Feeds data from a user supplied callback to an AVFifoBuffer.
+ * Feeds data from a user-supplied callback to an AVFifoBuffer.
* @param *f AVFifoBuffer to write to
* @param *src data source
* @param size number of bytes to write
- * @param *func generic write function. First parameter is src,
- * second is dest_buf, third is dest_buf_size.
+ * @param *func generic write function; the first parameter is src,
+ * the second is dest_buf, the third is dest_buf_size.
* func must return the number of bytes written to dest_buf, or <= 0 to
* indicate no more data available to write.
* If func is NULL, src is interpreted as a simple byte array for source data.
- * @return the number of bytes written to the fifo.
+ * @return the number of bytes written to the FIFO
*/
int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int));
@@ -110,7 +110,7 @@ attribute_deprecated void av_fifo_realloc(AVFifoBuffer *f, unsigned int size);
* Resizes an AVFifoBuffer.
* @param *f AVFifoBuffer to resize
* @param size new AVFifoBuffer size in bytes
- * @return <0 for failure >=0 otherwise
+ * @return <0 for failure, >=0 otherwise
*/
int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size);