Skip to content

Commit

Permalink
regulator: Clean up kerneldoc warnings
Browse files Browse the repository at this point in the history
Remove kerneldoc warnings that don't relate to missing documentation,
mostly by renaming parameters in the documentation to match their
actual names.

Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: Liam Girdwood <lrg@slimlogic.co.uk>
  • Loading branch information
Mark Brown authored and Liam Girdwood committed Jan 8, 2009
1 parent 8dc5390 commit 69279fb
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 26 deletions.
44 changes: 22 additions & 22 deletions drivers/regulator/core.c
Original file line number Diff line number Diff line change
Expand Up @@ -655,7 +655,7 @@ static void print_constraints(struct regulator_dev *rdev)

/**
* set_machine_constraints - sets regulator constraints
* @regulator: regulator source
* @rdev: regulator source
*
* Allows platform initialisation code to define and constrain
* regulator circuits e.g. valid voltage/current ranges, etc. NOTE:
Expand Down Expand Up @@ -730,8 +730,8 @@ static int set_machine_constraints(struct regulator_dev *rdev,

/**
* set_supply - set regulator supply regulator
* @regulator: regulator name
* @supply: supply regulator name
* @rdev: regulator name
* @supply_rdev: supply regulator name
*
* Called by platform initialisation code to set the supply regulator for this
* regulator. This ensures that a regulators supply will also be enabled by the
Expand All @@ -758,9 +758,9 @@ static int set_supply(struct regulator_dev *rdev,

/**
* set_consumer_device_supply: Bind a regulator to a symbolic supply
* @regulator: regulator source
* @dev: device the supply applies to
* @supply: symbolic name for supply
* @rdev: regulator source
* @consumer_dev: device the supply applies to
* @supply: symbolic name for supply
*
* Allows platform initialisation code to map physical regulator
* sources to symbolic names for supplies for use by devices. Devices
Expand Down Expand Up @@ -1013,9 +1013,8 @@ static int _regulator_enable(struct regulator_dev *rdev)
*
* Enable the regulator output at the predefined voltage or current value.
* NOTE: the output value can be set by other drivers, boot loader or may be
* hardwired in the regulator.
* NOTE: calls to regulator_enable() must be balanced with calls to
* regulator_disable().
* hardwired in the regulator. Calls to regulator_enable() must be balanced
* with calls to regulator_disable().
*/
int regulator_enable(struct regulator *regulator)
{
Expand Down Expand Up @@ -1074,10 +1073,10 @@ static int _regulator_disable(struct regulator_dev *rdev)
* @regulator: regulator source
*
* Disable the regulator output voltage or current.
*
* NOTE: this will only disable the regulator output if no other consumer
* devices have it enabled.
* NOTE: calls to regulator_enable() must be balanced with calls to
* regulator_disable().
* devices have it enabled. Calls to regulator_enable() must be balanced with
* calls to regulator_disable().
*/
int regulator_disable(struct regulator *regulator)
{
Expand Down Expand Up @@ -1200,7 +1199,7 @@ EXPORT_SYMBOL_GPL(regulator_is_enabled);
*
* NOTE: If the regulator is shared between several devices then the lowest
* request voltage that meets the system constraints will be used.
* NOTE: Regulator system constraints must be set for this regulator before
* Regulator system constraints must be set for this regulator before
* calling this function otherwise this call will fail.
*/
int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV)
Expand Down Expand Up @@ -1498,7 +1497,7 @@ EXPORT_SYMBOL_GPL(regulator_set_optimum_mode);
/**
* regulator_register_notifier - register regulator event notifier
* @regulator: regulator source
* @notifier_block: notifier block
* @nb: notifier block
*
* Register notifier block to receive regulator events.
*/
Expand All @@ -1513,7 +1512,7 @@ EXPORT_SYMBOL_GPL(regulator_register_notifier);
/**
* regulator_unregister_notifier - unregister regulator event notifier
* @regulator: regulator source
* @notifier_block: notifier block
* @nb: notifier block
*
* Unregister regulator event notifier block.
*/
Expand Down Expand Up @@ -1679,9 +1678,9 @@ EXPORT_SYMBOL_GPL(regulator_bulk_free);

/**
* regulator_notifier_call_chain - call regulator event notifier
* @regulator: regulator source
* @rdev: regulator source
* @event: notifier block
* @data:
* @data: callback-specific data.
*
* Called by regulator drivers to notify clients a regulator event has
* occurred. We also notify regulator clients downstream.
Expand Down Expand Up @@ -1808,8 +1807,9 @@ static int add_regulator_attributes(struct regulator_dev *rdev)

/**
* regulator_register - register regulator
* @regulator: regulator source
* @reg_data: private regulator data
* @regulator_desc: regulator to register
* @dev: struct device for the regulator
* @driver_data: private regulator data
*
* Called by regulator drivers to register a regulator.
* Returns 0 on success.
Expand Down Expand Up @@ -1916,7 +1916,7 @@ EXPORT_SYMBOL_GPL(regulator_register);

/**
* regulator_unregister - unregister regulator
* @regulator: regulator source
* @rdev: regulator to unregister
*
* Called by regulator drivers to unregister a regulator.
*/
Expand Down Expand Up @@ -1971,7 +1971,7 @@ EXPORT_SYMBOL_GPL(regulator_suspend_prepare);

/**
* rdev_get_drvdata - get rdev regulator driver data
* @regulator: regulator
* @rdev: regulator
*
* Get rdev regulator driver private data. This call can be used in the
* regulator driver context.
Expand Down Expand Up @@ -2008,7 +2008,7 @@ EXPORT_SYMBOL_GPL(regulator_set_drvdata);

/**
* regulator_get_id - get regulator ID
* @regulator: regulator
* @rdev: regulator
*/
int rdev_get_id(struct regulator_dev *rdev)
{
Expand Down
8 changes: 4 additions & 4 deletions include/linux/regulator/consumer.h
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,10 @@ struct regulator;
/**
* struct regulator_bulk_data - Data used for bulk regulator operations.
*
* @supply The name of the supply. Initialised by the user before
* using the bulk regulator APIs.
* @consumer The regulator consumer for the supply. This will be managed
* by the bulk API.
* @supply: The name of the supply. Initialised by the user before
* using the bulk regulator APIs.
* @consumer: The regulator consumer for the supply. This will be managed
* by the bulk API.
*
* The regulator APIs provide a series of regulator_bulk_() API calls as
* a convenience to consumers which require multiple supplies. This
Expand Down

0 comments on commit 69279fb

Please sign in to comment.