Skip to contentSkip to conversation

regulator: fix kernel-doc warnings

PATCH Applied Randy Dunlap 2 participants 2 messages Jan 8, 2009 Voltage and current regulator framework

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 regulator: fix kernel-doc warnings

From: Randy Dunlap <[email protected]>

Fix kernel-doc warnings in regulator/driver.h:

Warning(linux-next-20090108//include/linux/regulator/driver.h:95): Excess struct/union/enum/typedef member 'set_current' description in 'regulator_ops' Warning(linux-next-20090108//include/linux/regulator/driver.h:95): Excess struct/union/enum/typedef member 'get_current' description in 'regulator_ops' Warning(linux-next-20090108//include/linux/regulator/driver.h:124): No description found for parameter 'irq'

cc Liam Girdwood <[email protected]>
cc Mark Brown <[email protected]>
---
 include/linux/regulator/driver.h |    7 ++-----
 1 file changed, 2 insertions(+), 5 deletions(-)
include/linux/regulator/driver.h +2 -5
@@ -29,16 +29,12 @@ struct regulator_init_data;
  *
  * @enable: Enable the regulator.
  * @disable: Disable the regulator.
- * @is_enabled: Return 1 if the reguator is enabled, 0 otherwise.
+ * @is_enabled: Return 1 if the regulator is enabled, 0 otherwise.
  *
  * @set_voltage: Set the voltage for the regulator within the range specified.
  *               The driver should select the voltage closest to min_uV.
  * @get_voltage: Return the currently configured voltage for the regulator.
  *
- * @set_current: Set the current for the regulator within the range specified.
- *               The driver should select the current closest to min_uA.
- * @get_current: Return the currently configured current for the regulator.
- *
  * @set_current_limit: Configure a limit for a current-limited regulator.
  * @get_current_limit: Get the limit for a current-limited regulator.
  *
@@ -111,6 +107,7 @@ enum regulator_type {
  * @name: Identifying name for the regulator.
  * @id: Numerical identifier for the regulator.
  * @ops: Regulator operations table.
+ * @irq: Interrupt number for the regulator.
  * @type: Indicates if the regulator is a voltage or current regulator.
  * @owner: Module providing the regulator, used for refcounting.
  */
#1 lore raw
Quoted 4 lines · Randy Dunlap

From: Randy Dunlap <[email protected]>

Fix kernel-doc warnings in regulator/driver.h:

Quoted 8 lines

Warning(linux-next-20090108//include/linux/regulator/driver.h:95): Excess struct/union/enum/typedef member 'set_current' description in 'regulator_ops' Warning(linux-next-20090108//include/linux/regulator/driver.h:95): Excess struct/union/enum/typedef member 'get_current' description in 'regulator_ops' Warning(linux-next-20090108//include/linux/regulator/driver.h:124): No description found for parameter 'irq'

cc Liam Girdwood <[email protected]>
cc Mark Brown <[email protected]>

-

Applied.

Thanks

Liam