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

[illiminable at motherfish-iii.xiph.org]

Author: illiminable
Date: 2005-01-08 11:50:45 -0800 (Sat, 08 Jan 2005)
New Revision: 8690

Modified:
   trunk/oggdsf/src/lib/core/ogg/libOOOgg/StampedOggPacket.h
Log:
* Docs for stamped ogg packet.

Modified: trunk/oggdsf/src/lib/core/ogg/libOOOgg/StampedOggPacket.h
===================================================================
--- trunk/oggdsf/src/lib/core/ogg/libOOOgg/StampedOggPacket.h	2005-01-08 19:47:37 UTC (rev 8689)
+++ trunk/oggdsf/src/lib/core/ogg/libOOOgg/StampedOggPacket.h	2005-01-08 19:50:45 UTC (rev 8690)
@@ -37,12 +37,6 @@
 	:	public OggPacket
 {
 public:
-	//Constructors
-	StampedOggPacket(void);
-	StampedOggPacket(unsigned char* inPackData, unsigned long inPacketSize, bool inIsTruncated, bool inIsContinuation, LOOG_INT64 inStartTime, LOOG_INT64 inEndTime, unsigned short inStampType);
-	virtual ~StampedOggPacket(void);
-	virtual OggPacket* clone();
-
 	//Public Constants and Enums
 	enum eStampType {
 		NONE = 0,
@@ -50,18 +44,34 @@
 		OGG_BOTH = 2,
 		DIRECTSHOW = 3
 	};
+
+	//Constructors
+	StampedOggPacket(void);
+	StampedOggPacket(unsigned char* inPackData, unsigned long inPacketSize, bool inIsTruncated, bool inIsContinuation, LOOG_INT64 inStartTime, LOOG_INT64 inEndTime, unsigned short inStampType);
+	virtual ~StampedOggPacket(void);
+
+	/// Does a deep copy of the packet a returns you a new one you can keep.
+	virtual OggPacket* clone();
+
 	//TODO::: should not be global.
 	unsigned short mStampType;
 
-	//Time stamp access
+	/// Returns the start time of the packet. (Check stamp type)
 	LOOG_INT64 startTime();
+
+	/// Returns the end time of the packet (Check stamp type)
 	LOOG_INT64 endTime();
 
+	/// Sets the start time of the packet (You need to set stamp type appropriately)
 	void setStartTime(LOOG_INT64 inStartTime);
+
+	/// Sets the end time of the packet (You need to set stamp type appropriately)
 	void setEndTime(LOOG_INT64 inEndTime);
-	void StampedOggPacket::setTimeStamp(LOOG_INT64 inStartTime, LOOG_INT64 inEndTime, StampedOggPacket::eStampType inStampType);
 
-	//Merge function
+	/// Sets the time stamp in one hit.
+	void setTimeStamp(LOOG_INT64 inStartTime, LOOG_INT64 inEndTime, StampedOggPacket::eStampType inStampType);
+
+	/// Merges two packets together.
 	virtual void merge(const StampedOggPacket* inMorePacket);
 
 protected: