[xiph-commits] r15565 - trunk/vorbis/doc

[conrad at svn.xiph.org]

Author: conrad
Date: 2008-12-08 01:07:05 -0800 (Mon, 08 Dec 2008)
New Revision: 15565

Modified:
   trunk/vorbis/doc/programming.html
Log:
programming.html: clarify that ogg_sync_clear() is an alternative to
ogg_sync_destroy() -- ie. this paragraph is not a typo.
Need for clarification suggested by Philipp Schafft.


Modified: trunk/vorbis/doc/programming.html
===================================================================
--- trunk/vorbis/doc/programming.html	2008-12-06 13:41:48 UTC (rev 15564)
+++ trunk/vorbis/doc/programming.html	2008-12-08 09:07:05 UTC (rev 15565)
@@ -490,9 +490,9 @@
 buffer, then frees the storage associated with the pointer
 <tt>oy</tt>.</p>
 
-<p><tt>ogg_sync_clear</tt> does not call <tt>free()</tt> on the pointer
-<tt>oy</tt>, allowing use of that call on stream structures in static
-or automatic storage.</p>
+<p>An alternative function,<tt>ogg_sync_clear</tt>, does not call
+<tt>free()</tt> on the pointer <tt>oy</tt>, allowing use of that call on
+stream structures in static or automatic storage.</p>
 
 <p>Returns zero on success and non-zero on failure. This function always
 succeeds.</p>