Commit 9dc65576d67dc45e529062e41ca34066e02f03e5

Authored by Randy Dunlap
Committed by Linus Torvalds
1 parent c51d3dac32

[PATCH] reed-solomon: fix kernel-doc comments

Fix kernel-doc formatting in Reed-Solomon code.

Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>

Showing 1 changed file with 2 additions and 9 deletions Side-by-side Diff

lib/reed_solomon/reed_solomon.c
... ... @@ -54,7 +54,6 @@
54 54  
55 55 /**
56 56 * rs_init - Initialize a Reed-Solomon codec
57   - *
58 57 * @symsize: symbol size, bits (1-8)
59 58 * @gfpoly: Field generator polynomial coefficients
60 59 * @fcr: first root of RS code generator polynomial, index form
... ... @@ -62,7 +61,7 @@
62 61 * @nroots: RS code generator polynomial degree (number of roots)
63 62 *
64 63 * Allocate a control structure and the polynom arrays for faster
65   - * en/decoding. Fill the arrays according to the given parameters
  64 + * en/decoding. Fill the arrays according to the given parameters.
66 65 */
67 66 static struct rs_control *rs_init(int symsize, int gfpoly, int fcr,
68 67 int prim, int nroots)
... ... @@ -155,8 +154,7 @@
155 154  
156 155  
157 156 /**
158   - * free_rs - Free the rs control structure, if its not longer used
159   - *
  157 + * free_rs - Free the rs control structure, if it is no longer used
160 158 * @rs: the control structure which is not longer used by the
161 159 * caller
162 160 */
... ... @@ -176,7 +174,6 @@
176 174  
177 175 /**
178 176 * init_rs - Find a matching or allocate a new rs control structure
179   - *
180 177 * @symsize: the symbol size (number of bits)
181 178 * @gfpoly: the extended Galois field generator polynomial coefficients,
182 179 * with the 0th coefficient in the low order bit. The polynomial
... ... @@ -236,7 +233,6 @@
236 233 #ifdef CONFIG_REED_SOLOMON_ENC8
237 234 /**
238 235 * encode_rs8 - Calculate the parity for data values (8bit data width)
239   - *
240 236 * @rs: the rs control structure
241 237 * @data: data field of a given type
242 238 * @len: data length
... ... @@ -258,7 +254,6 @@
258 254 #ifdef CONFIG_REED_SOLOMON_DEC8
259 255 /**
260 256 * decode_rs8 - Decode codeword (8bit data width)
261   - *
262 257 * @rs: the rs control structure
263 258 * @data: data field of a given type
264 259 * @par: received parity data field
... ... @@ -285,7 +280,6 @@
285 280 #ifdef CONFIG_REED_SOLOMON_ENC16
286 281 /**
287 282 * encode_rs16 - Calculate the parity for data values (16bit data width)
288   - *
289 283 * @rs: the rs control structure
290 284 * @data: data field of a given type
291 285 * @len: data length
... ... @@ -305,7 +299,6 @@
305 299 #ifdef CONFIG_REED_SOLOMON_DEC16
306 300 /**
307 301 * decode_rs16 - Decode codeword (16bit data width)
308   - *
309 302 * @rs: the rs control structure
310 303 * @data: data field of a given type
311 304 * @par: received parity data field