driver core: Add missing parameter description to kerneldoc
PATCH 1/1 driver core: Add missing parameter description to kerneldoc
From: Thierry Reding <[email protected]>
The deferred_probe_work_func() takes a single parameter but the kerneldoc doesn't describe it.
---
Note that since the function is locally scoped there isn't all that much point in having a kerneldoc comment for it, but since it's already there might as well make it correct.
drivers/base/dd.c | 1 + 1 file changed, 1 insertion(+)
drivers/base/dd.c +1 -0
@@ -56,6 +56,7 @@ static atomic_t deferred_trigger_count = ATOMIC_INIT(0);/** * deferred_probe_work_func() - Retry probing devices in the active list. +* @work: work queue for deferred probe processing */ static void deferred_probe_work_func (struct work_struct *work) {
Signature · 1 line
2.0.4
Greg Kroah-Hartman
maintainerQuoted 10 lines · Thierry Reding
From: Thierry Reding <[email protected]>
The
deferred_probe_work_func()takes a single parameter but the kerneldoc doesn't describe it.Signed-off-by Thierry Reding <[email protected]>---
Note that since the function is locally scoped there isn't all that much point in having a kerneldoc comment for it, but since it's already there might as well make it correct.
How about just removing the kerneldoc format so this isn't an issue?
thanks,
greg k-h
Quoted 6 lines · Greg Kroah-Hartman
Quoted 5 lines · Thierry Reding
From: Thierry Reding <[email protected]>
The
deferred_probe_work_func()takes a single parameter but the kerneldoc doesn't describe it.
Quoted 7 lines
Quoted 5 lines
Signed-off-by Thierry Reding <[email protected]>---
Note that since the function is locally scoped there isn't all that much point in having a kerneldoc comment for it, but since it's already there might as well make it correct.How about just removing the kerneldoc format so this isn't an issue?
I can do that.
Thierry
PATCH v2 1/1 driver core: Remove kerneldoc from local function
In reply to Thierry RedingFrom: Thierry Reding <[email protected]>
The deferred_probe_work_func() function is locally scoped, therefore an associated kerneldoc comment isn't very useful. Replace the kerneldoc opening marker (/**) with a regular block comment marker (/*) to avoid the comment from being parsed by kerneldoc. This gets rid of a warning caused by a missing description for the "work" argument.
---
Changes in v2:
- make comment non-kerneldoc rather than fixing it up
drivers/base/dd.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/base/dd.c +1 -1
@@ -54,7 +54,7 @@ static LIST_HEAD(deferred_probe_active_list);static struct workqueue_struct *deferred_wq;static atomic_t deferred_trigger_count =ATOMIC_INIT (0 ); -/** +/* * deferred_probe_work_func() - Retry probing devices in the active list. */ static void deferred_probe_work_func (struct work_struct *work)
Signature · 1 line
2.0.4