[xiph-commits] r17497 - trunk/ogg/doc/libogg

[giles at svn.xiph.org]

Author: giles
Date: 2010-10-08 22:51:25 -0700 (Fri, 08 Oct 2010)
New Revision: 17497

Modified:
   trunk/ogg/doc/libogg/ogg_packet_clear.html
Log:
Explicitly document what ogg_packet_clear() does.

The ogg_packet structure is public, and contains no 'internal' data,
except in that decoding functions allocate and own the returned buffer.
When a client creates packets to pass into the encoding functions it
is instead the client which owns the buffer. Nevertheless,
ogg_packet_clear() can be useful if the client is using a simple
allocation strategy. I wanted to be clear that it was appropriate
to use this call for such packets.


Modified: trunk/ogg/doc/libogg/ogg_packet_clear.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_packet_clear.html	2010-10-09 05:29:32 UTC (rev 17496)
+++ trunk/ogg/doc/libogg/ogg_packet_clear.html	2010-10-09 05:51:25 UTC (rev 17497)
@@ -17,8 +17,10 @@
 
 <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>