avformat/internal: Improve documentation of ff_packet_list_get
authorAndreas Rheinhardt <andreas.rheinhardt@gmail.com>
Mon, 19 Aug 2019 21:56:18 +0000 (23:56 +0200)
committerMichael Niedermayer <michael@niedermayer.cc>
Wed, 18 Sep 2019 20:53:00 +0000 (22:53 +0200)
commit8b1be6e5eb8560ed19e7f22616041a6094610137
tree58ac45212f40cf84913911395758ff6da6268c06
parent1d86e4b3ebb4905c1e08b7a8db203e19cbce10e3
avformat/internal: Improve documentation of ff_packet_list_get

The documentation of ff_packet_list_get currently didn't match the
actual usage:
1. It said that the destination packet is supposed to be initialized.
But this makes no sense given that it will be overwritten completely and
flacenc, mp3enc and ttaenc ignored this.
2. ff_packet_list_get returns an int, although it can't fail in case the
packet list is not empty (for which there is an assert). Again, several
callers didn't check for any return value.
In both cases, the documentation has been adapted to match actual usage.

Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@gmail.com>
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
libavformat/internal.h