Add Doxygen comment similar to ff_xvmc_field_start() to ff_xvmc_field_end().

Originally committed as revision 17296 to svn://svn.ffmpeg.org/ffmpeg/trunk

diff --git a/libavcodec/mpegvideo_xvmc.c b/libavcodec/mpegvideo_xvmc.c
index 2e50814ab1ecc13b65f8456499728e2a1d8e6aa9..af7497e56335d5032783ebbd0f923895922120d0 100644 (file)
--- a/libavcodec/mpegvideo_xvmc.c
+++ b/libavcodec/mpegvideo_xvmc.c
@@ -109,6 +109,10 @@ int ff_xvmc_field_start(MpegEncContext*s, AVCodecContext *avctx)
 return -1;
 }
 
+/**
+ * This function should be called for every new field and/or frame.
+ * It should be safe to call the function a few times for the same field.
+ */
 void ff_xvmc_field_end(MpegEncContext *s)
 {
     struct xvmc_render_state *render = (struct xvmc_render_state*)s->current_picture.data[2];