diff options
author | Diego Biurrun <diego@biurrun.de> | 2011-06-24 00:41:54 +0400 |
---|---|---|
committer | Diego Biurrun <diego@biurrun.de> | 2011-06-24 02:37:49 +0400 |
commit | adbfc605f6bbe87b292c82cd1f5d4d974fa6b73c (patch) | |
tree | b31a5510ae7872008d723771fc2af2f098f3fc0c /libavutil | |
parent | 9abbe8cc136e7fbc69004df3f1de9d54c40d969d (diff) |
doxygen: Consistently use '@' instead of '\' for Doxygen markup.
Signed-off-by: Diego Biurrun <diego@biurrun.de>
Diffstat (limited to 'libavutil')
-rw-r--r-- | libavutil/common.h | 20 | ||||
-rw-r--r-- | libavutil/des.c | 2 | ||||
-rw-r--r-- | libavutil/des.h | 18 | ||||
-rw-r--r-- | libavutil/lzo.c | 22 | ||||
-rw-r--r-- | libavutil/lzo.h | 22 | ||||
-rw-r--r-- | libavutil/rc4.h | 18 |
6 files changed, 51 insertions, 51 deletions
diff --git a/libavutil/common.h b/libavutil/common.h index a985fa4804..9691f5bcf8 100644 --- a/libavutil/common.h +++ b/libavutil/common.h @@ -268,16 +268,16 @@ static av_always_inline av_const int av_popcount_c(uint32_t x) }\ }\ -/*! - * \def PUT_UTF8(val, tmp, PUT_BYTE) +/** + * @def PUT_UTF8(val, tmp, PUT_BYTE) * Convert a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long). - * \param val is an input-only argument and should be of type uint32_t. It holds + * @param val is an input-only argument and should be of type uint32_t. It holds * a UCS-4 encoded Unicode character that is to be converted to UTF-8. If * val is given as a function it is executed only once. - * \param tmp is a temporary variable and should be of type uint8_t. It + * @param tmp is a temporary variable and should be of type uint8_t. It * represents an intermediate value during conversion that is to be * output by PUT_BYTE. - * \param PUT_BYTE writes the converted UTF-8 bytes to any proper destination. + * @param PUT_BYTE writes the converted UTF-8 bytes to any proper destination. * It could be a function or a statement, and uses tmp as the input byte. * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be * executed up to 4 times for values in the valid UTF-8 range and up to @@ -304,16 +304,16 @@ static av_always_inline av_const int av_popcount_c(uint32_t x) }\ } -/*! - * \def PUT_UTF16(val, tmp, PUT_16BIT) +/** + * @def PUT_UTF16(val, tmp, PUT_16BIT) * Convert a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes). - * \param val is an input-only argument and should be of type uint32_t. It holds + * @param val is an input-only argument and should be of type uint32_t. It holds * a UCS-4 encoded Unicode character that is to be converted to UTF-16. If * val is given as a function it is executed only once. - * \param tmp is a temporary variable and should be of type uint16_t. It + * @param tmp is a temporary variable and should be of type uint16_t. It * represents an intermediate value during conversion that is to be * output by PUT_16BIT. - * \param PUT_16BIT writes the converted UTF-16 data to any proper destination + * @param PUT_16BIT writes the converted UTF-16 data to any proper destination * in desired endianness. It could be a function or a statement, and uses tmp * as the input byte. For example, PUT_BYTE could be "*output++ = tmp;" * PUT_BYTE will be executed 1 or 2 times depending on input character. diff --git a/libavutil/des.c b/libavutil/des.c index e8009a2ab9..a30ef3ba7c 100644 --- a/libavutil/des.c +++ b/libavutil/des.c @@ -240,7 +240,7 @@ static uint32_t f_func(uint32_t r, uint64_t k) { } /** - * \brief rotate the two halves of the expanded 56 bit key each 1 bit left + * @brief rotate the two halves of the expanded 56 bit key each 1 bit left * * Note: the specification calls this "shift", so I kept it although * it is confusing. diff --git a/libavutil/des.h b/libavutil/des.h index 5a6d4a12fb..935d7c5d71 100644 --- a/libavutil/des.h +++ b/libavutil/des.h @@ -30,22 +30,22 @@ struct AVDES { }; /** - * \brief Initializes an AVDES context. + * @brief Initializes an AVDES context. * - * \param key_bits must be 64 or 192 - * \param decrypt 0 for encryption, 1 for decryption + * @param key_bits must be 64 or 192 + * @param decrypt 0 for encryption, 1 for decryption */ int av_des_init(struct AVDES *d, const uint8_t *key, int key_bits, int decrypt); /** - * \brief Encrypts / decrypts using the DES algorithm. + * @brief Encrypts / decrypts using the DES algorithm. * - * \param count number of 8 byte blocks - * \param dst destination array, can be equal to src, must be 8-byte aligned - * \param src source array, can be equal to dst, must be 8-byte aligned, may be NULL - * \param iv initialization vector for CBC mode, if NULL then ECB will be used, + * @param count number of 8 byte blocks + * @param dst destination array, can be equal to src, must be 8-byte aligned + * @param src source array, can be equal to dst, must be 8-byte aligned, may be NULL + * @param iv initialization vector for CBC mode, if NULL then ECB will be used, * must be 8-byte aligned - * \param decrypt 0 for encryption, 1 for decryption + * @param decrypt 0 for encryption, 1 for decryption */ void av_des_crypt(struct AVDES *d, uint8_t *dst, const uint8_t *src, int count, uint8_t *iv, int decrypt); diff --git a/libavutil/lzo.c b/libavutil/lzo.c index ef01653aa8..743d596656 100644 --- a/libavutil/lzo.c +++ b/libavutil/lzo.c @@ -37,8 +37,8 @@ typedef struct LZOContext { } LZOContext; /** - * \brief Reads one byte from the input buffer, avoiding an overrun. - * \return byte read + * @brief Reads one byte from the input buffer, avoiding an overrun. + * @return byte read */ static inline int get_byte(LZOContext *c) { if (c->in < c->in_end) @@ -54,10 +54,10 @@ static inline int get_byte(LZOContext *c) { #endif /** - * \brief Decodes a length value in the coding used by lzo. - * \param x previous byte value - * \param mask bits used from x - * \return decoded length value + * @brief Decodes a length value in the coding used by lzo. + * @param x previous byte value + * @param mask bits used from x + * @return decoded length value */ static inline int get_len(LZOContext *c, int x, int mask) { int cnt = x & mask; @@ -82,8 +82,8 @@ static inline int get_len(LZOContext *c, int x, int mask) { #endif /** - * \brief Copies bytes from input to output buffer with checking. - * \param cnt number of bytes to copy, must be >= 0 + * @brief Copies bytes from input to output buffer with checking. + * @param cnt number of bytes to copy, must be >= 0 */ static inline void copy(LZOContext *c, int cnt) { register const uint8_t *src = c->in; @@ -111,9 +111,9 @@ static inline void copy(LZOContext *c, int cnt) { static inline void memcpy_backptr(uint8_t *dst, int back, int cnt); /** - * \brief Copies previously decoded bytes to current position. - * \param back how many bytes back we start - * \param cnt number of bytes to copy, must be >= 0 + * @brief Copies previously decoded bytes to current position. + * @param back how many bytes back we start + * @param cnt number of bytes to copy, must be >= 0 * * cnt > back is valid, this will copy the bytes we just copied, * thus creating a repeating pattern with a period length of back. diff --git a/libavutil/lzo.h b/libavutil/lzo.h index 01c9280a43..41ee6b1d67 100644 --- a/libavutil/lzo.h +++ b/libavutil/lzo.h @@ -24,7 +24,7 @@ #include <stdint.h> -/** \defgroup errflags Error flags returned by av_lzo1x_decode +/** @defgroup errflags Error flags returned by av_lzo1x_decode * \{ */ //! end of the input buffer reached before decoding finished #define AV_LZO_INPUT_DEPLETED 1 @@ -40,12 +40,12 @@ #define AV_LZO_OUTPUT_PADDING 12 /** - * \brief Decodes LZO 1x compressed data. - * \param out output buffer - * \param outlen size of output buffer, number of bytes left are returned here - * \param in input buffer - * \param inlen size of input buffer, number of bytes left are returned here - * \return 0 on success, otherwise a combination of the error flags above + * @brief Decodes LZO 1x compressed data. + * @param out output buffer + * @param outlen size of output buffer, number of bytes left are returned here + * @param in input buffer + * @param inlen size of input buffer, number of bytes left are returned here + * @return 0 on success, otherwise a combination of the error flags above * * Make sure all buffers are appropriately padded, in must provide * AV_LZO_INPUT_PADDING, out must provide AV_LZO_OUTPUT_PADDING additional bytes. @@ -53,10 +53,10 @@ int av_lzo1x_decode(void *out, int *outlen, const void *in, int *inlen); /** - * \brief deliberately overlapping memcpy implementation - * \param dst destination buffer; must be padded with 12 additional bytes - * \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 + * @brief deliberately overlapping memcpy implementation + * @param dst destination buffer; must be padded with 12 additional bytes + * @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 * * cnt > back is valid, this will copy the bytes we just copied, * thus creating a repeating pattern with a period length of back. diff --git a/libavutil/rc4.h b/libavutil/rc4.h index dc5066d3fc..ec3b47cc8a 100644 --- a/libavutil/rc4.h +++ b/libavutil/rc4.h @@ -29,21 +29,21 @@ struct AVRC4 { }; /** - * \brief Initializes an AVRC4 context. + * @brief Initializes an AVRC4 context. * - * \param key_bits must be a multiple of 8 - * \param decrypt 0 for encryption, 1 for decryption, currently has no effect + * @param key_bits must be a multiple of 8 + * @param decrypt 0 for encryption, 1 for decryption, currently has no effect */ int av_rc4_init(struct AVRC4 *d, const uint8_t *key, int key_bits, int decrypt); /** - * \brief Encrypts / decrypts using the RC4 algorithm. + * @brief Encrypts / decrypts using the RC4 algorithm. * - * \param count number of bytes - * \param dst destination array, can be equal to src - * \param src source array, can be equal to dst, may be NULL - * \param iv not (yet) used for RC4, should be NULL - * \param decrypt 0 for encryption, 1 for decryption, not (yet) used + * @param count number of bytes + * @param dst destination array, can be equal to src + * @param src source array, can be equal to dst, may be NULL + * @param iv not (yet) used for RC4, should be NULL + * @param decrypt 0 for encryption, 1 for decryption, not (yet) used */ void av_rc4_crypt(struct AVRC4 *d, uint8_t *dst, const uint8_t *src, int count, uint8_t *iv, int decrypt); |