Commit f2e1d306 authored by Lee Jones's avatar Lee Jones Committed by Greg Kroah-Hartman

misc: pti: Repair kerneldoc formatting issues

W=1 kernel builds report a lack of descriptions for various
function arguments.  In reality they are documented, but the
formatting was not as expected '@.*:'.  Instead, '-'s were
used as separators.

This change fixes the following warnings:

 drivers/misc/pti.c:748: warning: Function parameter or member 'port' not described in 'pti_port_activate'
 drivers/misc/pti.c:748: warning: Function parameter or member 'tty' not described in 'pti_port_activate'
 drivers/misc/pti.c:765: warning: Function parameter or member 'port' not described in 'pti_port_shutdown'
 drivers/misc/pti.c:793: warning: Function parameter or member 'pdev' not described in 'pti_pci_probe'
 drivers/misc/pti.c:793: warning: Function parameter or member 'ent' not described in 'pti_pci_probe'

Cc: J Freyensee <james_p_freyensee@linux.intel.com>
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200701085853.164358-2-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 81148a7a
...@@ -733,8 +733,8 @@ static struct console pti_console = { ...@@ -733,8 +733,8 @@ static struct console pti_console = {
* pti_port_activate()- Used to start/initialize any items upon * pti_port_activate()- Used to start/initialize any items upon
* first opening of tty_port(). * first opening of tty_port().
* *
* @port- The tty port number of the PTI device. * @port: The tty port number of the PTI device.
* @tty- The tty struct associated with this device. * @tty: The tty struct associated with this device.
* *
* Returns: * Returns:
* always returns 0 * always returns 0
...@@ -754,7 +754,7 @@ static int pti_port_activate(struct tty_port *port, struct tty_struct *tty) ...@@ -754,7 +754,7 @@ static int pti_port_activate(struct tty_port *port, struct tty_struct *tty)
* pti_port_shutdown()- Used to stop/shutdown any items upon the * pti_port_shutdown()- Used to stop/shutdown any items upon the
* last tty port close. * last tty port close.
* *
* @port- The tty port number of the PTI device. * @port: The tty port number of the PTI device.
* *
* Notes: The primary purpose of the PTI tty port 0 is to hook * Notes: The primary purpose of the PTI tty port 0 is to hook
* the syslog daemon to it; thus this port will be open for a * the syslog daemon to it; thus this port will be open for a
...@@ -780,8 +780,8 @@ static const struct tty_port_operations tty_port_ops = { ...@@ -780,8 +780,8 @@ static const struct tty_port_operations tty_port_ops = {
* pti_pci_probe()- Used to detect pti on the pci bus and set * pti_pci_probe()- Used to detect pti on the pci bus and set
* things up in the driver. * things up in the driver.
* *
* @pdev- pci_dev struct values for pti. * @pdev: pci_dev struct values for pti.
* @ent- pci_device_id struct for pti driver. * @ent: pci_device_id struct for pti driver.
* *
* Returns: * Returns:
* 0 for success * 0 for success
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment