diff options
| author | Ralph Giles <giles@xiph.org> | 2010-10-09 05:51:25 +0000 |
|---|---|---|
| committer | Ralph Giles <giles@xiph.org> | 2010-10-09 05:51:25 +0000 |
| commit | 06a823f418a6ed3882b0b7273ff33bbe1e43e21c (patch) | |
| tree | ab925c3fa2a14a4b5b627d5e19a838f10db0426c /doc | |
| parent | 8f269ea58e5d16300c74574bcd6291efd98b8d6f (diff) | |
| download | ogg-git-06a823f418a6ed3882b0b7273ff33bbe1e43e21c.tar.gz | |
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.
svn path=/trunk/ogg/; revision=17497
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/libogg/ogg_packet_clear.html | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/libogg/ogg_packet_clear.html b/doc/libogg/ogg_packet_clear.html index 513455b..61edac7 100644 --- a/doc/libogg/ogg_packet_clear.html +++ b/doc/libogg/ogg_packet_clear.html @@ -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> |