Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

regulator: Fix some kerneldoc rendering issues

There are some minor textual changes in here as well, mostly to enable()
and disable() but the primary goal of these changes is to fix
misrenderings of the kerneldoc documentation for the regulator API.

Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: Liam Girdwood <lrg@slimlogic.co.uk>

authored by

Mark Brown and committed by
Liam Girdwood
cf7bbcdf c8e7e464

+11 -7
+11 -7
drivers/regulator/core.c
··· 1012 1012 * regulator_enable - enable regulator output 1013 1013 * @regulator: regulator source 1014 1014 * 1015 - * Enable the regulator output at the predefined voltage or current value. 1015 + * Request that the regulator be enabled with the regulator output at 1016 + * the predefined voltage or current value. Calls to regulator_enable() 1017 + * must be balanced with calls to regulator_disable(). 1018 + * 1016 1019 * NOTE: the output value can be set by other drivers, boot loader or may be 1017 - * hardwired in the regulator. Calls to regulator_enable() must be balanced 1018 - * with calls to regulator_disable(). 1020 + * hardwired in the regulator. 1019 1021 */ 1020 1022 int regulator_enable(struct regulator *regulator) 1021 1023 { ··· 1075 1073 * regulator_disable - disable regulator output 1076 1074 * @regulator: regulator source 1077 1075 * 1078 - * Disable the regulator output voltage or current. 1076 + * Disable the regulator output voltage or current. Calls to 1077 + * regulator_enable() must be balanced with calls to 1078 + * regulator_disable(). 1079 1079 * 1080 1080 * NOTE: this will only disable the regulator output if no other consumer 1081 - * devices have it enabled. Calls to regulator_enable() must be balanced with 1082 - * calls to regulator_disable(). 1081 + * devices have it enabled, the regulator device supports disabling and 1082 + * machine constraints permit this operation. 1083 1083 */ 1084 1084 int regulator_disable(struct regulator *regulator) 1085 1085 { ··· 1940 1936 EXPORT_SYMBOL_GPL(regulator_unregister); 1941 1937 1942 1938 /** 1943 - * regulator_suspend_prepare: prepare regulators for system wide suspend 1939 + * regulator_suspend_prepare - prepare regulators for system wide suspend 1944 1940 * @state: system suspend state 1945 1941 * 1946 1942 * Configure each regulator with it's suspend operating parameters for state.