diff options
| author | Henrik Kretzschmar <henne@nachtwindheim.de> | 2006-07-04 18:53:19 -0400 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@suse.de> | 2006-07-12 19:09:08 -0400 |
| commit | 42734dafa43e453a8b6769a5ebd3a01ffc1fd116 (patch) | |
| tree | f63e13562924295a66548c77cc06491b939c6844 | |
| parent | 7d12e9de5d73a836f040157b27166e68990ea9b4 (diff) | |
[PATCH] Driver core: kernel-doc in drivers/base/core.c corrections
Corrects the kerneldocs for device_create() and device_destroy()
with an eye on coding style, grammar and readability.
Signed-off-by: Henrik Kretzschmar <henne@nachtwindheim.de>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
| -rw-r--r-- | drivers/base/core.c | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/drivers/base/core.c b/drivers/base/core.c index e61ad4e78c18..be6b5bc0677d 100644 --- a/drivers/base/core.c +++ b/drivers/base/core.c | |||
| @@ -559,20 +559,20 @@ static void device_create_release(struct device *dev) | |||
| 559 | 559 | ||
| 560 | /** | 560 | /** |
| 561 | * device_create - creates a device and registers it with sysfs | 561 | * device_create - creates a device and registers it with sysfs |
| 562 | * @class: pointer to the struct class that this device should be registered to. | 562 | * @class: pointer to the struct class that this device should be registered to |
| 563 | * @parent: pointer to the parent struct device of this new device, if any. | 563 | * @parent: pointer to the parent struct device of this new device, if any |
| 564 | * @devt: the dev_t for the char device to be added. | 564 | * @devt: the dev_t for the char device to be added |
| 565 | * @fmt: string for the class device's name | 565 | * @fmt: string for the device's name |
| 566 | * | ||
| 567 | * This function can be used by char device classes. A struct device | ||
| 568 | * will be created in sysfs, registered to the specified class. | ||
| 566 | * | 569 | * |
| 567 | * This function can be used by char device classes. A struct | ||
| 568 | * device will be created in sysfs, registered to the specified | ||
| 569 | * class. | ||
| 570 | * A "dev" file will be created, showing the dev_t for the device, if | 570 | * A "dev" file will be created, showing the dev_t for the device, if |
| 571 | * the dev_t is not 0,0. | 571 | * the dev_t is not 0,0. |
| 572 | * If a pointer to a parent struct device is passed in, the newly | 572 | * If a pointer to a parent struct device is passed in, the newly created |
| 573 | * created struct device will be a child of that device in sysfs. The | 573 | * struct device will be a child of that device in sysfs. |
| 574 | * pointer to the struct device will be returned from the call. Any | 574 | * The pointer to the struct device will be returned from the call. |
| 575 | * further sysfs files that might be required can be created using this | 575 | * Any further sysfs files that might be required can be created using this |
| 576 | * pointer. | 576 | * pointer. |
| 577 | * | 577 | * |
| 578 | * Note: the struct class passed to this function must have previously | 578 | * Note: the struct class passed to this function must have previously |
| @@ -620,11 +620,11 @@ EXPORT_SYMBOL_GPL(device_create); | |||
| 620 | 620 | ||
| 621 | /** | 621 | /** |
| 622 | * device_destroy - removes a device that was created with device_create() | 622 | * device_destroy - removes a device that was created with device_create() |
| 623 | * @class: the pointer to the struct class that this device was registered * with. | 623 | * @class: pointer to the struct class that this device was registered with |
| 624 | * @devt: the dev_t of the device that was previously registered. | 624 | * @devt: the dev_t of the device that was previously registered |
| 625 | * | 625 | * |
| 626 | * This call unregisters and cleans up a class device that was created with a | 626 | * This call unregisters and cleans up a device that was created with a |
| 627 | * call to class_device_create() | 627 | * call to device_create(). |
| 628 | */ | 628 | */ |
| 629 | void device_destroy(struct class *class, dev_t devt) | 629 | void device_destroy(struct class *class, dev_t devt) |
| 630 | { | 630 | { |
