Browse code

doxygen: drop pointless star from pointer variable names

Diego Biurrun authored on 2011/08/08 19:06:26
Showing 2 changed files
... ...
@@ -29,8 +29,8 @@
29 29
 
30 30
 /**
31 31
  * Decode DXT1 encoded data to RGB32
32
- * @param *src source buffer, has to be aligned on a 4-byte boundary
33
- * @param *dst destination buffer
32
+ * @param src source buffer, has to be aligned on a 4-byte boundary
33
+ * @param dst destination buffer
34 34
  * @param w width of output image
35 35
  * @param h height of output image
36 36
  * @param stride line size of output image
... ...
@@ -40,8 +40,8 @@ void ff_decode_dxt1(const uint8_t *src, uint8_t *dst,
40 40
                     const unsigned int stride);
41 41
 /**
42 42
  * Decode DXT3 encoded data to RGB32
43
- * @param *src source buffer, has to be aligned on a 4-byte boundary
44
- * @param *dst destination buffer
43
+ * @param src source buffer, has to be aligned on a 4-byte boundary
44
+ * @param dst destination buffer
45 45
  * @param w width of output image
46 46
  * @param h height of output image
47 47
  * @param stride line size of output image
... ...
@@ -41,20 +41,20 @@ AVFifoBuffer *av_fifo_alloc(unsigned int size);
41 41
 
42 42
 /**
43 43
  * Free an AVFifoBuffer.
44
- * @param *f AVFifoBuffer to free
44
+ * @param f AVFifoBuffer to free
45 45
  */
46 46
 void av_fifo_free(AVFifoBuffer *f);
47 47
 
48 48
 /**
49 49
  * Reset the AVFifoBuffer to the state right after av_fifo_alloc, in particular it is emptied.
50
- * @param *f AVFifoBuffer to reset
50
+ * @param f AVFifoBuffer to reset
51 51
  */
52 52
 void av_fifo_reset(AVFifoBuffer *f);
53 53
 
54 54
 /**
55 55
  * Return the amount of data in bytes in the AVFifoBuffer, that is the
56 56
  * amount of data you can read from it.
57
- * @param *f AVFifoBuffer to read from
57
+ * @param f AVFifoBuffer to read from
58 58
  * @return size
59 59
  */
60 60
 int av_fifo_size(AVFifoBuffer *f);
... ...
@@ -62,27 +62,27 @@ int av_fifo_size(AVFifoBuffer *f);
62 62
 /**
63 63
  * Return the amount of space in bytes in the AVFifoBuffer, that is the
64 64
  * amount of data you can write into it.
65
- * @param *f AVFifoBuffer to write into
65
+ * @param f AVFifoBuffer to write into
66 66
  * @return size
67 67
  */
68 68
 int av_fifo_space(AVFifoBuffer *f);
69 69
 
70 70
 /**
71 71
  * Feed data from an AVFifoBuffer to a user-supplied callback.
72
- * @param *f AVFifoBuffer to read from
72
+ * @param f AVFifoBuffer to read from
73 73
  * @param buf_size number of bytes to read
74
- * @param *func generic read function
75
- * @param *dest data destination
74
+ * @param func generic read function
75
+ * @param dest data destination
76 76
  */
77 77
 int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void (*func)(void*, void*, int));
78 78
 
79 79
 /**
80 80
  * Feed data from a user-supplied callback to an AVFifoBuffer.
81
- * @param *f AVFifoBuffer to write to
82
- * @param *src data source; non-const since it may be used as a
81
+ * @param f AVFifoBuffer to write to
82
+ * @param src data source; non-const since it may be used as a
83 83
  * modifiable context by the function defined in func
84 84
  * @param size number of bytes to write
85
- * @param *func generic write function; the first parameter is src,
85
+ * @param func generic write function; the first parameter is src,
86 86
  * the second is dest_buf, the third is dest_buf_size.
87 87
  * func must return the number of bytes written to dest_buf, or <= 0 to
88 88
  * indicate no more data available to write.
... ...
@@ -93,7 +93,7 @@ int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void
93 93
 
94 94
 /**
95 95
  * Resize an AVFifoBuffer.
96
- * @param *f AVFifoBuffer to resize
96
+ * @param f AVFifoBuffer to resize
97 97
  * @param size new AVFifoBuffer size in bytes
98 98
  * @return <0 for failure, >=0 otherwise
99 99
  */
... ...
@@ -101,7 +101,7 @@ int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size);
101 101
 
102 102
 /**
103 103
  * Read and discard the specified amount of data from an AVFifoBuffer.
104
- * @param *f AVFifoBuffer to read from
104
+ * @param f AVFifoBuffer to read from
105 105
  * @param size amount of data to read in bytes
106 106
  */
107 107
 void av_fifo_drain(AVFifoBuffer *f, int size);