[PATCH v1 02/13] serial: 8250_exar: Describe all parameters in kernel doc

From: Andy Shevchenko
Date: Thu May 02 2024 - 10:47:59 EST


Kernel doc validator is not happy:

warning: Function parameter or struct member 'pcidev' not described in 'cti_get_port_type_xr17c15x_xr17v25x'
warning: Function parameter or struct member 'pcidev' not described in 'cti_get_port_type_fpga'
warning: Function parameter or struct member 'pcidev' not described in 'cti_get_port_type_xr17v35x'

Add missed descriptions.

Fixes: f7ce07062988 ("serial: exar: add CTI specific setup code")
Signed-off-by: Andy Shevchenko <andriy.shevchenko@xxxxxxxxxxxxxxx>
---
drivers/tty/serial/8250/8250_exar.c | 3 +++
1 file changed, 3 insertions(+)

diff --git a/drivers/tty/serial/8250/8250_exar.c b/drivers/tty/serial/8250/8250_exar.c
index 9930668610ca..150c4abd92fc 100644
--- a/drivers/tty/serial/8250/8250_exar.c
+++ b/drivers/tty/serial/8250/8250_exar.c
@@ -715,6 +715,7 @@ static int cti_read_osc_freq(struct exar8250 *priv, u8 eeprom_offset)
/**
* cti_get_port_type_xr17c15x_xr17v25x() - Get port type of xr17c15x/xr17v25x
* @priv: Device's private structure
+ * @pcidev: Pointer to the PCI device for this port
* @port_num: Port to get type of
*
* CTI xr17c15x and xr17v25x based cards port types are based on PCI IDs.
@@ -807,6 +808,7 @@ static enum cti_port_type cti_get_port_type_xr17c15x_xr17v25x(struct exar8250 *p
/**
* cti_get_port_type_fpga() - Get the port type of a CTI FPGA card
* @priv: Device's private structure
+ * @pcidev: Pointer to the PCI device for this port
* @port_num: Port to get type of
*
* FPGA based cards port types are based on PCI IDs.
@@ -836,6 +838,7 @@ static enum cti_port_type cti_get_port_type_fpga(struct exar8250 *priv,
/**
* cti_get_port_type_xr17v35x() - Read port type from the EEPROM
* @priv: Device's private structure
+ * @pcidev: Pointer to the PCI device for this port
* @port_num: port offset
*
* CTI XR17V35X based cards have the port types stored in the EEPROM.
--
2.43.0.rc1.1336.g36b5255a03ac