diff options
| author | Chen-Yu Tsai <wenst@chromium.org> | 2024-08-29 10:51:29 +0200 |
|---|---|---|
| committer | Mark Brown <broonie@kernel.org> | 2024-08-29 15:20:30 +0200 |
| commit | 6eace77a6048c9b0b50950e88ef987d4519a53c1 (patch) | |
| tree | 3fc060543f1b267719d4c29d77749a3c50edba9d /drivers/regulator | |
| parent | regulator: irq_helpers: Fix regulator_irq_map_event_simple() kerneldoc (diff) | |
| download | linux-6eace77a6048c9b0b50950e88ef987d4519a53c1.tar.xz linux-6eace77a6048c9b0b50950e88ef987d4519a53c1.zip | |
regulator: of: Fix kerneldoc format for of_regulator_bulk_get_all()
of_regulator_bulk_get_all() has a comment section that pretty much
resembles a kerneldoc block, except that the block begins with "/*"
instead of "/**".
Fix that and also rework the "Return" section and the error code
terminology so that it is the same as the other kerneldoc blocks
in the same file.
Fixes: 27b9ecc7a9ba ("regulator: Add of_regulator_bulk_get_all")
Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>
Reported-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Link: https://patch.msgid.link/20240829085131.1361701-10-wenst@chromium.org
Signed-off-by: Mark Brown <broonie@kernel.org>
Diffstat (limited to 'drivers/regulator')
| -rw-r--r-- | drivers/regulator/of_regulator.c | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/drivers/regulator/of_regulator.c b/drivers/regulator/of_regulator.c index dfa9f42d4629..cec8c3647a00 100644 --- a/drivers/regulator/of_regulator.c +++ b/drivers/regulator/of_regulator.c @@ -737,20 +737,21 @@ static int is_supply_name(const char *name) return 0; } -/* +/** * of_regulator_bulk_get_all - get multiple regulator consumers * * @dev: Device to supply * @np: device node to search for consumers * @consumers: Configuration of consumers; clients are stored here. * - * @return number of regulators on success, an errno on failure. - * * This helper function allows drivers to get several regulator * consumers in one operation. If any of the regulators cannot be * acquired then any regulators that were allocated will be freed * before returning to the caller, and @consumers will not be * changed. + * + * Return: Number of regulators on success, or a negative error number + * on failure. */ int of_regulator_bulk_get_all(struct device *dev, struct device_node *np, struct regulator_bulk_data **consumers) |