changeset 11556:b94e1810ce4c libavcodec

Replace @returns by @return.
author benoit
date Tue, 30 Mar 2010 15:50:57 +0000
parents e603f624b03f
children 53822d92c3f7
files cavs.c h264.h h264_cabac.c h264enc.c mpeg4videodec.c parser.c wmavoice.c
diffstat 7 files changed, 12 insertions(+), 12 deletions(-) [+]
line wrap: on
line diff
--- a/cavs.c	Tue Mar 30 08:10:29 2010 +0000
+++ b/cavs.c	Tue Mar 30 15:50:57 2010 +0000
@@ -572,7 +572,7 @@
 /**
  * save predictors for later macroblocks and increase
  * macroblock address
- * @returns 0 if end of frame is reached, 1 otherwise
+ * @return 0 if end of frame is reached, 1 otherwise
  */
 int ff_cavs_next_mb(AVSContext *h) {
     int i;
--- a/h264.h	Tue Mar 30 08:10:29 2010 +0000
+++ b/h264.h	Tue Mar 30 15:50:57 2010 +0000
@@ -623,7 +623,7 @@
  * @param consumed is the number of bytes used as input
  * @param length is the length of the array
  * @param dst_length is the number of decoded bytes FIXME here or a decode rbsp tailing?
- * @returns decoded bytes, might be src+1 if no escapes
+ * @return decoded bytes, might be src+1 if no escapes
  */
 const uint8_t *ff_h264_decode_nal(H264Context *h, const uint8_t *src, int *dst_length, int *consumed, int length);
 
@@ -685,13 +685,13 @@
 
 /**
  * decodes a macroblock
- * @returns 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
+ * @return 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
  */
 int ff_h264_decode_mb_cavlc(H264Context *h);
 
 /**
  * decodes a CABAC coded macroblock
- * @returns 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
+ * @return 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
  */
 int ff_h264_decode_mb_cabac(H264Context *h);
 
@@ -1165,7 +1165,7 @@
 
 /**
  *
- * @returns non zero if the loop filter can be skiped
+ * @return non zero if the loop filter can be skiped
  */
 static int fill_filter_caches(H264Context *h, int mb_type){
     MpegEncContext * const s = &h->s;
--- a/h264_cabac.c	Tue Mar 30 08:10:29 2010 +0000
+++ b/h264_cabac.c	Tue Mar 30 15:50:57 2010 +0000
@@ -1181,7 +1181,7 @@
 
 /**
  * decodes a macroblock
- * @returns 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
+ * @return 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
  */
 int ff_h264_decode_mb_cabac(H264Context *h) {
     MpegEncContext * const s = &h->s;
--- a/h264enc.c	Tue Mar 30 08:10:29 2010 +0000
+++ b/h264enc.c	Tue Mar 30 15:50:57 2010 +0000
@@ -31,7 +31,7 @@
  * @param dest the target buffer, dst+1 == src is allowed as a special case
  * @param destsize the length of the dst array
  * @param b2 the data which should be escaped
- * @returns pointer to current position in the output buffer or NULL if an error occurred
+ * @return pointer to current position in the output buffer or NULL if an error occurred
  */
 static uint8_t *h264_write_nal_unit(int nal_ref_idc, int nal_unit_type, uint8_t *dest, int *destsize,
                           PutBitContext *b2)
--- a/mpeg4videodec.c	Tue Mar 30 08:10:29 2010 +0000
+++ b/mpeg4videodec.c	Tue Mar 30 15:50:57 2010 +0000
@@ -435,7 +435,7 @@
 /**
  * gets the average motion vector for a GMC MB.
  * @param n either 0 for the x component or 1 for y
- * @returns the average MV for a GMC MB
+ * @return the average MV for a GMC MB
  */
 static inline int get_amv(MpegEncContext *s, int n){
     int x, y, mb_v, sum, dx, dy, shift;
--- a/parser.c	Tue Mar 30 08:10:29 2010 +0000
+++ b/parser.c	Tue Mar 30 15:50:57 2010 +0000
@@ -244,7 +244,7 @@
 
 /**
  * combines the (truncated) bitstream to a complete frame
- * @returns -1 if no complete frame could be created, AVERROR(ENOMEM) if there was a memory allocation error
+ * @return -1 if no complete frame could be created, AVERROR(ENOMEM) if there was a memory allocation error
  */
 int ff_combine_frame(ParseContext *pc, int next, const uint8_t **buf, int *buf_size)
 {
--- a/wmavoice.c	Tue Mar 30 08:10:29 2010 +0000
+++ b/wmavoice.c	Tue Mar 30 15:50:57 2010 +0000
@@ -754,7 +754,7 @@
  * @param block_num current block index
  * @param block_size amount of entries we want to read from a table
  *                   that has 1000 entries
- * @returns a (non-)random number in the [0, 1000 - block_size] range.
+ * @return a (non-)random number in the [0, 1000 - block_size] range.
  */
 static int pRNG(int frame_cntr, int block_num, int block_size)
 {
@@ -1187,7 +1187,7 @@
  *                does not modify the state of the bitreader; it
  *                only uses it to copy the current stream position
  * @param s WMA Voice decoding context private data
- * @returns -1 if unsupported, 1 on not enough bits or 0 if OK.
+ * @return -1 if unsupported, 1 on not enough bits or 0 if OK.
  */
 static int check_bits_for_superframe(GetBitContext *orig_gb,
                                      WMAVoiceContext *s)
@@ -1391,7 +1391,7 @@
  * decoder).
  *
  * @param s WMA Voice decoding context private data
- * @returns 1 if not enough bits were available, or 0 on success.
+ * @return 1 if not enough bits were available, or 0 on success.
  */
 static int parse_packet_header(WMAVoiceContext *s)
 {