Update the documentation for theora_encode_comment().
authorTim Terriberry <tterribe@xiph.org>
Fri, 20 May 2011 21:27:08 +0000 (21:27 +0000)
committerTim Terriberry <tterribe@xiph.org>
Fri, 20 May 2011 21:27:08 +0000 (21:27 +0000)
commit5e030b6fccfaaf3ce6b64996497d1d24b581e4b1
tree2e52ece2a8159460f564cf8b95bcf53f46c90365
parent63c12c8b6d99307de4c26fd00bb16569ccab8372
Update the documentation for theora_encode_comment().

It wrongly claimed the returned buffer was owned by libtheora, when
 in reality libtheora was creating a temporary buffer and not
 storing the pointer to the returned packet anywhere.
Since there's no encoder parameter passed to this function, it
 doesn't even have a place to store it.
This situation is sub-optimal, but can be solved by migrating to
 the 1.0 API, which does require an encoder instance to encode a
 comment, and thus does not have this problem.

Fixes #726.

svn path=/trunk/theora/; revision=17994
examples/player_example.c
include/theora/theora.h