[xiph-commits] r8682 - trunk/oggdsf/src/lib/core/ogg/libOOOgg

[illiminable at motherfish-iii.xiph.org]

Author: illiminable
Date: 2005-01-08 11:22:59 -0800 (Sat, 08 Jan 2005)
New Revision: 8682

Modified:
   trunk/oggdsf/src/lib/core/ogg/libOOOgg/IFIFOBuffer.h
Log:
* Document IFIFOBuffer

Modified: trunk/oggdsf/src/lib/core/ogg/libOOOgg/IFIFOBuffer.h
===================================================================
--- trunk/oggdsf/src/lib/core/ogg/libOOOgg/IFIFOBuffer.h	2005-01-08 19:18:59 UTC (rev 8681)
+++ trunk/oggdsf/src/lib/core/ogg/libOOOgg/IFIFOBuffer.h	2005-01-08 19:22:59 UTC (rev 8682)
@@ -36,11 +36,18 @@
 	IFIFOBuffer(void)				{}
 	virtual ~IFIFOBuffer(void)		{}
 
+	/// Read bytes from the internal buffer. Returns how many actually read.
 	virtual unsigned long read(unsigned char* outData, unsigned long inBytesToRead) = 0;
+
+	/// Write bytes into the internal buffer. Returns how many written.
 	virtual unsigned long write(const unsigned char* inData, unsigned long inBytesToWrite) = 0;
 
+	/// Returns how many bytes are available in the buffer.
 	virtual  unsigned long numBytesAvail() = 0;
+
+	/// Returns how much space is left in the buffer.
 	virtual unsigned long spaceLeft() = 0;
 
+	/// Resets the buffer.
 	virtual void reset() = 0;
 };
\ No newline at end of file