changeset 5909:b8041f85c327 libavformat

Replace @returns by @return.
author benoit
date Tue, 30 Mar 2010 15:50:57 +0000
parents e0e34711fc2e
children 536e5527c1e0
files asfdec.c avformat.h avio.h nutdec.c rm.h rtsp.c rtsp.h
diffstat 7 files changed, 10 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/asfdec.c	Mon Mar 29 22:29:14 2010 +0000
+++ b/asfdec.c	Tue Mar 30 15:50:57 2010 +0000
@@ -638,7 +638,7 @@
  * 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 @@
  * @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)
--- a/avformat.h	Mon Mar 29 22:29:14 2010 +0000
+++ b/avformat.h	Tue Mar 30 15:50:57 2010 +0000
@@ -1003,7 +1003,7 @@
  * @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
--- a/avio.h	Mon Mar 29 22:29:14 2010 +0000
+++ b/avio.h	Tue Mar 30 15:50:57 2010 +0000
@@ -376,7 +376,7 @@
 
 /**
  * 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 @@
  * 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);
 
--- a/nutdec.c	Mon Mar 29 22:29:14 2010 +0000
+++ b/nutdec.c	Tue Mar 30 15:50:57 2010 +0000
@@ -136,7 +136,7 @@
  * 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(;;){
--- a/rm.h	Mon Mar 29 22:29:14 2010 +0000
+++ b/rm.h	Tue Mar 30 15:50:57 2010 +0000
@@ -85,7 +85,7 @@
  * @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,
--- a/rtsp.c	Mon Mar 29 22:29:14 2010 +0000
+++ b/rtsp.c	Tue Mar 30 15:50:57 2010 +0000
@@ -1080,7 +1080,7 @@
 }
 
 /**
- * @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)
--- a/rtsp.h	Mon Mar 29 22:29:14 2010 +0000
+++ b/rtsp.h	Tue Mar 30 15:50:57 2010 +0000
@@ -404,7 +404,7 @@
  *                   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 @@
  *
  * @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);