Commit 246d7a11 authored Jul 02, 2020 by Lee Jones Committed by Greg Kroah-Hartman Jul 03, 2020

usb: common: ulpi: Fix a few kerneldoc related issues

Firstly, demote function header to standard comment block as
they are not suitable for kerneldoc. Then provide description
for ulpi_register_driver()'s argument 'module'. Finally rename
description for ulpi_unregister_interface()'s 'ulpi' arg.

Fixes the following W=1 warnings:

drivers/usb/common/ulpi.c:23: warning: Function parameter or member 'ulpi' not described in 'ulpi_read'
drivers/usb/common/ulpi.c:23: warning: Function parameter or member 'addr' not described in 'ulpi_read'
drivers/usb/common/ulpi.c:150: warning: Function parameter or member 'module' not described in '__ulpi_register_driver'
drivers/usb/common/ulpi.c:299: warning: Function parameter or member 'ulpi' not described in 'ulpi_unregister_interface'
drivers/usb/common/ulpi.c:299: warning: Excess function parameter 'intrf' description in 'ulpi_unregister_interface'

Cc: Felipe Balbi <balbi@kernel.org>
Cc: Heikki Krogerus <heikki.krogerus@linux.intel.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200702144625.2533530-8-lee.jones@linaro.org

Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

parent fb678a5a

drivers/usb/common/ulpi.c

+3 −2

Original line number	Diff line number	Diff line
		// SPDX-License-Identifier: GPL-2.0
		/**
		/*
		* ulpi.c - USB ULPI PHY bus
		*
		* Copyright (C) 2015 Intel Corporation
		@@ -143,6 +143,7 @@ static const struct device_type ulpi_dev_type = {
		/**
		* ulpi_register_driver - register a driver with the ULPI bus
		* @drv: driver being registered
		* @module: ends up being THIS_MODULE
		*
		* Registers a driver with the ULPI bus.
		*/
		@@ -290,7 +291,7 @@ EXPORT_SYMBOL_GPL(ulpi_register_interface);

		/**
		* ulpi_unregister_interface - unregister ULPI interface
		* @intrf: struct ulpi_interface
		* @ulpi: struct ulpi_interface
		*
		* Unregisters a ULPI device and it's interface that was created with
		* ulpi_create_interface().