kernel-doc: fix new warning in regulator core
PATCH 4/14 kernel-doc: fix new warning in regulator core
From: Randy Dunlap <[email protected]>
Fix new kernel-doc warning:
Warning(drivers/regulator/core.c:2741): No description found for parameter 'of_node'
--- drivers/regulator/core.c | 1 + 1 file changed, 1 insertion(+)
drivers/regulator/core.c +1 -0
@@ -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.
drivers/regulator/core.c static void rdev_init_debugfs(struct reg · line 2734
Quoted 5 lines · Randy Dunlap
drivers/regulator/core.c +1
-0@@ -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.
Quoted 12 lines · Mark Brown
drivers/regulator/core.c static void rdev_init_debugfs(struct reg · line 2734
Quoted 5 lines · Randy Dunlap
drivers/regulator/core.c +1
-0@@ -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. :(
Signature · 2 lines
~Randy *** Remember to use Documentation/SubmitChecklist when testing your code ***
Quoted 8 lines · Randy Dunlap
Quoted 3 lines · Mark Brown
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.