diff --git a/libavcodec/cavs.c b/libavcodec/cavs.c index 70677c9586018a7b3abec7506550e6e97ed74443..42335042abeaa7e6731fa9f13de06bcc08d50185 100644 --- a/libavcodec/cavs.c +++ b/libavcodec/cavs.c @@ -572,7 +572,7 @@ void ff_cavs_init_mb(AVSContext *h) { /** * 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; diff --git a/libavcodec/h264.h b/libavcodec/h264.h index 965e39d9bdb1e787427263c064a76e5022d65610..ba813b66ba5077bca7b5c73002330a4b2a71df2e 100644 --- a/libavcodec/h264.h +++ b/libavcodec/h264.h @@ -623,7 +623,7 @@ int ff_h264_decode_picture_parameter_set(H264Context *h, int bit_length); * @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 @@ av_cold void ff_h264_decode_init_vlc(void); /** * 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 @@ static void fill_decode_caches(H264Context *h, int mb_type){ /** * - * @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; diff --git a/libavcodec/h264_cabac.c b/libavcodec/h264_cabac.c index 755fb48be89d9e69ee035a8962fed488b02760e7..c5e866179b98a980b96c9b7e38b30c37b1b775f9 100644 --- a/libavcodec/h264_cabac.c +++ b/libavcodec/h264_cabac.c @@ -1181,7 +1181,7 @@ static void decode_cabac_residual_nondc( H264Context *h, DCTELEM *block, int cat /** * 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; diff --git a/libavcodec/h264enc.c b/libavcodec/h264enc.c index 5693336b55921bfb7bdda277083c7c4b380dc50f..e90bfb154209c694ac4a3635fc62923c0c4bd117 100644 --- a/libavcodec/h264enc.c +++ b/libavcodec/h264enc.c @@ -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) diff --git a/libavcodec/mpeg4videodec.c b/libavcodec/mpeg4videodec.c index 7dadf7e99ada7300ab778584a4d186afe3b98f25..baf7809d008354bd778ec999521caac9aa4a1c30 100644 --- a/libavcodec/mpeg4videodec.c +++ b/libavcodec/mpeg4videodec.c @@ -435,7 +435,7 @@ int mpeg4_decode_video_packet_header(MpegEncContext *s) /** * 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; diff --git a/libavcodec/parser.c b/libavcodec/parser.c index 0b007e9ee4bce8fa63f4092328fd443c2220d0e2..8f5c77afa7b25f1671f9c43bf2f685ceb4955043 100644 --- a/libavcodec/parser.c +++ b/libavcodec/parser.c @@ -244,7 +244,7 @@ void av_parser_close(AVCodecParserContext *s) /** * 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) { diff --git a/libavcodec/wmavoice.c b/libavcodec/wmavoice.c index bdd05ac83efa8d5a6c9ed06137a57a0b17b2c410..9b9609f1a2b628102c7cb7077020ff779d2379ac 100644 --- a/libavcodec/wmavoice.c +++ b/libavcodec/wmavoice.c @@ -754,7 +754,7 @@ static void aw_pulse_set1(WMAVoiceContext *s, GetBitContext *gb, * @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 @@ static void stabilize_lsps(double *lsps, int num) * 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 @@ static int synth_superframe(AVCodecContext *ctx, * 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) { diff --git a/libavformat/asfdec.c b/libavformat/asfdec.c index 80ac0c29a59af1e16f09390c3dce7f2b1f120494..882614be3df85c1e9b39c404ebcc25c92b09803d 100644 --- a/libavformat/asfdec.c +++ b/libavformat/asfdec.c @@ -638,7 +638,7 @@ static int asf_read_header(AVFormatContext *s, AVFormatParameters *ap) * Load a single ASF packet into the demuxer. * @param s demux context * @param pb context to read data from - * @returns 0 on success, <0 on error + * @return 0 on success, <0 on error */ static int ff_asf_get_packet(AVFormatContext *s, ByteIOContext *pb) { @@ -801,7 +801,7 @@ static int asf_read_frame_header(AVFormatContext *s, ByteIOContext *pb){ * @param s demux context * @param pb context to read data from * @param pkt pointer to store packet data into - * @returns 0 if data was stored in pkt, <0 on error or 1 if more ASF + * @return 0 if data was stored in pkt, <0 on error or 1 if more ASF * packets need to be loaded (through asf_get_packet()) */ static int ff_asf_parse_packet(AVFormatContext *s, ByteIOContext *pb, AVPacket *pkt) diff --git a/libavformat/avformat.h b/libavformat/avformat.h index 59456c627bb21492d5f9645473051d45d7f24bdd..92fd85c703534ea20cbd776c0aacd1d43dc68ff9 100644 --- a/libavformat/avformat.h +++ b/libavformat/avformat.h @@ -1003,7 +1003,7 @@ int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, * @param ts target timestamp * @param max_ts largest acceptable timestamp * @param flags flags - * @returns >=0 on success, error code otherwise + * @return >=0 on success, error code otherwise * * @NOTE This is part of the new seek API which is still under construction. * Thus do not use this yet. It may change at any time, do not expect diff --git a/libavformat/avio.h b/libavformat/avio.h index 58e6eab45cc7065dc6859e9ccebc3362b745f460..649de15ea92953ae5a65c08a857e0c179ac3cf10 100644 --- a/libavformat/avio.h +++ b/libavformat/avio.h @@ -376,7 +376,7 @@ void put_flush_packet(ByteIOContext *s); /** * Reads size bytes from ByteIOContext into buf. - * @returns number of bytes read or AVERROR + * @return number of bytes read or AVERROR */ int get_buffer(ByteIOContext *s, unsigned char *buf, int size); @@ -384,7 +384,7 @@ int get_buffer(ByteIOContext *s, unsigned char *buf, int size); * Reads size bytes from ByteIOContext into buf. * This reads at most 1 packet. If that is not enough fewer bytes will be * returned. - * @returns number of bytes read or AVERROR + * @return number of bytes read or AVERROR */ int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size); diff --git a/libavformat/nutdec.c b/libavformat/nutdec.c index d08683f54ab3466856f0ef088f1f5d62e4042087..3dbca9eeb37dc98451c67dc06c9166f624ed351c 100644 --- a/libavformat/nutdec.c +++ b/libavformat/nutdec.c @@ -136,7 +136,7 @@ static uint64_t find_any_startcode(ByteIOContext *bc, int64_t pos){ * Find the given startcode. * @param code the startcode * @param pos the start position of the search, or -1 if the current position - * @returns the position of the startcode or -1 if not found + * @return the position of the startcode or -1 if not found */ static int64_t find_startcode(ByteIOContext *bc, uint64_t code, int64_t pos){ for(;;){ diff --git a/libavformat/rm.h b/libavformat/rm.h index f5110b93e121356604875c94216c6931b8a60a1d..4e63114a111e5696f0094057601e300af1797617 100644 --- a/libavformat/rm.h +++ b/libavformat/rm.h @@ -85,7 +85,7 @@ int ff_rm_parse_packet (AVFormatContext *s, ByteIOContext *pb, * @param st stream that this packet belongs to * @param rst Real-specific stream information * @param pkt location to store the packet data - * @returns the number of samples left for subsequent calls to this same + * @return the number of samples left for subsequent calls to this same * function, or 0 if all samples have been retrieved. */ int ff_rm_retrieve_cache (AVFormatContext *s, ByteIOContext *pb, diff --git a/libavformat/rtsp.c b/libavformat/rtsp.c index a1cb072fe6de6a8bc3ffa9bef7fc0b7e9eff5bd4..a675e9a333dcc5fbf3f68acb880c969181947871 100644 --- a/libavformat/rtsp.c +++ b/libavformat/rtsp.c @@ -1080,7 +1080,7 @@ retry: } /** - * @returns 0 on success, <0 on error, 1 if protocol is unavailable. + * @return 0 on success, <0 on error, 1 if protocol is unavailable. */ static int make_setup_request(AVFormatContext *s, const char *host, int port, int lower_transport, const char *real_challenge) diff --git a/libavformat/rtsp.h b/libavformat/rtsp.h index 2c0be087aa7acafabe31f0b9f746c2570f54c981..357d3bfc0c824104a887de20932c52337fda33ca 100644 --- a/libavformat/rtsp.h +++ b/libavformat/rtsp.h @@ -404,7 +404,7 @@ void ff_rtsp_send_cmd(AVFormatContext *s, const char *method, * has been fully parsed. If no more data is available * without parsing a reply, it will return an error. * - * @returns 1 if a data packets is ready to be received, -1 on error, + * @return 1 if a data packets is ready to be received, -1 on error, * and 0 on success. */ int ff_rtsp_read_reply(AVFormatContext *s, RTSPMessageHeader *reply, @@ -422,7 +422,7 @@ void ff_rtsp_skip_packet(AVFormatContext *s); * * @param s RTSP (de)muxer context * - * @returns 0 on success, < 0 on error. Cleans up all allocations done + * @return 0 on success, < 0 on error. Cleans up all allocations done * within the function on error. */ int ff_rtsp_connect(AVFormatContext *s); diff --git a/libavutil/mathematics.h b/libavutil/mathematics.h index ab0f3f731dbd92cd615e350d25da5618af6f2a3f..3b783db83284b95ea44d33e58552c9a0d65ec83f 100644 --- a/libavutil/mathematics.h +++ b/libavutil/mathematics.h @@ -87,7 +87,7 @@ int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq) av_const; * Compares 2 timestamps each in its own timebases. * The result of the function is undefined if one of the timestamps * is outside the int64_t range when represented in the others timebase. - * @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 + * @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 */ int av_compare_ts(int64_t ts_a, AVRational tb_a, int64_t ts_b, AVRational tb_b);