i2c: ismt: Describe parameters in kernel doc
Subsystems (2)
PATCH 1/1 i2c: ismt: Describe parameters in kernel doc
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.
--- drivers/i2c/busses/i2c-ismt.c | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-)
drivers/i2c/busses/i2c-ismt.c +2 -8
@@ -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,
Signature · 1 line
2.27.0
Quoted 8 lines · Andy Shevchenko
Kernel doc validation script complains:
CHECK
.../drivers/i2c/busses/i2c-ismt.c.../i2c-ismt.c:182: warning: cannot understand function prototype: 'const structpci_device_idismt_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 structi2c_algorithmsmbus_algorithm= '
Quoted 4 lines
Fix corresponding descriptions to make reader and kernel doc validator happy.
Signed-off-by Andy Shevchenko <[email protected]>---
Seth, Neil?
Quoted 41 lines
drivers/i2c/busses/i2c-ismt.c | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-)drivers/i2c/busses/i2c-ismt.c +2
-8@@ -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,Signature · 1 line
2.27.0
Wolfram Sang
AppliedQuoted 11 lines · Andy Shevchenko
Kernel doc validation script complains:
CHECK
.../drivers/i2c/busses/i2c-ismt.c.../i2c-ismt.c:182: warning: cannot understand function prototype: 'const structpci_device_idismt_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 structi2c_algorithmsmbus_algorithm= 'Fix corresponding descriptions to make reader and kernel doc validator happy.
Signed-off-by Andy Shevchenko <[email protected]>
Applied to for-next, thanks!