Browse code

Replace @returns by @return.

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

Benoit Fouet authored on 2010/03/31 00:50:57
Showing 15 changed files
... ...
@@ -572,7 +572,7 @@ void ff_cavs_init_mb(AVSContext *h) {
572 572
 /**
573 573
  * save predictors for later macroblocks and increase
574 574
  * macroblock address
575
- * @returns 0 if end of frame is reached, 1 otherwise
575
+ * @return 0 if end of frame is reached, 1 otherwise
576 576
  */
577 577
 int ff_cavs_next_mb(AVSContext *h) {
578 578
     int i;
... ...
@@ -623,7 +623,7 @@ int ff_h264_decode_picture_parameter_set(H264Context *h, int bit_length);
623 623
  * @param consumed is the number of bytes used as input
624 624
  * @param length is the length of the array
625 625
  * @param dst_length is the number of decoded bytes FIXME here or a decode rbsp tailing?
626
- * @returns decoded bytes, might be src+1 if no escapes
626
+ * @return decoded bytes, might be src+1 if no escapes
627 627
  */
628 628
 const uint8_t *ff_h264_decode_nal(H264Context *h, const uint8_t *src, int *dst_length, int *consumed, int length);
629 629
 
... ...
@@ -685,13 +685,13 @@ av_cold void ff_h264_decode_init_vlc(void);
685 685
 
686 686
 /**
687 687
  * decodes a macroblock
688
- * @returns 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
688
+ * @return 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
689 689
  */
690 690
 int ff_h264_decode_mb_cavlc(H264Context *h);
691 691
 
692 692
 /**
693 693
  * decodes a CABAC coded macroblock
694
- * @returns 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
694
+ * @return 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
695 695
  */
696 696
 int ff_h264_decode_mb_cabac(H264Context *h);
697 697
 
... ...
@@ -1165,7 +1165,7 @@ static void fill_decode_caches(H264Context *h, int mb_type){
1165 1165
 
1166 1166
 /**
1167 1167
  *
1168
- * @returns non zero if the loop filter can be skiped
1168
+ * @return non zero if the loop filter can be skiped
1169 1169
  */
1170 1170
 static int fill_filter_caches(H264Context *h, int mb_type){
1171 1171
     MpegEncContext * const s = &h->s;
... ...
@@ -1181,7 +1181,7 @@ static void decode_cabac_residual_nondc( H264Context *h, DCTELEM *block, int cat
1181 1181
 
1182 1182
 /**
1183 1183
  * decodes a macroblock
1184
- * @returns 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
1184
+ * @return 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
1185 1185
  */
1186 1186
 int ff_h264_decode_mb_cabac(H264Context *h) {
1187 1187
     MpegEncContext * const s = &h->s;
... ...
@@ -31,7 +31,7 @@
31 31
  * @param dest the target buffer, dst+1 == src is allowed as a special case
32 32
  * @param destsize the length of the dst array
33 33
  * @param b2 the data which should be escaped
34
- * @returns pointer to current position in the output buffer or NULL if an error occurred
34
+ * @return pointer to current position in the output buffer or NULL if an error occurred
35 35
  */
36 36
 static uint8_t *h264_write_nal_unit(int nal_ref_idc, int nal_unit_type, uint8_t *dest, int *destsize,
37 37
                           PutBitContext *b2)
... ...
@@ -435,7 +435,7 @@ int mpeg4_decode_video_packet_header(MpegEncContext *s)
435 435
 /**
436 436
  * gets the average motion vector for a GMC MB.
437 437
  * @param n either 0 for the x component or 1 for y
438
- * @returns the average MV for a GMC MB
438
+ * @return the average MV for a GMC MB
439 439
  */
440 440
 static inline int get_amv(MpegEncContext *s, int n){
441 441
     int x, y, mb_v, sum, dx, dy, shift;
... ...
@@ -244,7 +244,7 @@ void av_parser_close(AVCodecParserContext *s)
244 244
 
245 245
 /**
246 246
  * combines the (truncated) bitstream to a complete frame
247
- * @returns -1 if no complete frame could be created, AVERROR(ENOMEM) if there was a memory allocation error
247
+ * @return -1 if no complete frame could be created, AVERROR(ENOMEM) if there was a memory allocation error
248 248
  */
249 249
 int ff_combine_frame(ParseContext *pc, int next, const uint8_t **buf, int *buf_size)
250 250
 {
... ...
@@ -754,7 +754,7 @@ static void aw_pulse_set1(WMAVoiceContext *s, GetBitContext *gb,
754 754
  * @param block_num current block index
755 755
  * @param block_size amount of entries we want to read from a table
756 756
  *                   that has 1000 entries
757
- * @returns a (non-)random number in the [0, 1000 - block_size] range.
757
+ * @return a (non-)random number in the [0, 1000 - block_size] range.
758 758
  */
759 759
 static int pRNG(int frame_cntr, int block_num, int block_size)
760 760
 {
... ...
@@ -1187,7 +1187,7 @@ static void stabilize_lsps(double *lsps, int num)
1187 1187
  *                does not modify the state of the bitreader; it
1188 1188
  *                only uses it to copy the current stream position
1189 1189
  * @param s WMA Voice decoding context private data
1190
- * @returns -1 if unsupported, 1 on not enough bits or 0 if OK.
1190
+ * @return -1 if unsupported, 1 on not enough bits or 0 if OK.
1191 1191
  */
1192 1192
 static int check_bits_for_superframe(GetBitContext *orig_gb,
1193 1193
                                      WMAVoiceContext *s)
... ...
@@ -1391,7 +1391,7 @@ static int synth_superframe(AVCodecContext *ctx,
1391 1391
  * decoder).
1392 1392
  *
1393 1393
  * @param s WMA Voice decoding context private data
1394
- * @returns 1 if not enough bits were available, or 0 on success.
1394
+ * @return 1 if not enough bits were available, or 0 on success.
1395 1395
  */
1396 1396
 static int parse_packet_header(WMAVoiceContext *s)
1397 1397
 {
... ...
@@ -638,7 +638,7 @@ static int asf_read_header(AVFormatContext *s, AVFormatParameters *ap)
638 638
  * Load a single ASF packet into the demuxer.
639 639
  * @param s demux context
640 640
  * @param pb context to read data from
641
- * @returns 0 on success, <0 on error
641
+ * @return 0 on success, <0 on error
642 642
  */
643 643
 static int ff_asf_get_packet(AVFormatContext *s, ByteIOContext *pb)
644 644
 {
... ...
@@ -801,7 +801,7 @@ static int asf_read_frame_header(AVFormatContext *s, ByteIOContext *pb){
801 801
  * @param s demux context
802 802
  * @param pb context to read data from
803 803
  * @param pkt pointer to store packet data into
804
- * @returns 0 if data was stored in pkt, <0 on error or 1 if more ASF
804
+ * @return 0 if data was stored in pkt, <0 on error or 1 if more ASF
805 805
  *          packets need to be loaded (through asf_get_packet())
806 806
  */
807 807
 static int ff_asf_parse_packet(AVFormatContext *s, ByteIOContext *pb, AVPacket *pkt)
... ...
@@ -1003,7 +1003,7 @@ int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1003 1003
  * @param ts target timestamp
1004 1004
  * @param max_ts largest acceptable timestamp
1005 1005
  * @param flags flags
1006
- * @returns >=0 on success, error code otherwise
1006
+ * @return >=0 on success, error code otherwise
1007 1007
  *
1008 1008
  * @NOTE This is part of the new seek API which is still under construction.
1009 1009
  *       Thus do not use this yet. It may change at any time, do not expect
... ...
@@ -376,7 +376,7 @@ void put_flush_packet(ByteIOContext *s);
376 376
 
377 377
 /**
378 378
  * Reads size bytes from ByteIOContext into buf.
379
- * @returns number of bytes read or AVERROR
379
+ * @return number of bytes read or AVERROR
380 380
  */
381 381
 int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
382 382
 
... ...
@@ -384,7 +384,7 @@ int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
384 384
  * Reads size bytes from ByteIOContext into buf.
385 385
  * This reads at most 1 packet. If that is not enough fewer bytes will be
386 386
  * returned.
387
- * @returns number of bytes read or AVERROR
387
+ * @return number of bytes read or AVERROR
388 388
  */
389 389
 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
390 390
 
... ...
@@ -136,7 +136,7 @@ static uint64_t find_any_startcode(ByteIOContext *bc, int64_t pos){
136 136
  * Find the given startcode.
137 137
  * @param code the startcode
138 138
  * @param pos the start position of the search, or -1 if the current position
139
- * @returns the position of the startcode or -1 if not found
139
+ * @return the position of the startcode or -1 if not found
140 140
  */
141 141
 static int64_t find_startcode(ByteIOContext *bc, uint64_t code, int64_t pos){
142 142
     for(;;){
... ...
@@ -85,7 +85,7 @@ int ff_rm_parse_packet (AVFormatContext *s, ByteIOContext *pb,
85 85
  * @param st stream that this packet belongs to
86 86
  * @param rst Real-specific stream information
87 87
  * @param pkt location to store the packet data
88
- * @returns the number of samples left for subsequent calls to this same
88
+ * @return the number of samples left for subsequent calls to this same
89 89
  *          function, or 0 if all samples have been retrieved.
90 90
  */
91 91
 int ff_rm_retrieve_cache (AVFormatContext *s, ByteIOContext *pb,
... ...
@@ -1080,7 +1080,7 @@ retry:
1080 1080
 }
1081 1081
 
1082 1082
 /**
1083
- * @returns 0 on success, <0 on error, 1 if protocol is unavailable.
1083
+ * @return 0 on success, <0 on error, 1 if protocol is unavailable.
1084 1084
  */
1085 1085
 static int make_setup_request(AVFormatContext *s, const char *host, int port,
1086 1086
                               int lower_transport, const char *real_challenge)
... ...
@@ -404,7 +404,7 @@ void ff_rtsp_send_cmd(AVFormatContext *s, const char *method,
404 404
  *                   has been fully parsed. If no more data is available
405 405
  *                   without parsing a reply, it will return an error.
406 406
  *
407
- * @returns 1 if a data packets is ready to be received, -1 on error,
407
+ * @return 1 if a data packets is ready to be received, -1 on error,
408 408
  *          and 0 on success.
409 409
  */
410 410
 int ff_rtsp_read_reply(AVFormatContext *s, RTSPMessageHeader *reply,
... ...
@@ -422,7 +422,7 @@ void ff_rtsp_skip_packet(AVFormatContext *s);
422 422
  *
423 423
  * @param s RTSP (de)muxer context
424 424
  *
425
- * @returns 0 on success, < 0 on error. Cleans up all allocations done
425
+ * @return 0 on success, < 0 on error. Cleans up all allocations done
426 426
  *          within the function on error.
427 427
  */
428 428
 int ff_rtsp_connect(AVFormatContext *s);
... ...
@@ -87,7 +87,7 @@ int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq) av_const;
87 87
  * Compares 2 timestamps each in its own timebases.
88 88
  * The result of the function is undefined if one of the timestamps
89 89
  * is outside the int64_t range when represented in the others timebase.
90
- * @returns -1 if ts_a is before ts_b, 1 if ts_a is after ts_b or 0 if they represent the same position
90
+ * @return -1 if ts_a is before ts_b, 1 if ts_a is after ts_b or 0 if they represent the same position
91 91
  */
92 92
 int av_compare_ts(int64_t ts_a, AVRational tb_a, int64_t ts_b, AVRational tb_b);
93 93