[x264-devel] x264.h: fix documentation

[Jason Garrett-Glaser]

x264 | branch: master | Jason Garrett-Glaser <jason at x264.com> | Mon Mar 10 08:42:50 2014 -0700| [aff928d2a2f601072cebecfd1ac5ff768880cf88] | committer: Jason Garrett-Glaser

x264.h: fix documentation

The full details of the return values of encoder_encode and encoder_headers
were mistakenly removed a while ago; re-add them.

> http://git.videolan.org/gitweb.cgi/x264.git/?a=commit;h=aff928d2a2f601072cebecfd1ac5ff768880cf88
---

 x264.h |    4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/x264.h b/x264.h
index 225a269..2e4a98d 100644
--- a/x264.h
+++ b/x264.h
@@ -884,13 +884,15 @@ void    x264_encoder_parameters( x264_t *, x264_param_t * );
 /* x264_encoder_headers:
  *      return the SPS and PPS that will be used for the whole stream.
  *      *pi_nal is the number of NAL units outputted in pp_nal.
+ *      returns the number of bytes in the returned NALs.
  *      returns negative on error.
  *      the payloads of all output NALs are guaranteed to be sequential in memory. */
 int     x264_encoder_headers( x264_t *, x264_nal_t **pp_nal, int *pi_nal );
 /* x264_encoder_encode:
  *      encode one picture.
  *      *pi_nal is the number of NAL units outputted in pp_nal.
- *      returns negative on error, zero if no NAL units returned.
+ *      returns the number of bytes in the returned NALs.
+ *      returns negative on error and zero if no NAL units returned.
  *      the payloads of all output NALs are guaranteed to be sequential in memory. */
 int     x264_encoder_encode( x264_t *, x264_nal_t **pp_nal, int *pi_nal, x264_picture_t *pic_in, x264_picture_t *pic_out );
 /* x264_encoder_close: