[PATCH] regulator: fix kernel-doc warnings in header files

From: Randy Dunlap
Date: Wed Aug 27 2014 - 17:31:30 EST


From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Fix kernel-doc warnings in regulator header files:

Warning(..//include/linux/regulator/machine.h:140): No description found for parameter 'ramp_disable'
Warning(..//include/linux/regulator/driver.h:279): No description found for parameter 'linear_ranges'
Warning(..//include/linux/regulator/driver.h:279): No description found for parameter 'n_linear_ranges'

Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
---
include/linux/regulator/driver.h | 2 ++
include/linux/regulator/machine.h | 1 +
2 files changed, 3 insertions(+)

Please feel free to change these descriptions.

Index: lnx-317-rc2/include/linux/regulator/machine.h
===================================================================
--- lnx-317-rc2.orig/include/linux/regulator/machine.h
+++ lnx-317-rc2/include/linux/regulator/machine.h
@@ -85,6 +85,7 @@ struct regulator_state {
* bootloader then it will be enabled when the constraints are
* applied.
* @apply_uV: Apply the voltage constraint when initialising.
+ * @ramp_disable: Disable ramp delay when initialising or when setting voltage.
*
* @input_uV: Input voltage for regulator when supplied by another regulator.
*
Index: lnx-317-rc2/include/linux/regulator/driver.h
===================================================================
--- lnx-317-rc2.orig/include/linux/regulator/driver.h
+++ lnx-317-rc2/include/linux/regulator/driver.h
@@ -218,6 +218,8 @@ enum regulator_type {
* @linear_min_sel: Minimal selector for starting linear mapping
* @fixed_uV: Fixed voltage of rails.
* @ramp_delay: Time to settle down after voltage change (unit: uV/us)
+ * @linear_ranges: A constant table of possible voltage ranges.
+ * @n_linear_ranges: Number of entries in the @linear_ranges table.
* @volt_table: Voltage mapping table (if table based mapping)
*
* @vsel_reg: Register for selector when using regulator_regmap_X_voltage_
--
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/