Mercurial > libavutil.hg
changeset 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 | 03f6641ce9e5 |
| children | 4d40308d9343 |
| files | base64.h log.h mem.h rational.h |
| diffstat | 4 files changed, 19 insertions(+), 19 deletions(-) [+] |
line wrap: on
line diff
--- a/base64.h Thu May 28 23:19:35 2009 +0000 +++ b/base64.h Sat Jun 06 09:35:15 2009 +0000 @@ -24,23 +24,23 @@ #include <stdint.h> /** - * Decodes the base64-encoded string in \p in and puts the decoded - * data in \p out. + * Decodes the base64-encoded string in in and puts the decoded + * data in out. * - * @param out_size size in bytes of the \p out buffer, it should be at - * least 3/4 of the length of \p in + * @param out_size size in bytes of the out buffer, it should be at + * least 3/4 of the length of in * @return the number of bytes written, or a negative value in case of * error */ int av_base64_decode(uint8_t *out, const char *in, int out_size); /** - * Encodes in base64 the data in \p in and puts the resulting string - * in \p out. + * Encodes in base64 the data in in and puts the resulting string + * in out. * - * @param out_size size in bytes of the \p out string, it should be at - * least ((\p in_size + 2) / 3) * 4 + 1 - * @param in_size size in bytes of the \p in buffer + * @param out_size size in bytes of the out string, it should be at + * least ((in_size + 2) / 3) * 4 + 1 + * @param in_size size in bytes of the in buffer * @return the string containing the encoded data, or NULL in case of * error */
--- a/log.h Thu May 28 23:19:35 2009 +0000 +++ b/log.h Sat Jun 06 09:35:15 2009 +0000 @@ -39,7 +39,7 @@ /** * A pointer to a function which returns the name of a context - * instance \p ctx associated with the class. + * instance ctx associated with the class. */ const char* (*item_name)(void* ctx);
--- a/mem.h Thu May 28 23:19:35 2009 +0000 +++ b/mem.h Sat Jun 06 09:35:15 2009 +0000 @@ -41,7 +41,7 @@ #endif /** - * Allocates a block of \p size bytes with alignment suitable for all + * Allocates a block of size bytes with alignment suitable for all * memory accesses (including vectors if available on the CPU). * @param size Size in bytes for the memory block to be allocated. * @return Pointer to the allocated block, NULL if the block cannot @@ -52,8 +52,8 @@ /** * Allocates or reallocates a block of memory. - * If \p ptr is NULL and \p size > 0, allocates a new block. If \p - * size is zero, frees the memory block pointed to by \p ptr. + * If ptr is NULL and size > 0, allocates a new block. If \p + * size is zero, frees the memory block pointed to by ptr. * @param size Size in bytes for the memory block to be allocated or * reallocated. * @param ptr Pointer to a memory block already allocated with @@ -75,7 +75,7 @@ void av_free(void *ptr); /** - * Allocates a block of \p size bytes with alignment suitable for all + * Allocates a block of size bytes with alignment suitable for all * memory accesses (including vectors if available on the CPU) and * zeroes all the bytes of the block. * @param size Size in bytes for the memory block to be allocated. @@ -85,10 +85,10 @@ void *av_mallocz(unsigned int size) av_malloc_attrib av_alloc_size(1); /** - * Duplicates the string \p s. + * Duplicates the string s. * @param s string to be duplicated * @return Pointer to a newly allocated string containing a - * copy of \p s or NULL if the string cannot be allocated. + * copy of s or NULL if the string cannot be allocated. */ char *av_strdup(const char *s) av_malloc_attrib;
--- a/rational.h Thu May 28 23:19:35 2009 +0000 +++ b/rational.h Sat Jun 06 09:35:15 2009 +0000 @@ -114,13 +114,13 @@ AVRational av_d2q(double d, int max) av_const; /** - * @return 1 if \q1 is nearer to \p q than \p q2, -1 if \p q2 is nearer - * than \p q1, 0 if they have the same distance. + * @return 1 if q1 is nearer to q than q2, -1 if q2 is nearer + * than q1, 0 if they have the same distance. */ int av_nearer_q(AVRational q, AVRational q1, AVRational q2); /** - * Finds the nearest value in \p q_list to \p q. + * Finds the nearest value in q_list to q. * @param q_list an array of rationals terminated by {0, 0} * @return the index of the nearest value found in the array */