[PATCH 4/14] kernel-doc: fix new warning in regulator core

[PATCH 4/14] kernel-doc: fix new warning in regulator core

[Randy Dunlap]

From: Randy Dunlap <rdunlap@xenotime.net>

Fix new kernel-doc warning:

Warning(drivers/regulator/core.c:2741): No description found for parameter 'of_node'

Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
Cc:	Liam Girdwood <lrg@ti.com>
Cc:	Mark Brown <broonie@opensource.wolfsonmicro.com>
---
 drivers/regulator/core.c |    1 +
 1 file changed, 1 insertion(+)

--- lnx-33-rc1.orig/drivers/regulator/core.c
+++ lnx-33-rc1/drivers/regulator/core.c
@@ -2731,6 +2731,7 @@ static void rdev_init_debugfs(struct reg
  * @dev: struct device for the regulator
  * @init_data: platform provided init data, passed through by driver
  * @driver_data: private regulator data
+ * @of_node: target of device structure (may be NULL)
  *
  * Called by regulator drivers to register a regulator.
  * Returns 0 on success.

Re: [PATCH 4/14] kernel-doc: fix new warning in regulator core

[Mark Brown]

On Sat, Jan 21, 2012 at 11:02:38AM -0800, Randy Dunlap wrote:

> @@ -2731,6 +2731,7 @@ static void rdev_init_debugfs(struct reg
>   * @dev: struct device for the regulator
>   * @init_data: platform provided init data, passed through by driver
>   * @driver_data: private regulator data
> + * @of_node: target of device structure (may be NULL)

Please don't apply this, I can't actually parse that description so I'm
fairly sure users will struggle also.  I'll try to get round to writing
something better at some point.

Re: [PATCH 4/14] kernel-doc: fix new warning in regulator core

[Randy Dunlap]

On 01/21/2012 10:35 AM, Mark Brown wrote:
> On Sat, Jan 21, 2012 at 11:02:38AM -0800, Randy Dunlap wrote:
> 
>> @@ -2731,6 +2731,7 @@ static void rdev_init_debugfs(struct reg
>>   * @dev: struct device for the regulator
>>   * @init_data: platform provided init data, passed through by driver
>>   * @driver_data: private regulator data
>> + * @of_node: target of device structure (may be NULL)


> Please don't apply this, I can't actually parse that description so I'm
> fairly sure users will struggle also.  I'll try to get round to writing
> something better at some point.

Thanks.  Ah, 'of' is not the preposition above, it was meant to be
the acronym for open firmware.  :(

-- 
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***

Re: [PATCH 4/14] kernel-doc: fix new warning in regulator core

[Mark Brown]

On Sat, Jan 21, 2012 at 11:37:51AM -0800, Randy Dunlap wrote:
> On 01/21/2012 10:35 AM, Mark Brown wrote:

> > Please don't apply this, I can't actually parse that description so I'm
> > fairly sure users will struggle also.  I'll try to get round to writing
> > something better at some point.

> Thanks.  Ah, 'of' is not the preposition above, it was meant to be
> the acronym for open firmware.  :(

Ah!  Now it parses fine!  Should still be clarified though, I'm sure
other people will make the same mistake, and actually the reason it's a
parameter is that it often won't actually be a device but will instead
be some named subnode.

Like I say I'll try to get round to fixing this.