comparison put_bits.h @ 9822:2887f410011f libavcodec

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 70afd9081b3f
children 2b8a327189cd
comparison
equal deleted inserted replaced
9821:0813b30e7db9 9822:2887f410011f
50 #endif 50 #endif
51 int size_in_bits; 51 int size_in_bits;
52 } PutBitContext; 52 } PutBitContext;
53 53
54 /** 54 /**
55 * Initializes the PutBitContext \p s. 55 * Initializes the PutBitContext s.
56 * 56 *
57 * @param buffer the buffer where to put bits 57 * @param buffer the buffer where to put bits
58 * @param buffer_size the size in bytes of \p buffer 58 * @param buffer_size the size in bytes of buffer
59 */ 59 */
60 static inline void init_put_bits(PutBitContext *s, uint8_t *buffer, int buffer_size) 60 static inline void init_put_bits(PutBitContext *s, uint8_t *buffer, int buffer_size)
61 { 61 {
62 if(buffer_size < 0) { 62 if(buffer_size < 0) {
63 buffer_size = 0; 63 buffer_size = 0;
121 * Pads the bitstream with zeros up to the next byte boundary. 121 * Pads the bitstream with zeros up to the next byte boundary.
122 */ 122 */
123 void align_put_bits(PutBitContext *s); 123 void align_put_bits(PutBitContext *s);
124 124
125 /** 125 /**
126 * Puts the string \p s in the bitstream. 126 * Puts the string s in the bitstream.
127 * 127 *
128 * @param terminate_string 0-terminates the written string if value is 1 128 * @param terminate_string 0-terminates the written string if value is 1
129 */ 129 */
130 void ff_put_string(PutBitContext * pbc, const char *s, int terminate_string); 130 void ff_put_string(PutBitContext * pbc, const char *s, int terminate_string);
131 131
132 /** 132 /**
133 * Copies the content of \p src to the bitstream. 133 * Copies the content of src to the bitstream.
134 * 134 *
135 * @param length the number of bits of \p src to copy 135 * @param length the number of bits of src to copy
136 */ 136 */
137 void ff_copy_bits(PutBitContext *pb, const uint8_t *src, int length); 137 void ff_copy_bits(PutBitContext *pb, const uint8_t *src, int length);
138 138
139 static inline void put_bits(PutBitContext *s, int n, unsigned int value) 139 static inline void put_bits(PutBitContext *s, int n, unsigned int value)
140 #ifndef ALT_BITSTREAM_WRITER 140 #ifndef ALT_BITSTREAM_WRITER
288 } 288 }
289 289
290 /** 290 /**
291 * Skips the given number of bits. 291 * Skips the given number of bits.
292 * Must only be used if the actual values in the bitstream do not matter. 292 * Must only be used if the actual values in the bitstream do not matter.
293 * If \p n is 0 the behavior is undefined. 293 * If n is 0 the behavior is undefined.
294 */ 294 */
295 static inline void skip_put_bits(PutBitContext *s, int n){ 295 static inline void skip_put_bits(PutBitContext *s, int n){
296 #ifdef ALT_BITSTREAM_WRITER 296 #ifdef ALT_BITSTREAM_WRITER
297 s->index += n; 297 s->index += n;
298 #else 298 #else