Re: [PATCH 1/2] regulator: TI bq24022 Li-Ion Charger driver

From: Andrew Morton
Date: Fri Jul 11 2008 - 15:17:29 EST


On Thu, 10 Jul 2008 21:04:43 +0200 Philipp Zabel <philipp.zabel@xxxxxxxxx> wrote:

> +/**
> + *bq24022_mach_info - platform data for bq24022
> + *@gpio_nce: GPIO line connected to the nCE pin,
> + * used to enable / disable charging.
> + *@gpio_iset2: GPIO line connected to the ISET2 pin,
> + * used to limit charging current to 100 mA / 500 mA.
> + */

We normally have a space after the "*" in kerneldoc comments (some
weird people use a tab and waste space).

I don't know whether the kerneldoc processors will correctly handle
the above. I guess I'll fix it so we don't find out.

Also, I _think_ that kerneldoc will barf over the multi-line parameter
descriptions. I'll join those lines.

--- a/include/linux/regulator/bq24022.h~regulator-ti-bq24022-li-ion-charger-driver-fix
+++ a/include/linux/regulator/bq24022.h
@@ -11,11 +11,9 @@
*/

/**
- *bq24022_mach_info - platform data for bq24022
- *@gpio_nce: GPIO line connected to the nCE pin,
- * used to enable / disable charging.
- *@gpio_iset2: GPIO line connected to the ISET2 pin,
- * used to limit charging current to 100 mA / 500 mA.
+ * bq24022_mach_info - platform data for bq24022
+ * @gpio_nce: GPIO line connected to the nCE pin, used to enable / disable charging
+ * @gpio_iset2: GPIO line connected to the ISET2 pin, used to limit charging current to 100 mA / 500 mA
*/
struct bq24022_mach_info {
int gpio_nce;
_

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/