Commit b634b36f authored by Diego Biurrun's avatar Diego Biurrun

mem: Improve documentation wording and spelling

parent 26b241c0
......@@ -65,7 +65,7 @@ void *av_malloc(size_t size)
long diff;
#endif
/* let's disallow possible ambiguous cases */
/* let's disallow possibly ambiguous cases */
if (size > (INT_MAX - 32) || !size)
return NULL;
......@@ -119,7 +119,7 @@ void *av_realloc(void *ptr, size_t size)
int diff;
#endif
/* let's disallow possible ambiguous cases */
/* let's disallow possibly ambiguous cases */
if (size > (INT_MAX - 16))
return NULL;
......
......@@ -82,8 +82,7 @@
void *av_malloc(size_t size) av_malloc_attrib av_alloc_size(1);
/**
* Helper function to allocate a block of size * nmemb bytes with
* using av_malloc()
* Allocate a block of size * nmemb bytes with av_malloc().
* @param nmemb Number of elements
* @param size Size of the single element
* @return Pointer to the allocated block, NULL if the block cannot
......@@ -101,14 +100,14 @@ av_alloc_size(1, 2) static inline void *av_malloc_array(size_t nmemb, size_t siz
* Allocate or reallocate a block of memory.
* If ptr is NULL and size > 0, allocate a new block. If
* size is zero, free the memory block pointed to by ptr.
* @note Pointers provided by av_malloc family of functions cannot be
* passed to av_realloc().
* @param ptr Pointer to a memory block already allocated with
* av_realloc() or NULL.
* @param size Size in bytes for the memory block to be allocated or
* @param size Size in bytes of the memory block to be allocated or
* reallocated.
* @return Pointer to a newly reallocated block or NULL if the block
* @return Pointer to a newly-reallocated block or NULL if the block
* cannot be reallocated or the function is used to free the memory block.
* @note av_realloc() is not guaranteed to maintain the alignment of
* pointers originating from the av_malloc() family of functions.
* @see av_fast_realloc()
*/
void *av_realloc(void *ptr, size_t size) av_alloc_size(2);
......@@ -117,29 +116,29 @@ void *av_realloc(void *ptr, size_t size) av_alloc_size(2);
* Allocate or reallocate an array.
* If ptr is NULL and nmemb > 0, allocate a new block. If
* nmemb is zero, free the memory block pointed to by ptr.
* @note Pointers provided by av_malloc family of functions cannot be
* passed to av_realloc_array().
* @param ptr Pointer to a memory block already allocated with
* av_realloc() or NULL.
* @param nmemb Number of elements
* @param size Size of the single element
* @return Pointer to a newly reallocated block or NULL if the block
* @return Pointer to a newly-reallocated block or NULL if the block
* cannot be reallocated or the function is used to free the memory block.
* @note av_realloc_array() is not guaranteed to maintain the alignment of
* pointers originating from the av_malloc() family of functions.
*/
av_alloc_size(2, 3) void *av_realloc_array(void *ptr, size_t nmemb, size_t size);
/**
* Allocate or reallocate an array.
* Allocate or reallocate an array through a pointer to a pointer.
* If *ptr is NULL and nmemb > 0, allocate a new block. If
* nmemb is zero, free the memory block pointed to by ptr.
* @note Pointers provided by av_malloc family of functions cannot be
* passed to av_reallocp_array().
* @param ptr Pointer to a pointer to a memory block already allocated
* with av_realloc(), or pointer to a pointer to NULL.
* The pointer is updated on success, or freed on failure.
* @param nmemb Number of elements
* @param size Size of the single element
* @return Zero on success, an AVERROR error code on failure.
* @note av_reallocp_array() is not guaranteed to maintain the alignment of
* pointers originating from the av_malloc() family of functions.
*/
av_alloc_size(2, 3) int av_reallocp_array(void *ptr, size_t nmemb, size_t size);
......@@ -164,8 +163,7 @@ void av_free(void *ptr);
void *av_mallocz(size_t size) av_malloc_attrib av_alloc_size(1);
/**
* Helper function to allocate a block of size * nmemb bytes with
* using av_mallocz()
* Allocate a block of size * nmemb bytes with av_mallocz().
* @param nmemb Number of elements
* @param size Size of the single element
* @return Pointer to the allocated block, NULL if the block cannot
......@@ -183,7 +181,7 @@ av_alloc_size(1, 2) static inline void *av_mallocz_array(size_t nmemb, size_t si
/**
* Duplicate the string s.
* @param s string to be duplicated
* @return Pointer to a newly allocated string containing a
* @return Pointer to a newly-allocated string containing a
* copy of s or NULL if the string cannot be allocated.
*/
char *av_strdup(const char *s) av_malloc_attrib;
......@@ -198,7 +196,7 @@ char *av_strdup(const char *s) av_malloc_attrib;
void av_freep(void *ptr);
/**
* @brief deliberately overlapping memcpy implementation
* deliberately overlapping memcpy implementation
* @param dst destination buffer
* @param back how many bytes back we start (the initial size of the overlapping window)
* @param cnt number of bytes to copy, must be >= 0
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment