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

[illiminable at motherfish-iii.xiph.org]

Author: illiminable
Date: 2005-01-08 11:34:11 -0800 (Sat, 08 Jan 2005)
New Revision: 8687

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

Modified: trunk/oggdsf/src/lib/core/ogg/libOOOgg/OggPacket.h
===================================================================
--- trunk/oggdsf/src/lib/core/ogg/libOOOgg/OggPacket.h	2005-01-08 19:30:21 UTC (rev 8686)
+++ trunk/oggdsf/src/lib/core/ogg/libOOOgg/OggPacket.h	2005-01-08 19:34:11 UTC (rev 8687)
@@ -42,9 +42,11 @@
 	OggPacket(void);
 	OggPacket(unsigned char* inPackData, unsigned long inPacketSize, bool inIsTruncated, bool inIsContinuation);
 	virtual ~OggPacket(void);
-	virtual OggPacket* clone();
 
 	static const unsigned long HEX_DUMP_LINE_LENGTH = 16;
+
+	/// Does a deep copy of this packet and returns a new one for you to keep.
+	virtual OggPacket* clone();
 					
 	/// Returns the size of the contained packet.
 	unsigned long packetSize() const;

Modified: trunk/oggdsf/src/lib/core/ogg/libOOOgg/OggPacketiser.h
===================================================================
--- trunk/oggdsf/src/lib/core/ogg/libOOOgg/OggPacketiser.h	2005-01-08 19:30:21 UTC (rev 8686)
+++ trunk/oggdsf/src/lib/core/ogg/libOOOgg/OggPacketiser.h	2005-01-08 19:34:11 UTC (rev 8687)
@@ -55,18 +55,22 @@
 	OggPacketiser(IStampedOggPacketSink* inPacketSink);
 	virtual ~OggPacketiser(void);
 
-	//IOggCallback implementation
+	/// Takes incoming pages, and fires the packets to the packet sink.
 	virtual bool acceptOggPage(OggPage* inOggPage);
 
-	//Packet sink control
+	/// Set the callback interface where generated packets will go.
 	void setPacketSink(IStampedOggPacketSink* inPacketSink);
+
+	/// Returns a pointer to the interface recieving packets.
 	IStampedOggPacketSink* packetSink();
 
-	//Ignore packets controls.
+	/// Tell the packetiser to ignore this many following packets.
 	void setNumIgnorePackets(unsigned long inNumIgnorePackets);
+
+	/// How many packets we are ignoring.
 	unsigned long numIgnorePackets();
 
-	//Packetiser state control
+	/// Reset the packetiser.
 	bool reset();
 
 protected: