diff options
| author | Conrad Parker <conrad@xiph.org> | 2008-12-08 09:07:05 +0000 |
|---|---|---|
| committer | Conrad Parker <conrad@xiph.org> | 2008-12-08 09:07:05 +0000 |
| commit | 444407ba665be5e13a85237fd04c051708051252 (patch) | |
| tree | 40edbf2edc2f64def7da639bb9abfdc7dc2fefef | |
| parent | 33791106b90af88325bcce3622ea1e0379dc319d (diff) | |
| download | libvorbis-git-444407ba665be5e13a85237fd04c051708051252.tar.gz | |
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.
svn path=/trunk/vorbis/; revision=15565
| -rw-r--r-- | doc/programming.html | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/programming.html b/doc/programming.html index 65ccb48a..000adcee 100644 --- a/doc/programming.html +++ b/doc/programming.html @@ -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> |