diff options
| author | Randy Dunlap <rdunlap@xenotime.net> | 2006-06-25 08:49:14 -0400 |
|---|---|---|
| committer | Linus Torvalds <torvalds@g5.osdl.org> | 2006-06-25 13:01:23 -0400 |
| commit | 9dc65576d67dc45e529062e41ca34066e02f03e5 (patch) | |
| tree | 37c75b56d792683703658bd7f87dac1b110aef59 | |
| parent | c51d3dac321df417d59a47574caa7ab61b30d447 (diff) | |
[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>
| -rw-r--r-- | lib/reed_solomon/reed_solomon.c | 11 |
1 files changed, 2 insertions, 9 deletions
diff --git a/lib/reed_solomon/reed_solomon.c b/lib/reed_solomon/reed_solomon.c index f8ac9fa95de1..2cc11faa4ff1 100644 --- a/lib/reed_solomon/reed_solomon.c +++ b/lib/reed_solomon/reed_solomon.c | |||
| @@ -54,7 +54,6 @@ static DEFINE_MUTEX(rslistlock); | |||
| 54 | 54 | ||
| 55 | /** | 55 | /** |
| 56 | * rs_init - Initialize a Reed-Solomon codec | 56 | * rs_init - Initialize a Reed-Solomon codec |
| 57 | * | ||
| 58 | * @symsize: symbol size, bits (1-8) | 57 | * @symsize: symbol size, bits (1-8) |
| 59 | * @gfpoly: Field generator polynomial coefficients | 58 | * @gfpoly: Field generator polynomial coefficients |
| 60 | * @fcr: first root of RS code generator polynomial, index form | 59 | * @fcr: first root of RS code generator polynomial, index form |
| @@ -62,7 +61,7 @@ static DEFINE_MUTEX(rslistlock); | |||
| 62 | * @nroots: RS code generator polynomial degree (number of roots) | 61 | * @nroots: RS code generator polynomial degree (number of roots) |
| 63 | * | 62 | * |
| 64 | * Allocate a control structure and the polynom arrays for faster | 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 | static struct rs_control *rs_init(int symsize, int gfpoly, int fcr, | 66 | static struct rs_control *rs_init(int symsize, int gfpoly, int fcr, |
| 68 | int prim, int nroots) | 67 | int prim, int nroots) |
| @@ -155,8 +154,7 @@ errrs: | |||
| 155 | 154 | ||
| 156 | 155 | ||
| 157 | /** | 156 | /** |
| 158 | * free_rs - Free the rs control structure, if its not longer used | 157 | * free_rs - Free the rs control structure, if it is no longer used |
| 159 | * | ||
| 160 | * @rs: the control structure which is not longer used by the | 158 | * @rs: the control structure which is not longer used by the |
| 161 | * caller | 159 | * caller |
| 162 | */ | 160 | */ |
| @@ -176,7 +174,6 @@ void free_rs(struct rs_control *rs) | |||
| 176 | 174 | ||
| 177 | /** | 175 | /** |
| 178 | * init_rs - Find a matching or allocate a new rs control structure | 176 | * init_rs - Find a matching or allocate a new rs control structure |
| 179 | * | ||
| 180 | * @symsize: the symbol size (number of bits) | 177 | * @symsize: the symbol size (number of bits) |
| 181 | * @gfpoly: the extended Galois field generator polynomial coefficients, | 178 | * @gfpoly: the extended Galois field generator polynomial coefficients, |
| 182 | * with the 0th coefficient in the low order bit. The polynomial | 179 | * with the 0th coefficient in the low order bit. The polynomial |
| @@ -236,7 +233,6 @@ out: | |||
| 236 | #ifdef CONFIG_REED_SOLOMON_ENC8 | 233 | #ifdef CONFIG_REED_SOLOMON_ENC8 |
| 237 | /** | 234 | /** |
| 238 | * encode_rs8 - Calculate the parity for data values (8bit data width) | 235 | * encode_rs8 - Calculate the parity for data values (8bit data width) |
| 239 | * | ||
| 240 | * @rs: the rs control structure | 236 | * @rs: the rs control structure |
| 241 | * @data: data field of a given type | 237 | * @data: data field of a given type |
| 242 | * @len: data length | 238 | * @len: data length |
| @@ -258,7 +254,6 @@ EXPORT_SYMBOL_GPL(encode_rs8); | |||
| 258 | #ifdef CONFIG_REED_SOLOMON_DEC8 | 254 | #ifdef CONFIG_REED_SOLOMON_DEC8 |
| 259 | /** | 255 | /** |
| 260 | * decode_rs8 - Decode codeword (8bit data width) | 256 | * decode_rs8 - Decode codeword (8bit data width) |
| 261 | * | ||
| 262 | * @rs: the rs control structure | 257 | * @rs: the rs control structure |
| 263 | * @data: data field of a given type | 258 | * @data: data field of a given type |
| 264 | * @par: received parity data field | 259 | * @par: received parity data field |
| @@ -285,7 +280,6 @@ EXPORT_SYMBOL_GPL(decode_rs8); | |||
| 285 | #ifdef CONFIG_REED_SOLOMON_ENC16 | 280 | #ifdef CONFIG_REED_SOLOMON_ENC16 |
| 286 | /** | 281 | /** |
| 287 | * encode_rs16 - Calculate the parity for data values (16bit data width) | 282 | * encode_rs16 - Calculate the parity for data values (16bit data width) |
| 288 | * | ||
| 289 | * @rs: the rs control structure | 283 | * @rs: the rs control structure |
| 290 | * @data: data field of a given type | 284 | * @data: data field of a given type |
| 291 | * @len: data length | 285 | * @len: data length |
| @@ -305,7 +299,6 @@ EXPORT_SYMBOL_GPL(encode_rs16); | |||
| 305 | #ifdef CONFIG_REED_SOLOMON_DEC16 | 299 | #ifdef CONFIG_REED_SOLOMON_DEC16 |
| 306 | /** | 300 | /** |
| 307 | * decode_rs16 - Decode codeword (16bit data width) | 301 | * decode_rs16 - Decode codeword (16bit data width) |
| 308 | * | ||
| 309 | * @rs: the rs control structure | 302 | * @rs: the rs control structure |
| 310 | * @data: data field of a given type | 303 | * @data: data field of a given type |
| 311 | * @par: received parity data field | 304 | * @par: received parity data field |
