Fix incorrect 'ms' argument in ov_time_seek_*() docs.
authorTim Terriberry <tterribe@xiph.org>
Thu, 21 Oct 2010 17:33:15 +0000 (17:33 +0000)
committerTim Terriberry <tterribe@xiph.org>
Thu, 21 Oct 2010 17:33:15 +0000 (17:33 +0000)
The actual argument is the time in seconds, as documented, but the
 parameter name 'ms' could lead to confusion.
Thanks to Philipp 'ph3-der-loewe' Schafft <lion@lion.leolix.org> for the
 report.

svn path=/trunk/vorbis/; revision=17552

doc/vorbisfile/ov_time_seek.html
doc/vorbisfile/ov_time_seek_lap.html
doc/vorbisfile/ov_time_seek_page.html
doc/vorbisfile/ov_time_seek_page_lap.html

index 28376b1..c293014 100644 (file)
@@ -38,7 +38,7 @@ int ov_time_seek(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf, double s)
 <dl>
 <dt><i>vf</i></dt>
 <dd>Pointer to our already opened and initialized OggVorbis_File structure.</dd>
-<dt><i>ms</i></dt>
+<dt><i>pos</i></dt>
 <dd>Location to seek to within the file, specified in seconds.</dd>
 </dl>
 
index b609818..c1181ed 100644 (file)
@@ -57,7 +57,7 @@ int ov_time_seek_lap(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf, doubl
 <dl>
 <dt><i>vf</i></dt>
 <dd>Pointer to our already opened and initialized OggVorbis_File structure.</dd>
-<dt><i>ms</i></dt>
+<dt><i>pos</i></dt>
 <dd>Location to seek to within the file, specified in seconds.</dd>
 </dl>
 
index 40e410a..46601a5 100644 (file)
@@ -39,7 +39,7 @@ int ov_time_seek_page(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf, doub
 <dl>
 <dt><i>vf</i></dt>
 <dd>Pointer to our already opened and initialized OggVorbis_File structure.</dd>
-<dt><i>ms</i></dt>
+<dt><i>pos</i></dt>
 <dd>Location to seek to within the file, specified in seconds.</dd>
 </dl>
 
index 75b02d3..63db2cf 100644 (file)
@@ -64,7 +64,7 @@ int ov_time_seek_page_lap(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf,
 <dl>
 <dt><i>vf</i></dt>
 <dd>Pointer to our already opened and initialized OggVorbis_File structure.</dd>
-<dt><i>ms</i></dt>
+<dt><i>pos</i></dt>
 <dd>Location to seek to within the file, specified in seconds.</dd>
 </dl>