diff fifo.h @ 633:8c48a1b999a3 libavutil

spelling/grammar/consistency review part I

--- a/fifo.h	Tue Jan 27 00:46:18 2009 +0000
+++ b/fifo.h	Wed Jan 28 00:16:05 2009 +0000
@@ -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_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 @@
 #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 @@
  * 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);