From 558181eaaca2afff58893610f6d19b96f72e7821 Mon Sep 17 00:00:00 2001 From: Ralph Giles Date: Sat, 9 Oct 2010 05:51:25 +0000 Subject: 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. git-svn-id: http://svn.xiph.org/trunk/ogg@17497 0101bb08-14d6-0310-b084-bc0e0c8e3800 --- doc/libogg/ogg_packet_clear.html | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'doc') 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 @@

declared in "ogg/ogg.h";

-

This function clears the memory used by the ogg_packet struct, and frees the internal allocated memory, but does not free -the structure itself. +

This function clears the memory used by the ogg_packet struct, +but does not free the structure itself. +It unconditionally frees the packet data buffer, +then it zeros all structure members.

-- cgit v1.2.1