[FFmpeg-cvslog] intrax8: Move documentation from implementation to header file

[Vittorio Giovara]

ffmpeg | branch: master | Vittorio Giovara <vittorio.giovara at gmail.com> | Sat Feb 20 01:34:18 2016 -0500| [ad8aa8e6c648b61f01b9f106f27b9d4f3d094345] | committer: Vittorio Giovara

intrax8: Move documentation from implementation to header file

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

 libavcodec/intrax8.c |   20 --------------------
 libavcodec/intrax8.h |   22 ++++++++++++++++++++++
 2 files changed, 22 insertions(+), 20 deletions(-)

diff --git a/libavcodec/intrax8.c b/libavcodec/intrax8.c
index cbcf9aa..6c168ec 100644
--- a/libavcodec/intrax8.c
+++ b/libavcodec/intrax8.c
@@ -739,12 +739,6 @@ static void x8_init_block_index(MpegEncContext *s)
     s->dest[2] += (s->mb_y & (~1)) * uvlinesize << 2;
 }
 
-/**
- * Initialize IntraX8 frame decoder.
- * Requires valid MpegEncContext with valid s->mb_width before calling.
- * @param w pointer to IntraX8Context
- * @param s pointer to MpegEncContext of the parent codec
- */
 av_cold void ff_intrax8_common_init(IntraX8Context *w, MpegEncContext *const s)
 {
     w->s = s;
@@ -764,25 +758,11 @@ av_cold void ff_intrax8_common_init(IntraX8Context *w, MpegEncContext *const s)
     ff_intrax8dsp_init(&w->dsp);
 }
 
-/**
- * Destroy IntraX8 frame structure.
- * @param w pointer to IntraX8Context
- */
 av_cold void ff_intrax8_common_end(IntraX8Context *w)
 {
     av_freep(&w->prediction_table);
 }
 
-/**
- * Decode single IntraX8 frame.
- * The parent codec must fill s->loopfilter and s->gb (bitstream).
- * The parent codec must call ff_mpv_frame_start() before calling this function.
- * The parent codec must call ff_mpv_frame_end() after calling this function.
- * This function does not use ff_mpv_decode_mb().
- * @param w pointer to IntraX8Context
- * @param dquant doubled quantizer, it would be odd in case of VC-1 halfpq==1.
- * @param quant_offset offset away from zero
- */
 int ff_intrax8_decode_picture(IntraX8Context *const w, int dquant,
                               int quant_offset)
 {
diff --git a/libavcodec/intrax8.h b/libavcodec/intrax8.h
index 83e984b..3339bc6 100644
--- a/libavcodec/intrax8.h
+++ b/libavcodec/intrax8.h
@@ -56,8 +56,30 @@ typedef struct IntraX8Context {
     int est_run;
 } IntraX8Context;
 
+/**
+ * Initialize IntraX8 frame decoder.
+ * Requires valid MpegEncContext with valid s->mb_width before calling.
+ * @param w pointer to IntraX8Context
+ * @param s pointer to MpegEncContext of the parent codec
+ */
 void ff_intrax8_common_init(IntraX8Context *w, MpegEncContext *const s);
+
+/**
+ * Destroy IntraX8 frame structure.
+ * @param w pointer to IntraX8Context
+ */
 void ff_intrax8_common_end(IntraX8Context *w);
+
+/**
+ * Decode single IntraX8 frame.
+ * The parent codec must fill s->loopfilter and s->gb (bitstream).
+ * The parent codec must call ff_mpv_frame_start() before calling this function.
+ * The parent codec must call ff_mpv_frame_end() after calling this function.
+ * This function does not use ff_mpv_decode_mb().
+ * @param w pointer to IntraX8Context
+ * @param dquant doubled quantizer, it would be odd in case of VC-1 halfpq==1.
+ * @param quant_offset offset away from zero
+ */
 int ff_intrax8_decode_picture(IntraX8Context *w, int quant, int halfpq);
 
 #endif /* AVCODEC_INTRAX8_H */