[PATCH] regulator: Fix documentation for of_node parameter of regulator_register()

[Mark Brown]

Commit 5bc75a (kernel-doc: fix new warning in regulator core) added
documentation for of_node to address a warning but the documentation
didn't explain what the parameter is for so would be likely to be
unhelpful for users.  Clarify that.

Signed-off-by: Mark Brown <broonie@xxxxxxxxxxxxxxxxxxxxxxxxxxx>
---
 drivers/regulator/core.c |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c
index dab8516..aa51866 100644
--- a/drivers/regulator/core.c
+++ b/drivers/regulator/core.c
@@ -2839,7 +2839,8 @@ static void rdev_init_debugfs(struct regulator_dev *rdev)
  * @dev: struct device for the regulator
  * @init_data: platform provided init data, passed through by driver
  * @driver_data: private regulator data
- * @of_node: target open firmware device structure (may be NULL)
+ * @of_node: OpenFirmware node to parse for device tree bindings (may be
+ *           NULL).
  *
  * Called by regulator drivers to register a regulator.
  * Returns 0 on success.
-- 
1.7.7.3

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/