diff options
author | Stefano Sabatini <stefano.sabatini-lala@poste.it> | 2009-06-06 09:35:15 +0000 |
---|---|---|
committer | Stefano Sabatini <stefano.sabatini-lala@poste.it> | 2009-06-06 09:35:15 +0000 |
commit | bf7e799c9e83f6f6718866841d3169a91ef6b07e (patch) | |
tree | 3146c3bbf94bc66b4215526ef158f23d0592dd11 /libavcodec/put_bits.h | |
parent | 10ae4bb477426f6a360bed684c6676e20f2de299 (diff) | |
download | ffmpeg-bf7e799c9e83f6f6718866841d3169a91ef6b07e.tar.gz |
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?".
Originally committed as revision 19122 to svn://svn.ffmpeg.org/ffmpeg/trunk
Diffstat (limited to 'libavcodec/put_bits.h')
-rw-r--r-- | libavcodec/put_bits.h | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/libavcodec/put_bits.h b/libavcodec/put_bits.h index 61c6c9b31f..4b4b3a873a 100644 --- a/libavcodec/put_bits.h +++ b/libavcodec/put_bits.h @@ -52,10 +52,10 @@ typedef struct PutBitContext { } PutBitContext; /** - * Initializes the PutBitContext \p s. + * Initializes the PutBitContext s. * * @param buffer the buffer where to put bits - * @param buffer_size the size in bytes of \p buffer + * @param buffer_size the size in bytes of buffer */ static inline void init_put_bits(PutBitContext *s, uint8_t *buffer, int buffer_size) { @@ -123,16 +123,16 @@ static inline void flush_put_bits(PutBitContext *s) void align_put_bits(PutBitContext *s); /** - * Puts the string \p s in the bitstream. + * Puts the string s in the bitstream. * * @param terminate_string 0-terminates the written string if value is 1 */ void ff_put_string(PutBitContext * pbc, const char *s, int terminate_string); /** - * Copies the content of \p src to the bitstream. + * Copies the content of src to the bitstream. * - * @param length the number of bits of \p src to copy + * @param length the number of bits of src to copy */ void ff_copy_bits(PutBitContext *pb, const uint8_t *src, int length); @@ -290,7 +290,7 @@ static inline void skip_put_bytes(PutBitContext *s, int n){ /** * Skips the given number of bits. * Must only be used if the actual values in the bitstream do not matter. - * If \p n is 0 the behavior is undefined. + * If n is 0 the behavior is undefined. */ static inline void skip_put_bits(PutBitContext *s, int n){ #ifdef ALT_BITSTREAM_WRITER |