[PATCH v1] i2c: ismt: Describe parameters in kernel doc

[PATCH v1] i2c: ismt: Describe parameters in kernel doc

[Andy Shevchenko]

Kernel doc validation script complains:

  CHECK   .../drivers/i2c/busses/i2c-ismt.c
.../i2c-ismt.c:182: warning: cannot understand function prototype: 'const struct pci_device_id ismt_ids[] = '
.../i2c-ismt.c:202: warning: Function parameter or member 'dev' not described in '__ismt_desc_dump'
.../i2c-ismt.c:202: warning: Function parameter or member 'desc' not described in '__ismt_desc_dump'
.../i2c-ismt.c:649: warning: cannot understand function prototype: 'const struct i2c_algorithm smbus_algorithm = '

Fix corresponding descriptions to make reader and kernel doc validator happy.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
 drivers/i2c/busses/i2c-ismt.c | 10 ++--------
 1 file changed, 2 insertions(+), 8 deletions(-)

diff --git a/drivers/i2c/busses/i2c-ismt.c b/drivers/i2c/busses/i2c-ismt.c
index 6ba91d4a4ce4..078e01799c83 100644
--- a/drivers/i2c/busses/i2c-ismt.c
+++ b/drivers/i2c/busses/i2c-ismt.c
@@ -176,9 +176,6 @@ struct ismt_priv {
 	u8 buffer[I2C_SMBUS_BLOCK_MAX + 16];	/* temp R/W data buffer */
 };
 
-/**
- * ismt_ids - PCI device IDs supported by this driver
- */
 static const struct pci_device_id ismt_ids[] = {
 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_S1200_SMT0) },
 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_S1200_SMT1) },
@@ -197,6 +194,8 @@ MODULE_PARM_DESC(bus_speed, "Bus Speed in kHz (0 = BIOS default)");
 
 /**
  * __ismt_desc_dump() - dump the contents of a specific descriptor
+ * @dev: the iSMT device
+ * @desc: the iSMT hardware descriptor
  */
 static void __ismt_desc_dump(struct device *dev, const struct ismt_desc *desc)
 {
@@ -642,11 +641,6 @@ static u32 ismt_func(struct i2c_adapter *adap)
 	       I2C_FUNC_SMBUS_PEC;
 }
 
-/**
- * smbus_algorithm - the adapter algorithm and supported functionality
- * @smbus_xfer: the adapter algorithm
- * @functionality: functionality supported by the adapter
- */
 static const struct i2c_algorithm smbus_algorithm = {
 	.smbus_xfer	= ismt_access,
 	.functionality	= ismt_func,
-- 
2.27.0

Re: [PATCH v1] i2c: ismt: Describe parameters in kernel doc

[Wolfram Sang]

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

On Wed, Jul 22, 2020 at 04:43:55PM +0300, Andy Shevchenko wrote:
> Kernel doc validation script complains:
> 
>   CHECK   .../drivers/i2c/busses/i2c-ismt.c
> .../i2c-ismt.c:182: warning: cannot understand function prototype: 'const struct pci_device_id ismt_ids[] = '
> .../i2c-ismt.c:202: warning: Function parameter or member 'dev' not described in '__ismt_desc_dump'
> .../i2c-ismt.c:202: warning: Function parameter or member 'desc' not described in '__ismt_desc_dump'
> .../i2c-ismt.c:649: warning: cannot understand function prototype: 'const struct i2c_algorithm smbus_algorithm = '
> 
> Fix corresponding descriptions to make reader and kernel doc validator happy.
> 
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> ---

Seth, Neil?

>  drivers/i2c/busses/i2c-ismt.c | 10 ++--------
>  1 file changed, 2 insertions(+), 8 deletions(-)
> 
> diff --git a/drivers/i2c/busses/i2c-ismt.c b/drivers/i2c/busses/i2c-ismt.c
> index 6ba91d4a4ce4..078e01799c83 100644
> --- a/drivers/i2c/busses/i2c-ismt.c
> +++ b/drivers/i2c/busses/i2c-ismt.c
> @@ -176,9 +176,6 @@ struct ismt_priv {
>  	u8 buffer[I2C_SMBUS_BLOCK_MAX + 16];	/* temp R/W data buffer */
>  };
>  
> -/**
> - * ismt_ids - PCI device IDs supported by this driver
> - */
>  static const struct pci_device_id ismt_ids[] = {
>  	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_S1200_SMT0) },
>  	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_S1200_SMT1) },
> @@ -197,6 +194,8 @@ MODULE_PARM_DESC(bus_speed, "Bus Speed in kHz (0 = BIOS default)");
>  
>  /**
>   * __ismt_desc_dump() - dump the contents of a specific descriptor
> + * @dev: the iSMT device
> + * @desc: the iSMT hardware descriptor
>   */
>  static void __ismt_desc_dump(struct device *dev, const struct ismt_desc *desc)
>  {
> @@ -642,11 +641,6 @@ static u32 ismt_func(struct i2c_adapter *adap)
>  	       I2C_FUNC_SMBUS_PEC;
>  }
>  
> -/**
> - * smbus_algorithm - the adapter algorithm and supported functionality
> - * @smbus_xfer: the adapter algorithm
> - * @functionality: functionality supported by the adapter
> - */
>  static const struct i2c_algorithm smbus_algorithm = {
>  	.smbus_xfer	= ismt_access,
>  	.functionality	= ismt_func,
> -- 
> 2.27.0
> 

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH v1] i2c: ismt: Describe parameters in kernel doc

[Wolfram Sang]

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

On Wed, Jul 22, 2020 at 04:43:55PM +0300, Andy Shevchenko wrote:
> Kernel doc validation script complains:
> 
>   CHECK   .../drivers/i2c/busses/i2c-ismt.c
> .../i2c-ismt.c:182: warning: cannot understand function prototype: 'const struct pci_device_id ismt_ids[] = '
> .../i2c-ismt.c:202: warning: Function parameter or member 'dev' not described in '__ismt_desc_dump'
> .../i2c-ismt.c:202: warning: Function parameter or member 'desc' not described in '__ismt_desc_dump'
> .../i2c-ismt.c:649: warning: cannot understand function prototype: 'const struct i2c_algorithm smbus_algorithm = '
> 
> Fix corresponding descriptions to make reader and kernel doc validator happy.
> 
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

Applied to for-next, thanks!


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]