Mercurial > libavutil.hg
comparison mem.h @ 738:4f98a323598c libavutil
Remove '\p', '\c' and '\e' doxygen markup from doxy, as it should
improve plain text doxy readability.
See the thread: "[RFC] Should we use doxygen markup?".
author | stefano |
---|---|
date | Sat, 06 Jun 2009 09:35:15 +0000 |
parents | 70bdd5501662 |
children | 1091b120412e |
comparison
equal
deleted
inserted
replaced
737:03f6641ce9e5 | 738:4f98a323598c |
---|---|
39 #else | 39 #else |
40 #define av_alloc_size(n) | 40 #define av_alloc_size(n) |
41 #endif | 41 #endif |
42 | 42 |
43 /** | 43 /** |
44 * Allocates a block of \p size bytes with alignment suitable for all | 44 * Allocates a block of size bytes with alignment suitable for all |
45 * memory accesses (including vectors if available on the CPU). | 45 * memory accesses (including vectors if available on the CPU). |
46 * @param size Size in bytes for the memory block to be allocated. | 46 * @param size Size in bytes for the memory block to be allocated. |
47 * @return Pointer to the allocated block, NULL if the block cannot | 47 * @return Pointer to the allocated block, NULL if the block cannot |
48 * be allocated. | 48 * be allocated. |
49 * @see av_mallocz() | 49 * @see av_mallocz() |
50 */ | 50 */ |
51 void *av_malloc(unsigned int size) av_malloc_attrib av_alloc_size(1); | 51 void *av_malloc(unsigned int size) av_malloc_attrib av_alloc_size(1); |
52 | 52 |
53 /** | 53 /** |
54 * Allocates or reallocates a block of memory. | 54 * Allocates or reallocates a block of memory. |
55 * If \p ptr is NULL and \p size > 0, allocates a new block. If \p | 55 * If ptr is NULL and size > 0, allocates a new block. If \p |
56 * size is zero, frees the memory block pointed to by \p ptr. | 56 * size is zero, frees the memory block pointed to by ptr. |
57 * @param size Size in bytes for the memory block to be allocated or | 57 * @param size Size in bytes for the memory block to be allocated or |
58 * reallocated. | 58 * reallocated. |
59 * @param ptr Pointer to a memory block already allocated with | 59 * @param ptr Pointer to a memory block already allocated with |
60 * av_malloc(z)() or av_realloc() or NULL. | 60 * av_malloc(z)() or av_realloc() or NULL. |
61 * @return Pointer to a newly reallocated block or NULL if the block | 61 * @return Pointer to a newly reallocated block or NULL if the block |
73 * @see av_freep() | 73 * @see av_freep() |
74 */ | 74 */ |
75 void av_free(void *ptr); | 75 void av_free(void *ptr); |
76 | 76 |
77 /** | 77 /** |
78 * Allocates a block of \p size bytes with alignment suitable for all | 78 * Allocates a block of size bytes with alignment suitable for all |
79 * memory accesses (including vectors if available on the CPU) and | 79 * memory accesses (including vectors if available on the CPU) and |
80 * zeroes all the bytes of the block. | 80 * zeroes all the bytes of the block. |
81 * @param size Size in bytes for the memory block to be allocated. | 81 * @param size Size in bytes for the memory block to be allocated. |
82 * @return Pointer to the allocated block, NULL if it cannot be allocated. | 82 * @return Pointer to the allocated block, NULL if it cannot be allocated. |
83 * @see av_malloc() | 83 * @see av_malloc() |
84 */ | 84 */ |
85 void *av_mallocz(unsigned int size) av_malloc_attrib av_alloc_size(1); | 85 void *av_mallocz(unsigned int size) av_malloc_attrib av_alloc_size(1); |
86 | 86 |
87 /** | 87 /** |
88 * Duplicates the string \p s. | 88 * Duplicates the string s. |
89 * @param s string to be duplicated | 89 * @param s string to be duplicated |
90 * @return Pointer to a newly allocated string containing a | 90 * @return Pointer to a newly allocated string containing a |
91 * copy of \p s or NULL if the string cannot be allocated. | 91 * copy of s or NULL if the string cannot be allocated. |
92 */ | 92 */ |
93 char *av_strdup(const char *s) av_malloc_attrib; | 93 char *av_strdup(const char *s) av_malloc_attrib; |
94 | 94 |
95 /** | 95 /** |
96 * Frees a memory block which has been allocated with av_malloc(z)() or | 96 * Frees a memory block which has been allocated with av_malloc(z)() or |