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

[illiminable at motherfish-iii.xiph.org]

Author: illiminable
Date: 2005-01-08 11:37:38 -0800 (Sat, 08 Jan 2005)
New Revision: 8688

Modified:
   trunk/oggdsf/src/lib/core/ogg/libOOOgg/OggPage.h
Log:
* Document oggpage.

Modified: trunk/oggdsf/src/lib/core/ogg/libOOOgg/OggPage.h
===================================================================
--- trunk/oggdsf/src/lib/core/ogg/libOOOgg/OggPage.h	2005-01-08 19:34:11 UTC (rev 8687)
+++ trunk/oggdsf/src/lib/core/ogg/libOOOgg/OggPage.h	2005-01-08 19:37:38 UTC (rev 8688)
@@ -52,26 +52,32 @@
 	OggPage(void);
 	virtual ~OggPage(void);
 
-	//Cloning
+	/// Doa deep copy of the page and return one you can keep.
 	OggPage* clone();
 	
-	//Size functions
+	//// Returns the total byte size of the current page.
 	unsigned long pageSize();
+
+	/// Returns the size of the header including segment table.
 	unsigned long headerSize();
+
+	/// Returns the size of the data part of the page.
 	unsigned long dataSize();
 
 	//IOggPackSource Implementation
 	virtual OggPacket* getPacket(unsigned long inPacketNo);
 	virtual unsigned long numPackets();
 
-	//Packet access
+	/// Get the numbers stamped packet from the page.
 	StampedOggPacket* getStampedPacket(unsigned long inPacketNo);
+
+	//TODO::: This really shouldn't be ehere.
 	bool addPacket(StampedOggPacket* inPacket);
 	
-	//Header access
+	/// Returns a pointer to the internal header.
 	OggPageHeader* header();
 	
-	//Serialise
+	/// Creates a buffer of size pageSize and returns you a pointer to keep.
 	unsigned char* createRawPageData();
 
 protected: