Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 9dc65576 authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds
Browse files

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



Fix kernel-doc formatting in Reed-Solomon code.

Signed-off-by: default avatarRandy Dunlap <rdunlap@xenotime.net>
Signed-off-by: default avatarAndrew Morton <akpm@osdl.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@osdl.org>
parent c51d3dac

lib/reed_solomon/reed_solomon.c

+2 −9
Original line number Diff line number Diff line
@@ -54,7 +54,6 @@ static DEFINE_MUTEX(rslistlock); 


/**

 * rs_init - Initialize a Reed-Solomon codec

 *

 * @symsize:	symbol size, bits (1-8)

 * @gfpoly:	Field generator polynomial coefficients

 * @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)

 *

 * 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,

				   int prim, int nroots)
@@ -155,8 +154,7 @@ static struct rs_control *rs_init(int symsize, int gfpoly, int fcr, 




/**

 *  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

 *		caller

 */
@@ -176,7 +174,6 @@ void free_rs(struct rs_control *rs) 


/**

 * init_rs - Find a matching or allocate a new rs control structure

 *

 *  @symsize:	the symbol size (number of bits)

 *  @gfpoly:	the extended Galois field generator polynomial coefficients,

 *		with the 0th coefficient in the low order bit. The polynomial
@@ -236,7 +233,6 @@ struct rs_control *init_rs(int symsize, int gfpoly, int fcr, int prim, 
#ifdef CONFIG_REED_SOLOMON_ENC8

/**

 *  encode_rs8 - Calculate the parity for data values (8bit data width)

 *

 *  @rs:	the rs control structure

 *  @data:	data field of a given type

 *  @len:	data length
@@ -258,7 +254,6 @@ EXPORT_SYMBOL_GPL(encode_rs8); 
#ifdef CONFIG_REED_SOLOMON_DEC8

/**

 *  decode_rs8 - Decode codeword (8bit data width)

 *

 *  @rs:	the rs control structure

 *  @data:	data field of a given type

 *  @par:	received parity data field
@@ -285,7 +280,6 @@ EXPORT_SYMBOL_GPL(decode_rs8); 
#ifdef CONFIG_REED_SOLOMON_ENC16

/**

 *  encode_rs16 - Calculate the parity for data values (16bit data width)

 *

 *  @rs:	the rs control structure

 *  @data:	data field of a given type

 *  @len:	data length
@@ -305,7 +299,6 @@ EXPORT_SYMBOL_GPL(encode_rs16); 
#ifdef CONFIG_REED_SOLOMON_DEC16

/**

 *  decode_rs16 - Decode codeword (16bit data width)

 *

 *  @rs:	the rs control structure

 *  @data:	data field of a given type

 *  @par:	received parity data field