aboutsummaryrefslogtreecommitdiff
path: root/doc/libogg/ogg_packet_clear.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/libogg/ogg_packet_clear.html')
-rw-r--r--doc/libogg/ogg_packet_clear.html16
1 files changed, 9 insertions, 7 deletions
diff --git a/doc/libogg/ogg_packet_clear.html b/doc/libogg/ogg_packet_clear.html
index fa3ef17..ba3a455 100644
--- a/doc/libogg/ogg_packet_clear.html
+++ b/doc/libogg/ogg_packet_clear.html
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>libogg documentation</p></td>
-<td align=right><p class=tiny>libogg release 1.2.0 - 20100325</p></td>
+<td align=right><p class=tiny>libogg release 1.3.5 - 20210603</p></td>
</tr>
</table>
@@ -17,14 +17,16 @@
<p><i>declared in "ogg/ogg.h";</i></p>
-<p>This function clears the memory used by the <a href="ogg_packet.html">ogg_packet</a> struct, and frees the internal allocated memory, but does not free
-the structure itself.
+<p>This function clears the memory used by the <a href="ogg_packet.html">ogg_packet</a> struct,
+but does not free the structure itself.
+It unconditionally frees the <i>packet</i> data buffer,
+then it zeros all structure members.
<br><br>
<table border=0 color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
<td>
<pre><b>
-int ogg_packet_clear(ogg_packet *op);
+void ogg_packet_clear(ogg_packet *op);
</b></pre>
</td>
</tr>
@@ -32,7 +34,7 @@ int ogg_packet_clear(ogg_packet *op);
<h3>Parameters</h3>
<dl>
-<dt><i>os</i></dt>
+<dt><i>op</i></dt>
<dd>Pointer to the ogg_packet struct to be cleared.</dd>
</dl>
@@ -48,11 +50,11 @@ None.</li>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
+<td><p class=tiny>copyright &copy; 2000-2021 Xiph.Org Foundation</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
</tr><tr>
<td><p class=tiny>libogg documentation</p></td>
-<td align=right><p class=tiny>libogg release 1.2.0 - 20100325</p></td>
+<td align=right><p class=tiny>libogg release 1.3.5 - 20210603</p></td>
</tr>
</table>