HID: intel-ish-hid: fix some 'make W=1' warnings

[PATCH 1/2] HID: intel-ish-hid: fix ishtp_wait_resume() kernel-doc

Posted by Jeff Johnson 1 year, 8 months ago

Fix the 'make W=1' kernel-doc warning:

drivers/hid/intel-ish-hid/ishtp/bus.c:853: warning: Function parameter or struct member 'dev' not described in 'ishtp_wait_resume'

Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202311060843.dXENYlGc-lkp@intel.com/
Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
---
 drivers/hid/intel-ish-hid/ishtp/bus.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/hid/intel-ish-hid/ishtp/bus.c b/drivers/hid/intel-ish-hid/ishtp/bus.c
index 03d5601ce807..f3042c4b8710 100644
--- a/drivers/hid/intel-ish-hid/ishtp/bus.c
+++ b/drivers/hid/intel-ish-hid/ishtp/bus.c
@@ -844,6 +844,7 @@ EXPORT_SYMBOL(ishtp_device);
 
 /**
  * ishtp_wait_resume() - Wait for IPC resume
+ * @dev: ishtp device
  *
  * Wait for IPC resume
  *

-- 
2.42.0

Re: [PATCH 1/2] HID: intel-ish-hid: fix ishtp_wait_resume() kernel-doc

Posted by srinivas pandruvada 1 year, 8 months ago

On Sat, 2024-05-25 at 08:17 -0700, Jeff Johnson wrote:
> Fix the 'make W=1' kernel-doc warning:
> 
> drivers/hid/intel-ish-hid/ishtp/bus.c:853: warning: Function
> parameter or struct member 'dev' not described in 'ishtp_wait_resume'
> 
> Reported-by: kernel test robot <lkp@intel.com>
> Closes:
> https://lore.kernel.org/oe-kbuild-all/202311060843.dXENYlGc-lkp@intel.com/
> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
Acked-by: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>

> ---
>  drivers/hid/intel-ish-hid/ishtp/bus.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/hid/intel-ish-hid/ishtp/bus.c
> b/drivers/hid/intel-ish-hid/ishtp/bus.c
> index 03d5601ce807..f3042c4b8710 100644
> --- a/drivers/hid/intel-ish-hid/ishtp/bus.c
> +++ b/drivers/hid/intel-ish-hid/ishtp/bus.c
> @@ -844,6 +844,7 @@ EXPORT_SYMBOL(ishtp_device);
>  
>  /**
>   * ishtp_wait_resume() - Wait for IPC resume
> + * @dev: ishtp device
>   *
>   * Wait for IPC resume
>   *
>

[PATCH 1/2] HID: intel-ish-hid: fix ishtp_wait_resume() kernel-doc
[PATCH 2/2] HID: intel-ish-hid: add MODULE_DESCRIPTION()