dio: fix kernel-doc notation

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 <randy.dunlap@oracle.com>
Acked-By: Jochen Friedrich <jochen@scram.de>
Signed-off-by: Adrian Bunk <bunk@kernel.org>
This commit is contained in:
Randy Dunlap 2008-02-03 16:29:12 +02:00 committed by Adrian Bunk
parent d81919c9c2
commit 771fcb58e5
1 changed files with 34 additions and 36 deletions

View File

@ -15,16 +15,15 @@
#include <linux/dio.h> #include <linux/dio.h>
/** /**
* dio_match_device - Tell if a DIO device structure has a matching * dio_match_device - Tell if a DIO device structure has a matching DIO device id structure
* DIO device id structure * @ids: array of DIO device id structures to search in
* @ids: array of DIO device id structures to search in * @d: the DIO device structure to match against
* @dev: the DIO device structure to match against *
* * Used by a driver to check whether a DIO device present in the
* Used by a driver to check whether a DIO device present in the * system is in its list of supported devices. Returns the matching
* system is in its list of supported devices. Returns the matching * dio_device_id structure or %NULL if there is no match.
* dio_device_id structure or %NULL if there is no match. */
*/
const struct dio_device_id * const struct dio_device_id *
dio_match_device(const struct dio_device_id *ids, dio_match_device(const struct dio_device_id *ids,
@ -66,13 +65,13 @@ static int dio_device_probe(struct device *dev)
} }
/** /**
* dio_register_driver - register a new DIO driver * dio_register_driver - register a new DIO driver
* @drv: the driver structure to register * @drv: the driver structure to register
* *
* Adds the driver structure to the list of registered drivers * Adds the driver structure to the list of registered drivers
* Returns zero or a negative error value. * Returns zero or a negative error value.
*/ */
int dio_register_driver(struct dio_driver *drv) int dio_register_driver(struct dio_driver *drv)
{ {
@ -85,15 +84,15 @@ int dio_register_driver(struct dio_driver *drv)
} }
/** /**
* dio_unregister_driver - unregister a DIO driver * dio_unregister_driver - unregister a DIO driver
* @drv: the driver structure to unregister * @drv: the driver structure to unregister
* *
* Deletes the driver structure from the list of registered DIO drivers, * Deletes the driver structure from the list of registered DIO drivers,
* gives it a chance to clean up by calling its remove() function for * gives it a chance to clean up by calling its remove() function for
* each device it was responsible for, and marks those devices as * each device it was responsible for, and marks those devices as
* driverless. * driverless.
*/ */
void dio_unregister_driver(struct dio_driver *drv) void dio_unregister_driver(struct dio_driver *drv)
{ {
@ -101,16 +100,15 @@ void dio_unregister_driver(struct dio_driver *drv)
} }
/** /**
* dio_bus_match - Tell if a DIO device structure has a matching DIO * dio_bus_match - Tell if a DIO device structure has a matching DIO device id structure
* device id structure * @dev: the DIO device structure to match against
* @ids: array of DIO device id structures to search in * @drv: the &device_driver that points to the array of DIO device id structures to search
* @dev: the DIO device structure to match against *
* * Used by a driver to check whether a DIO device present in the
* Used by a driver to check whether a DIO device present in the * system is in its list of supported devices. Returns the matching
* system is in its list of supported devices. Returns the matching * dio_device_id structure or %NULL if there is no match.
* dio_device_id structure or %NULL if there is no match. */
*/
static int dio_bus_match(struct device *dev, struct device_driver *drv) static int dio_bus_match(struct device *dev, struct device_driver *drv)
{ {