dio: fix kernel-doc notation
PATCH 1/1 dio: fix kernel-doc notation
From: Randy Dunlap <[email protected]>
Fix kernel-doc in drivers/dio/ so that it is formatted correctly and the parameter names match the function parameters.
Signed-off-by Randy Dunlap <[email protected]>
--- drivers/dio/dio-driver.c | 70 +++++++++++++++++-------------------- 1 file changed, 34 insertions(+), 36 deletions(-)
drivers/dio/dio-driver.c +34 -36
@@ -15,16 +15,15 @@#include <linux/dio.h> -/** -* dio_match_device - Tell if a DIO device structure has a matching -* DIO device id structure -* @ids: array of DIO device id structures to search in -* @dev: the DIO device structure to match against -* -* Used by a driver to check whether a DIO device present in the -* system is in its list of supported devices. Returns the matching -* dio_device_id structure or %NULL if there is no match. -*/ +/** +* dio_match_device - Tell if a DIO device structure has a matching DIO device id structure +* @ids: array of DIO device id structures to search in +* @d: the DIO device structure to match against +* +* Used by a driver to check whether a DIO device present in the +* system is in its list of supported devices. Returns the matching +* dio_device_id structure or %NULL if there is no match. +*/ const struct dio_device_id * dio_match_device(const struct dio_device_id *ids,
@@ -66,13 +65,13 @@ static int dio_device_probe(struct devic } -/** -* dio_register_driver - register a new DIO driver -* @drv: the driver structure to register -* -* Adds the driver structure to the list of registered drivers -* Returns zero or a negative error value. -*/ +/** +* dio_register_driver - register a new DIO driver +* @drv: the driver structure to register +* +* Adds the driver structure to the list of registered drivers +* Returns zero or a negative error value. +*/ int dio_register_driver (struct dio_driver *drv) {
@@ -85,15 +84,15 @@ int dio_register_driver(struct dio_drive } -/** -* dio_unregister_driver - unregister a DIO driver -* @drv: the driver structure to unregister -* -* Deletes the driver structure from the list of registered DIO drivers, -* gives it a chance to clean up by calling its remove() function for -* each device it was responsible for, and marks those devices as -* driverless. -*/ +/** +* dio_unregister_driver - unregister a DIO driver +* @drv: the driver structure to unregister +* +* Deletes the driver structure from the list of registered DIO drivers, +* gives it a chance to clean up by calling its remove() function for +* each device it was responsible for, and marks those devices as +* driverless. +*/ void dio_unregister_driver (struct dio_driver *drv) {
@@ -101,16 +100,15 @@ void dio_unregister_driver(struct dio_dr } -/** -* dio_bus_match - Tell if a DIO device structure has a matching DIO -* device id structure -* @ids: array of DIO device id structures to search in -* @dev: the DIO device structure to match against -* -* Used by a driver to check whether a DIO device present in the -* system is in its list of supported devices. Returns the matching -* dio_device_id structure or %NULL if there is no match. -*/ +/** +* dio_bus_match - Tell if a DIO device structure has a matching DIO device id structure +* @dev: the DIO device structure to match against +* @drv: the &device_driver that points to the array of DIO device id structures to search +* +* Used by a driver to check whether a DIO device present in the +* system is in its list of supported devices. Returns the matching +* dio_device_id structure or %NULL if there is no match. +*/ static int dio_bus_match (struct device *dev,struct device_driver *drv) {
Quoted 6 lines
From: Randy Dunlap <[email protected]>
Fix kernel-doc in
drivers/dio/so that it is formatted correctly and the parameter names match the function parameters.Signed-off-by Randy Dunlap <[email protected]>
Acked-by Jochen Friedrich <[email protected]>