Unverified Commit a7c15187 authored by Lee Jones's avatar Lee Jones Committed by Mark Brown
Browse files

regulator: devres: Standardise on function documentation headers 



Line up descriptions, start description with a lower-case character and
omit old definitions such as quoting the old argument "consumer".

Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200708124832.3441649-4-lee.jones@linaro.org


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent 45e8446e

drivers/regulator/devres.c

+26 −26
Original line number Diff line number Diff line
@@ -41,8 +41,8 @@ static struct regulator *_devm_regulator_get(struct device *dev, const char *id, 


/**

 * devm_regulator_get - Resource managed regulator_get()

 * @dev: device for regulator "consumer"

 * @id: Supply name or regulator ID.

 * @dev: device to supply

 * @id:  supply name or regulator ID.

 *

 * Managed regulator_get(). Regulators returned from this function are

 * automatically regulator_put() on driver detach. See regulator_get() for more
@@ -56,8 +56,8 @@ EXPORT_SYMBOL_GPL(devm_regulator_get); 


/**

 * devm_regulator_get_exclusive - Resource managed regulator_get_exclusive()

 * @dev: device for regulator "consumer"

 * @id: Supply name or regulator ID.

 * @dev: device to supply

 * @id:  supply name or regulator ID.

 *

 * Managed regulator_get_exclusive(). Regulators returned from this function

 * are automatically regulator_put() on driver detach. See regulator_get() for
@@ -72,8 +72,8 @@ EXPORT_SYMBOL_GPL(devm_regulator_get_exclusive); 


/**

 * devm_regulator_get_optional - Resource managed regulator_get_optional()

 * @dev: device for regulator "consumer"

 * @id: Supply name or regulator ID.

 * @dev: device to supply

 * @id:  supply name or regulator ID.

 *

 * Managed regulator_get_optional(). Regulators returned from this

 * function are automatically regulator_put() on driver detach. See
@@ -130,9 +130,9 @@ static void devm_regulator_bulk_release(struct device *dev, void *res) 
/**

 * devm_regulator_bulk_get - managed get multiple regulator consumers

 *

 * @dev:           Device to supply

 * @num_consumers: Number of consumers to register

 * @consumers:     Configuration of consumers; clients are stored here.

 * @dev:           device to supply

 * @num_consumers: number of consumers to register

 * @consumers:     configuration of consumers; clients are stored here.

 *

 * @return 0 on success, an errno on failure.

 *
@@ -259,10 +259,10 @@ static void devm_regulator_destroy_supply_alias(struct device *dev, void *res) 
 * devm_regulator_register_supply_alias - Resource managed

 * regulator_register_supply_alias()

 *

 * @dev: device that will be given as the regulator "consumer"

 * @id: Supply name or regulator ID

 * @dev:       device to supply

 * @id:        supply name or regulator ID

 * @alias_dev: device that should be used to lookup the supply

 * @alias_id: Supply name or regulator ID that should be used to lookup the

 * @alias_id:  supply name or regulator ID that should be used to lookup the

 * supply

 *

 * The supply alias will automatically be unregistered when the source
@@ -300,8 +300,8 @@ EXPORT_SYMBOL_GPL(devm_regulator_register_supply_alias); 
 * devm_regulator_unregister_supply_alias - Resource managed

 * regulator_unregister_supply_alias()

 *

 * @dev: device that will be given as the regulator "consumer"

 * @id: Supply name or regulator ID

 * @dev: device to supply

 * @id:  supply name or regulator ID

 *

 * Unregister an alias registered with

 * devm_regulator_register_supply_alias(). Normally this function
@@ -327,12 +327,12 @@ EXPORT_SYMBOL_GPL(devm_regulator_unregister_supply_alias); 
 * devm_regulator_bulk_register_supply_alias - Managed register

 * multiple aliases

 *

 * @dev: device that will be given as the regulator "consumer"

 * @id: List of supply names or regulator IDs

 * @dev:       device to supply

 * @id:        list of supply names or regulator IDs

 * @alias_dev: device that should be used to lookup the supply

 * @alias_id: List of supply names or regulator IDs that should be used to

 * @alias_id:  list of supply names or regulator IDs that should be used to

 *             lookup the supply

 * @num_id: Number of aliases to register

 * @num_id:    number of aliases to register

 *

 * @return 0 on success, an errno on failure.

 *
@@ -377,9 +377,9 @@ EXPORT_SYMBOL_GPL(devm_regulator_bulk_register_supply_alias); 
 * devm_regulator_bulk_unregister_supply_alias - Managed unregister

 * multiple aliases

 *

 * @dev: device that will be given as the regulator "consumer"

 * @id: List of supply names or regulator IDs

 * @num_id: Number of aliases to unregister

 * @dev:    device to supply

 * @id:     list of supply names or regulator IDs

 * @num_id: number of aliases to unregister

 *

 * Unregister aliases registered with

 * devm_regulator_bulk_register_supply_alias(). Normally this function

CRA Git | Maintained and supported by SUSTech CRA and CCSE