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

[illiminable at motherfish-iii.xiph.org]

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

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

Modified: trunk/oggdsf/src/lib/core/ogg/libOOOgg/OggDataBuffer.h
===================================================================
--- trunk/oggdsf/src/lib/core/ogg/libOOOgg/OggDataBuffer.h	2005-01-08 19:26:21 UTC (rev 8685)
+++ trunk/oggdsf/src/lib/core/ogg/libOOOgg/OggDataBuffer.h	2005-01-08 19:30:21 UTC (rev 8686)
@@ -89,7 +89,7 @@
 	OggDataBuffer(void);
 	virtual ~OggDataBuffer(void);
 
-	/// Register a as a callback, which gets called when data is received via our feed() method.
+	/// Register as a callback, which gets called when data is received via our feed() method.
 	bool registerStaticCallback(fPageCallback inPageCallback, void* inUserData);
 
 	/// Register an IOggCallback object, which gets called when data is received via our feed() method.

Modified: trunk/oggdsf/src/lib/core/ogg/libOOOgg/OggPacket.h
===================================================================
--- trunk/oggdsf/src/lib/core/ogg/libOOOgg/OggPacket.h	2005-01-08 19:26:21 UTC (rev 8685)
+++ trunk/oggdsf/src/lib/core/ogg/libOOOgg/OggPacket.h	2005-01-08 19:30:21 UTC (rev 8686)
@@ -46,32 +46,41 @@
 
 	static const unsigned long HEX_DUMP_LINE_LENGTH = 16;
 					
-	//Packet accessors
+	/// Returns the size of the contained packet.
 	unsigned long packetSize() const;
+
+	/// Returns a pointer to the internal packet buffer.
 	unsigned char* packetData();
-	//bool isComplete() const;
+	
+	/// Returns whether this packet is truncated.
 	bool isTruncated() const;
+
+	/// Returns whether this packet is continued from another one.
 	bool isContinuation() const;
 
-	//Packet Mutators
-	//void setIsComplete (bool inIsComplete );
+	/// Set the truncated flag on this packet.
+	void setIsTruncated(bool inIsTruncated);
 
-	void setIsTruncated(bool inIsTruncated);
+	/// Set the continuation flag on this packet.
 	void setIsContinuation(bool inIsContinuation);
+
+	/// Set the size of this packet.
 	void setPacketSize (unsigned long inPacketSize );
+
+	/// Give a buffer to kept as the internal packet buffer.
 	void setPacketData (unsigned char* inPacketData );
 
-	//Merge function
+	/// Merges this packet to another one you pass it.
 	virtual void merge(const OggPacket* inMorePacket);
 
-	//TODO::: Should this be here ?
+	/// Turns the packet into a hex dump string.
 	string toPackDumpString();
 	
 protected:
 	//Packet member data
 	unsigned long mPacketSize;
 	unsigned char* mPacketData;
-	//bool mIsComplete;
+
 	bool mIsTruncated;
 	bool mIsContinuation;