]> Pileus Git - ~andy/linux/commit
regulator: core: fix documentation error in regulator_allow_bypass
authorNishanth Menon <nm@ti.com>
Fri, 1 Mar 2013 00:44:54 +0000 (18:44 -0600)
committerMark Brown <broonie@opensource.wolfsonmicro.com>
Fri, 1 Mar 2013 06:07:23 +0000 (06:07 +0000)
commit9345dfb8495aa17ce7c575e1a96e5ad64def0b3d
tree61a260e1f23fbddbfe9851b659ed5f2036f2aa78
parent5838b032fd69ae47565ddc50062decf9055e1628
regulator: core: fix documentation error in regulator_allow_bypass

commit f59c8f9f (regulator: core: Support bypass mode)
has a short documentation error around the regulator_allow_bypass
parameter 'enable' which is documented as 'allow'.

This generates kernel-doc warning as follows:
./scripts/kernel-doc drivers/regulator/core.c >/dev/null
Warning(drivers/regulator/core.c:2841): No description found for parameter 'enable'
Warning(drivers/regulator/core.c:2841): Excess function parameter 'allow' description in 'regulator_allow_bypass'

Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@opensource.wolfsonmicro.com>
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Nishanth Menon <nm@ti.com>
Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
drivers/regulator/core.c