From 97dc8ace1d553b9fde50f0dab3ab44fb1053e92d Mon Sep 17 00:00:00 2001 From: Paul Walmsley Date: Mon, 4 Aug 2008 14:56:48 -0600 Subject: [PATCH] TWL4030: convert old-style function documentation to current kerneldoc Several functions use old-style function documentation; convert those to use the current kerneldoc style. Thanks to Felipe Balbi for catching an error. Signed-off-by: Paul Walmsley Signed-off-by: Tony Lindgren --- drivers/i2c/chips/twl4030-core.c | 54 +++++++++++++++----------------- 1 file changed, 26 insertions(+), 28 deletions(-) diff --git a/drivers/i2c/chips/twl4030-core.c b/drivers/i2c/chips/twl4030-core.c index 3fd2b241e5e..58ac7f5f72b 100644 --- a/drivers/i2c/chips/twl4030-core.c +++ b/drivers/i2c/chips/twl4030-core.c @@ -403,17 +403,18 @@ static struct irq_chip twl4030_irq_chip = { }; /* Global Functions */ -/* - * @brief twl4030_i2c_write - Writes a n bit register in TWL4030 + +/** + * twl4030_i2c_write - Writes a n bit register in TWL4030 + * @mod_no: module number + * @value: an array of num_bytes+1 containing data to write + * @reg: register address (just offset will do) + * @num_bytes: number of bytes to transfer * - * @param mod_no - module number - * @param *value - an array of num_bytes+1 containing data to write - * IMPORTANT - Allocate value num_bytes+1 and valid data starts at - * Offset 1. - * @param reg - register address (just offset will do) - * @param num_bytes - number of bytes to transfer + * IMPORTANT: for 'value' parameter: Allocate value num_bytes+1 and + * valid data starts at Offset 1. * - * @return result of operation - 0 is success + * Returns the result of operation - 0 is success */ int twl4030_i2c_write(u8 mod_no, u8 *value, u8 reg, u8 num_bytes) { @@ -457,14 +458,13 @@ int twl4030_i2c_write(u8 mod_no, u8 *value, u8 reg, u8 num_bytes) EXPORT_SYMBOL(twl4030_i2c_write); /** - * @brief twl4030_i2c_read - Reads a n bit register in TWL4030 + * twl4030_i2c_read - Reads a n bit register in TWL4030 + * @mod_no: module number + * @value: an array of num_bytes containing data to be read + * @reg: register address (just offset will do) + * @num_bytes: number of bytes to transfer * - * @param mod_no - module number - * @param *value - an array of num_bytes containing data to be read - * @param reg - register address (just offset will do) - * @param num_bytes - number of bytes to transfer - * - * @return result of operation - num_bytes is success else failure. + * Returns result of operation - num_bytes is success else failure. */ int twl4030_i2c_read(u8 mod_no, u8 *value, u8 reg, u8 num_bytes) { @@ -511,13 +511,12 @@ int twl4030_i2c_read(u8 mod_no, u8 *value, u8 reg, u8 num_bytes) EXPORT_SYMBOL(twl4030_i2c_read); /** - * @brief twl4030_i2c_write_u8 - Writes a 8 bit register in TWL4030 - * - * @param mod_no - module number - * @param value - the value to be written 8 bit - * @param reg - register address (just offset will do) + * twl4030_i2c_write_u8 - Writes a 8 bit register in TWL4030 + * @mod_no: module number + * @value: the value to be written 8 bit + * @reg: register address (just offset will do) * - * @return result of operation - 0 is success + * Returns result of operation - 0 is success */ int twl4030_i2c_write_u8(u8 mod_no, u8 value, u8 reg) { @@ -531,13 +530,12 @@ int twl4030_i2c_write_u8(u8 mod_no, u8 value, u8 reg) EXPORT_SYMBOL(twl4030_i2c_write_u8); /** - * @brief twl4030_i2c_read_u8 - Reads a 8 bit register from TWL4030 - * - * @param mod_no - module number - * @param *value - the value read 8 bit - * @param reg - register address (just offset will do) + * twl4030_i2c_read_u8 - Reads a 8 bit register from TWL4030 + * @mod_no: module number + * @value: the value read 8 bit + * @reg: register address (just offset will do) * - * @return result of operation - 0 is success + * Returns result of operation - 0 is success */ int twl4030_i2c_read_u8(u8 mod_no, u8 *value, u8 reg) { -- 2.41.1