[xiph-commits] r8681 - in trunk/oggdsf/src/lib: core/ogg/libOOOgg player/libDSPlayDotNET

[illiminable at motherfish-iii.xiph.org]

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

Modified:
   trunk/oggdsf/src/lib/core/ogg/libOOOgg/CircularBuffer.h
   trunk/oggdsf/src/lib/player/libDSPlayDotNET/DSPlay.h
Log:
* Documentation for CircularBuffer
* More docs for dsplay.


Modified: trunk/oggdsf/src/lib/core/ogg/libOOOgg/CircularBuffer.h
===================================================================
--- trunk/oggdsf/src/lib/core/ogg/libOOOgg/CircularBuffer.h	2005-01-08 19:14:41 UTC (rev 8680)
+++ trunk/oggdsf/src/lib/core/ogg/libOOOgg/CircularBuffer.h	2005-01-08 19:18:59 UTC (rev 8681)
@@ -127,18 +127,25 @@
 	:	public IFIFOBuffer
 {
 public:
+	/// Constructor taking in the size in bytes of the internal buffer.
 	CircularBuffer(unsigned long inBufferSize);
 	virtual ~CircularBuffer(void);
 
-	//IFIFOBuffer Implementation
+	/// Read bytes from the internal buffer. Returns how many actually read.
 	virtual unsigned long read(unsigned char* outData, unsigned long inBytesToRead);
+
+	/// Write bytes into the internal buffer. Returns how many written.
 	virtual unsigned long write(const unsigned char* inData, unsigned long inBytesToWrite);
 
+	/// Returns how many bytes are available in the buffer.
 	virtual unsigned long numBytesAvail();
+
+	/// Returns how much space is left in the buffer.
 	virtual unsigned long spaceLeft();
 
+	/// Resets the buffer.
 	virtual void reset();
-	//
+
 protected:
 	unsigned long mBufferSize;
 	unsigned long mReadPtr;

Modified: trunk/oggdsf/src/lib/player/libDSPlayDotNET/DSPlay.h
===================================================================
--- trunk/oggdsf/src/lib/player/libDSPlayDotNET/DSPlay.h	2005-01-08 19:14:41 UTC (rev 8680)
+++ trunk/oggdsf/src/lib/player/libDSPlayDotNET/DSPlay.h	2005-01-08 19:18:59 UTC (rev 8681)
@@ -33,8 +33,10 @@
 //===========================================================================
 
 #pragma once
+
+//Unmanaged Includes
 #pragma unmanaged
-//#include "CMMLDecoderIIDs.h"
+
 #include <uuids.h>
 #include <dshow.h>
 
@@ -50,16 +52,19 @@
 
 #include <fstream>
 
+//Managed Includes
 #pragma managed
+
 using namespace System::IO;
 #using "System.Drawing.dll"
 
 #using "libCMMLTagsDotNET.dll"
 using namespace illiminable::libCMMLTagsDotNET;
+
 #include "libDSPlayDotNet.h"
 #include "IDNCMMLCallbacks.h"
 #include "IDNMediaEvent.h"
-//#include "Wrappers.h"
+
 using namespace illiminable::libiWrapper;
 using namespace std;
 
@@ -71,6 +76,8 @@
 	{
 	public:
 		DSPlay(void);
+
+		/// Constructor takes a HWND and the video location/size wrt to the window the handle refers to.
 		DSPlay(IntPtr inWindowHandle, Int32 inLeft, Int32 inTop, Int32 inWidth, Int32 inHeight);
 		~DSPlay(void);