Skip to content

Commit

Permalink
dio: fix kernel-doc notation
Browse files Browse the repository at this point in the history
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]>
Signed-off-by: Adrian Bunk <[email protected]>
  • Loading branch information
rddunlap authored and AdrianBunk committed Feb 3, 2008
1 parent d81919c commit 771fcb5
Showing 1 changed file with 34 additions and 36 deletions.
70 changes: 34 additions & 36 deletions drivers/dio/dio-driver.c
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -66,13 +65,13 @@ static int dio_device_probe(struct device *dev)
}


/**
* 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)
{
Expand All @@ -85,32 +84,31 @@ int dio_register_driver(struct dio_driver *drv)
}


/**
* 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)
{
driver_unregister(&drv->driver);
}


/**
* 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)
{
Expand Down

0 comments on commit 771fcb5

Please sign in to comment.