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

[ozone at motherfish-iii.xiph.org]

Author: ozone
Date: 2005-01-01 23:15:46 -0800 (Sat, 01 Jan 2005)
New Revision: 8571

Modified:
   trunk/oggdsf/src/lib/core/ogg/libOOOgg/IOggCallback.h
   trunk/oggdsf/src/lib/core/ogg/libOOOgg/OggDataBuffer.cpp
Log:
oggdsf:
 * Documentation++



Modified: trunk/oggdsf/src/lib/core/ogg/libOOOgg/IOggCallback.h
===================================================================
--- trunk/oggdsf/src/lib/core/ogg/libOOOgg/IOggCallback.h	2005-01-01 18:39:41 UTC (rev 8570)
+++ trunk/oggdsf/src/lib/core/ogg/libOOOgg/IOggCallback.h	2005-01-02 07:15:46 UTC (rev 8571)
@@ -40,11 +40,11 @@
 	virtual ~IOggCallback(void)			{}
 
 
-	//All callers to acceptOggPage 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.
-	// 
+	/** All callers to acceptOggPage 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 acceptOggPage(OggPage* inOggPage) = 0;
 };

Modified: trunk/oggdsf/src/lib/core/ogg/libOOOgg/OggDataBuffer.cpp
===================================================================
--- trunk/oggdsf/src/lib/core/ogg/libOOOgg/OggDataBuffer.cpp	2005-01-01 18:39:41 UTC (rev 8570)
+++ trunk/oggdsf/src/lib/core/ogg/libOOOgg/OggDataBuffer.cpp	2005-01-02 07:15:46 UTC (rev 8571)
@@ -68,9 +68,15 @@
 	
 }
 
-/** The inUserData parameter is a pointer of any type.  This pointer is passed to the callback when it
-    is called, enabling the user to save any custom information in its callback.
+
+/** The inUserData parameter is a pointer of any type.  This pointer is passed
+    to the callback when it is called, enabling the user to save any custom
+    information in its callback.  Note that your callback function is
+    responsible for deleting the OggPage passed to it (and NULL the OggPage
+    pointer after deletion): see IOggCallback::acceptOggPage() for more
+    information.
   */
+
 bool OggDataBuffer::registerStaticCallback(fPageCallback inPageCallback, void* inUserData)
 {
 	//Holds the static callback and nulls the virtual one.
@@ -80,6 +86,7 @@
 	
 	return true;
 }
+
 //bool OggDataBuffer::registerSerialNo(SerialNoRego* inSerialRego) {
 //	if (inSerialRego != NULL) {
 //		mSerialNoCallList.push_back(inSerialRego);
@@ -89,6 +96,12 @@
 //	}
 //}
 
+
+/** Note that your callback function is responsible for deleting the OggPage
+    passed to it (and NULL the OggPage pointer after deletion): see the
+    IOggCallback class for more information.
+  */
+
 bool OggDataBuffer::registerVirtualCallback(IOggCallback* inPageCallback) {
 	//Holds the virtual callback and nulls the static one.
 	mVirtualCallback = inPageCallback;
@@ -472,4 +485,4 @@
 //Debug Only
 void OggDataBuffer::debugWrite(string inString) {
 	//debugLog<<inString<<endl;
-}
\ No newline at end of file
+}