Skip to contentSkip to conversation

regulator: fix kernel-doc warnings in header files

PATCH Applied Randy Dunlap 2 participants 2 messages Aug 27, 2014 – Aug 28, 2014 Voltage and current regulator framework

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 regulator: fix kernel-doc warnings in header files

From: Randy Dunlap <[email protected]>

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'

---
 include/linux/regulator/driver.h  |    2 ++
 include/linux/regulator/machine.h |    1 +
 2 files changed, 3 insertions(+)

Please feel free to change these descriptions.

include/linux/regulator/machine.h +1 -0
Index: 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.
  *
include/linux/regulator/driver.h +2 -0
Index: 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_
maintainer Applied
#1 lore raw
Quoted 3 lines · Randy Dunlap

From: Randy Dunlap <[email protected]>

Fix kernel-doc warnings in regulator header files:

Applied, thanks.