[matroska] r1032 - trunk/libebml/ebml

[email protected]
Newsgroups gmane.comp.multimedia.matroska.cvs
Message-ID <[email protected]>
Author: robux4
Date: 2005-01-11 01:34:48 +0300 (Tue, 11 Jan 2005)
New Revision: 1032

Modified:
   trunk/libebml/ebml/EbmlElement.h
Log:
libebml: more comments on what size functions return and when they should be used

Modified: trunk/libebml/ebml/EbmlElement.h
===================================================================
--- trunk/libebml/ebml/EbmlElement.h	2005-01-10 21:57:47 UTC (rev 1031)
+++ trunk/libebml/ebml/EbmlElement.h	2005-01-10 22:34:48 UTC (rev 1032)
@@ -182,12 +182,12 @@
 
 		uint64 GetElementPosition() const {return ElementPosition;}
 
-		uint64 ElementSize(bool bSaveDefault = false) const; /// return the size of the header+data
+		uint64 ElementSize(bool bSaveDefault = false) const; /// return the size of the header+data, before writing
 		
 		uint32 Render(IOCallback & output, bool bSaveDefault = false, bool bKeepPosition = false, bool bForceRender = false);
 
 		virtual uint64 UpdateSize(bool bSaveDefault = false, bool bForceRender = false) = 0; /// update the Size of the Data stored
-		virtual uint64 GetSize() const {return Size;}
+		virtual uint64 GetSize() const {return Size;} /// return the size of the data stored in the element, on reading
 
 		virtual uint64 ReadData(IOCallback & input, ScopeMode ReadFully = SCOPE_ALL_DATA) = 0;
 		virtual void Read(EbmlStream & inDataStream, const EbmlSemanticContext & Context, int & UpperEltFound, EbmlElement * & FoundElt, bool AllowDummyElt = false, ScopeMode ReadFully = SCOPE_ALL_DATA);
@@ -210,7 +210,7 @@
 		virtual bool IsDummy() const {return false;}
 		virtual bool IsMaster() const {return false;}
 
-		uint8 HeadSize() const {return EbmlId(*this).Length + CodedSizeLength(Size, SizeLength);}
+		uint8 HeadSize() const {return EbmlId(*this).Length + CodedSizeLength(Size, SizeLength);} /// return the size of the head, on reading/writing
 		
 		/*!
 			\brief Force the size of an element
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.