[PATCH] driver core: Add missing parameter description to kerneldoc

[PATCH] driver core: Add missing parameter description to kerneldoc

[Thierry Reding]

From: Thierry Reding <treding@nvidia.com>

The deferred_probe_work_func() takes a single parameter but the
kerneldoc doesn't describe it.

Signed-off-by: Thierry Reding <treding@nvidia.com>
---
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(+)

diff --git a/drivers/base/dd.c b/drivers/base/dd.c
index e4ffbcf2f519..e8d417bb65bd 100644
--- a/drivers/base/dd.c
+++ b/drivers/base/dd.c
@@ -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)
 {
-- 
2.0.4

Re: [PATCH] driver core: Add missing parameter description to kerneldoc

[Greg Kroah-Hartman]

On Fri, Aug 08, 2014 at 11:36:31AM +0200, Thierry Reding wrote:
> From: Thierry Reding <treding@nvidia.com>
> 
> The deferred_probe_work_func() takes a single parameter but the
> kerneldoc doesn't describe it.
> 
> Signed-off-by: Thierry Reding <treding@nvidia.com>
> ---
> 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

Re: [PATCH] driver core: Add missing parameter description to kerneldoc

[Thierry Reding]

[-- Attachment #1: Type: text/plain, Size: 662 bytes --]

On Fri, Aug 08, 2014 at 06:41:47AM -0700, Greg Kroah-Hartman wrote:
> On Fri, Aug 08, 2014 at 11:36:31AM +0200, Thierry Reding wrote:
> > From: Thierry Reding <treding@nvidia.com>
> > 
> > The deferred_probe_work_func() takes a single parameter but the
> > kerneldoc doesn't describe it.
> > 
> > Signed-off-by: Thierry Reding <treding@nvidia.com>
> > ---
> > 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

[-- Attachment #2: Type: application/pgp-signature, Size: 819 bytes --]

[PATCH v2] driver core: Remove kerneldoc from local function

[Thierry Reding]

From: Thierry Reding <treding@nvidia.com>

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.

Signed-off-by: Thierry Reding <treding@nvidia.com>
---
Changes in v2:
- make comment non-kerneldoc rather than fixing it up

 drivers/base/dd.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/base/dd.c b/drivers/base/dd.c
index e4ffbcf2f519..cdc779cf79a3 100644
--- a/drivers/base/dd.c
+++ b/drivers/base/dd.c
@@ -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)
-- 
2.0.4