Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200701085853.164358-2-lee.jones@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Lee Jones and committed by
Greg Kroah-Hartman
f2e1d306 81148a7a

+5 -5
+5 -5
drivers/misc/pti.c
··· 733 733 * pti_port_activate()- Used to start/initialize any items upon 734 734 * first opening of tty_port(). 735 735 * 736 - * @port- The tty port number of the PTI device. 737 - * @tty- The tty struct associated with this device. 736 + * @port: The tty port number of the PTI device. 737 + * @tty: The tty struct associated with this device. 738 738 * 739 739 * Returns: 740 740 * always returns 0 ··· 754 754 * pti_port_shutdown()- Used to stop/shutdown any items upon the 755 755 * last tty port close. 756 756 * 757 - * @port- The tty port number of the PTI device. 757 + * @port: The tty port number of the PTI device. 758 758 * 759 759 * Notes: The primary purpose of the PTI tty port 0 is to hook 760 760 * the syslog daemon to it; thus this port will be open for a ··· 780 780 * pti_pci_probe()- Used to detect pti on the pci bus and set 781 781 * things up in the driver. 782 782 * 783 - * @pdev- pci_dev struct values for pti. 784 - * @ent- pci_device_id struct for pti driver. 783 + * @pdev: pci_dev struct values for pti. 784 + * @ent: pci_device_id struct for pti driver. 785 785 * 786 786 * Returns: 787 787 * 0 for success