lk/linux-kernel-test
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

Browse Source 
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>
This commit is contained in:
Randy Dunlap
2006-06-25 05:49:14 -07:00
committed by Linus Torvalds
parent c51d3dac32
commit 9dc65576d6
1 changed files with 2 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
lib/reed_solomon/reed_solomon.c
View File

@@ -54,7 +54,6 @@ static DEFINE_MUTEX(rslistlock);
/** /**
* rs_init - Initialize a Reed-Solomon codec * rs_init - Initialize a Reed-Solomon codec
*
* @symsize: symbol size, bits (1-8) * @symsize: symbol size, bits (1-8)
* @gfpoly: Field generator polynomial coefficients * @gfpoly: Field generator polynomial coefficients
* @fcr: first root of RS code generator polynomial, index form * @fcr: first root of RS code generator polynomial, index form
@@ -62,7 +61,7 @@ static DEFINE_MUTEX(rslistlock);
* @nroots: RS code generator polynomial degree (number of roots) * @nroots: RS code generator polynomial degree (number of roots)
* *
* Allocate a control structure and the polynom arrays for faster * Allocate a control structure and the polynom arrays for faster
* en/decoding. Fill the arrays according to the given parameters * en/decoding. Fill the arrays according to the given parameters.
*/ */
static struct rs_control *rs_init(int symsize, int gfpoly, int fcr, static struct rs_control *rs_init(int symsize, int gfpoly, int fcr,
int prim, int nroots) int prim, int nroots)
@@ -155,8 +154,7 @@ errrs:
/** /**
* free_rs - Free the rs control structure, if its not longer used * free_rs - Free the rs control structure, if it is no longer used
*
* @rs: the control structure which is not longer used by the * @rs: the control structure which is not longer used by the
* caller * caller
*/ */
@@ -176,7 +174,6 @@ void free_rs(struct rs_control *rs)
/** /**
* init_rs - Find a matching or allocate a new rs control structure * init_rs - Find a matching or allocate a new rs control structure
*
* @symsize: the symbol size (number of bits) * @symsize: the symbol size (number of bits)
* @gfpoly: the extended Galois field generator polynomial coefficients, * @gfpoly: the extended Galois field generator polynomial coefficients,
* with the 0th coefficient in the low order bit. The polynomial * with the 0th coefficient in the low order bit. The polynomial
@@ -236,7 +233,6 @@ out:
#ifdef CONFIG_REED_SOLOMON_ENC8 #ifdef CONFIG_REED_SOLOMON_ENC8
/** /**
* encode_rs8 - Calculate the parity for data values (8bit data width) * encode_rs8 - Calculate the parity for data values (8bit data width)
*
* @rs: the rs control structure * @rs: the rs control structure
* @data: data field of a given type * @data: data field of a given type
* @len: data length * @len: data length
@@ -258,7 +254,6 @@ EXPORT_SYMBOL_GPL(encode_rs8);
#ifdef CONFIG_REED_SOLOMON_DEC8 #ifdef CONFIG_REED_SOLOMON_DEC8
/** /**
* decode_rs8 - Decode codeword (8bit data width) * decode_rs8 - Decode codeword (8bit data width)
*
* @rs: the rs control structure * @rs: the rs control structure
* @data: data field of a given type * @data: data field of a given type
* @par: received parity data field * @par: received parity data field
@@ -285,7 +280,6 @@ EXPORT_SYMBOL_GPL(decode_rs8);
#ifdef CONFIG_REED_SOLOMON_ENC16 #ifdef CONFIG_REED_SOLOMON_ENC16
/** /**
* encode_rs16 - Calculate the parity for data values (16bit data width) * encode_rs16 - Calculate the parity for data values (16bit data width)
*
* @rs: the rs control structure * @rs: the rs control structure
* @data: data field of a given type * @data: data field of a given type
* @len: data length * @len: data length
@@ -305,7 +299,6 @@ EXPORT_SYMBOL_GPL(encode_rs16);
#ifdef CONFIG_REED_SOLOMON_DEC16 #ifdef CONFIG_REED_SOLOMON_DEC16
/** /**
* decode_rs16 - Decode codeword (16bit data width) * decode_rs16 - Decode codeword (16bit data width)
*
* @rs: the rs control structure * @rs: the rs control structure
* @data: data field of a given type * @data: data field of a given type
* @par: received parity data field * @par: received parity data field