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

[illiminable at motherfish-iii.xiph.org]

Author: illiminable
Date: 2005-01-08 11:26:21 -0800 (Sat, 08 Jan 2005)
New Revision: 8685

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

Modified: trunk/oggdsf/src/lib/core/ogg/libOOOgg/IOggCallback.h
===================================================================
--- trunk/oggdsf/src/lib/core/ogg/libOOOgg/IOggCallback.h	2005-01-08 19:24:53 UTC (rev 8684)
+++ trunk/oggdsf/src/lib/core/ogg/libOOOgg/IOggCallback.h	2005-01-08 19:26:21 UTC (rev 8685)
@@ -45,6 +45,5 @@
 	    for deleting this page.  All callers should NULL their pointer
 	    immediately after calling to avoid reusing them.
 	  */
-
 	virtual bool acceptOggPage(OggPage* inOggPage) = 0;
 };

Modified: trunk/oggdsf/src/lib/core/ogg/libOOOgg/IStampedOggPacketSink.h
===================================================================
--- trunk/oggdsf/src/lib/core/ogg/libOOOgg/IStampedOggPacketSink.h	2005-01-08 19:24:53 UTC (rev 8684)
+++ trunk/oggdsf/src/lib/core/ogg/libOOOgg/IStampedOggPacketSink.h	2005-01-08 19:26:21 UTC (rev 8685)
@@ -40,11 +40,10 @@
 	IStampedOggPacketSink(void)						{}
 	virtual ~IStampedOggPacketSink(void)			{}
 
-	//All callers to acceptStampedOggPacket give away their pointer
-	// to this function. All methods implementing this interface
-	// are responsible for deleting this packet. All callers
-	// should NULL their pointer immediately after calling
-	// to avoid reusing them.
-	// 
+	/** All callers to acceptStampedOggPacket give away their pointer to this
+	    function.  All methods implementing this interface are responsible
+	    for deleting this page.  All callers should NULL their pointer
+	    immediately after calling to avoid reusing them.
+	  */
 	virtual bool acceptStampedOggPacket(StampedOggPacket* inPacket) = 0;
 };