summaryrefslogtreecommitdiff
path: root/libavformat/avio.h
diff options
context:
space:
mode:
Diffstat (limited to 'libavformat/avio.h')
-rw-r--r--libavformat/avio.h34
1 files changed, 17 insertions, 17 deletions
diff --git a/libavformat/avio.h b/libavformat/avio.h
index f699a6eb98..dc8fdd6f7d 100644
--- a/libavformat/avio.h
+++ b/libavformat/avio.h
@@ -68,8 +68,8 @@ typedef struct URLPollEntry {
typedef int URLInterruptCB(void);
/**
- * Creates an URLContext for accessing to the resource indicated by
- * url, and opens it using the URLProtocol up.
+ * Create a URLContext for accessing to the resource indicated by
+ * url, and open it using the URLProtocol up.
*
* @param puc pointer to the location where, in case of success, the
* function puts the pointer to the created URLContext
@@ -82,8 +82,8 @@ int url_open_protocol (URLContext **puc, struct URLProtocol *up,
const char *url, int flags);
/**
- * Creates an URLContext for accessing to the resource indicated by
- * url, but doesn't initiate the connection yet.
+ * Create a URLContext for accessing to the resource indicated by
+ * url, but do not initiate the connection yet.
*
* @param puc pointer to the location where, in case of success, the
* function puts the pointer to the created URLContext
@@ -100,8 +100,8 @@ int url_alloc(URLContext **h, const char *url, int flags);
int url_connect(URLContext *h);
/**
- * Creates an URLContext for accessing to the resource indicated by
- * url, and opens it.
+ * Create an URLContext for accessing to the resource indicated by
+ * url, and open it.
*
* @param puc pointer to the location where, in case of success, the
* function puts the pointer to the created URLContext
@@ -113,7 +113,7 @@ int url_connect(URLContext *h);
int url_open(URLContext **h, const char *url, int flags);
/**
- * Reads up to size bytes from the resource accessed by h, and stores
+ * Read up to size bytes from the resource accessed by h, and store
* the read bytes in buf.
*
* @return The number of bytes actually read, or a negative value
@@ -135,7 +135,7 @@ int url_read_complete(URLContext *h, unsigned char *buf, int size);
int url_write(URLContext *h, const unsigned char *buf, int size);
/**
- * Changes the position that will be used by the next read/write
+ * Change the position that will be used by the next read/write
* operation on the resource accessed by h.
*
* @param pos specifies the new position to set
@@ -151,7 +151,7 @@ int url_write(URLContext *h, const unsigned char *buf, int size);
int64_t url_seek(URLContext *h, int64_t pos, int whence);
/**
- * Closes the resource accessed by the URLContext h, and frees the
+ * Close the resource accessed by the URLContext h, and free the
* memory used by it.
*
* @return a negative value if an error condition occurred, 0
@@ -160,7 +160,7 @@ int64_t url_seek(URLContext *h, int64_t pos, int whence);
int url_close(URLContext *h);
/**
- * Returns a non-zero value if the resource indicated by url
+ * Return a non-zero value if the resource indicated by url
* exists, 0 otherwise.
*/
int url_exist(const char *url);
@@ -282,7 +282,7 @@ attribute_deprecated int av_register_protocol(URLProtocol *protocol);
#endif
/**
- * Registers the URLProtocol protocol.
+ * Register the URLProtocol protocol.
*
* @param size the size of the URLProtocol struct referenced
*/
@@ -368,7 +368,7 @@ void url_fskip(ByteIOContext *s, int64_t offset);
int64_t url_ftell(ByteIOContext *s);
/**
- * Gets the filesize.
+ * Get the filesize.
* @return filesize or AVERROR
*/
int64_t url_fsize(ByteIOContext *s);
@@ -404,13 +404,13 @@ void put_flush_packet(ByteIOContext *s);
/**
- * Reads size bytes from ByteIOContext into buf.
+ * Read size bytes from ByteIOContext into buf.
* @return number of bytes read or AVERROR
*/
int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
/**
- * Reads size bytes from ByteIOContext into buf.
+ * Read size bytes from ByteIOContext into buf.
* This reads at most 1 packet. If that is not enough fewer bytes will be
* returned.
* @return number of bytes read or AVERROR
@@ -439,7 +439,7 @@ static inline int url_is_streamed(ByteIOContext *s)
}
/**
- * Creates and initializes a ByteIOContext for accessing the
+ * Create and initialize a ByteIOContext for accessing the
* resource referenced by the URLContext h.
* @note When the URLContext h has been opened in read+write mode, the
* ByteIOContext can be used only for writing.
@@ -462,7 +462,7 @@ int url_resetbuf(ByteIOContext *s, int flags);
#endif
/**
- * Rewinds the ByteIOContext using the specified buffer containing the first buf_size bytes of the file.
+ * Rewind the ByteIOContext using the specified buffer containing the first buf_size bytes of the file.
* Used after probing to avoid seeking.
* Joins buf and s->buffer, taking any overlap into consideration.
* @note s->buffer must overlap with buf or they can't be joined and the function fails
@@ -477,7 +477,7 @@ int url_resetbuf(ByteIOContext *s, int flags);
int ff_rewind_with_probe_data(ByteIOContext *s, unsigned char *buf, int buf_size);
/**
- * Creates and initializes a ByteIOContext for accessing the
+ * Create and initialize a ByteIOContext for accessing the
* resource indicated by url.
* @note When the resource indicated by url has been opened in
* read+write mode, the ByteIOContext can be used only for writing.