[xiph-commits] r9767 - trunk/vorbis/doc/vorbisfile

[msmith at svn.xiph.org]

Author: msmith
Date: 2005-08-17 07:13:34 -0700 (Wed, 17 Aug 2005)
New Revision: 9767

Modified:
   trunk/vorbis/doc/vorbisfile/ov_raw_tell.html
Log:
Clarify usage of ov_raw_tell a little bit.


Modified: trunk/vorbis/doc/vorbisfile/ov_raw_tell.html
===================================================================
--- trunk/vorbis/doc/vorbisfile/ov_raw_tell.html	2005-08-17 05:08:15 UTC (rev 9766)
+++ trunk/vorbis/doc/vorbisfile/ov_raw_tell.html	2005-08-17 14:13:34 UTC (rev 9767)
@@ -17,8 +17,10 @@
 
 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
 
-<p>Returns the current offset in raw compressed bytes.
+<p>Returns the current offset in raw compressed bytes.</p>
 
+<p>Note that if you later use ov_raw_seek() to return to this point, you won't generally get back to exactly the same place, due to internal buffering. Also note that a read operation may not cause a change to the current raw offset - only a read that requires reading more data from the underlying data source will do that.</p>
+
 <br><br>
 <table border=0 color=black cellspacing=0 cellpadding=7>
 <tr bgcolor=#cccccc>