programming.html: clarify that ogg_sync_clear() is an alternative to
authorConrad Parker <conrad@xiph.org>
Mon, 8 Dec 2008 09:07:05 +0000 (09:07 +0000)
committerConrad Parker <conrad@xiph.org>
Mon, 8 Dec 2008 09:07:05 +0000 (09:07 +0000)
ogg_sync_destroy() -- ie. this paragraph is not a typo.
Need for clarification suggested by Philipp Schafft.

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

doc/programming.html

index 65ccb48..000adce 100644 (file)
@@ -490,9 +490,9 @@ int    ogg_sync_destroy(ogg_sync_state *oy);
 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>