diff options
| author | Eduardo Valentin <eduardo.valentin@ti.com> | 2013-04-24 01:48:18 +0400 |
|---|---|---|
| committer | Zhang Rui <rui.zhang@intel.com> | 2013-04-24 20:56:32 +0400 |
| commit | 3a6eccb35219a7cfa7c7bbac16aa344d4a336fd4 (patch) | |
| tree | d2d8bd6ad8a76b3c554c94d5f6c48e93f7cc942f /drivers/thermal | |
| parent | 9892e5dc56f185d104e6dddd1e2d0f6ae8f4f211 (diff) | |
| download | linux-3a6eccb35219a7cfa7c7bbac16aa344d4a336fd4.tar.xz | |
thermal: update kernel-doc for thermal_cooling_device_register
This patch updates the documentation for thermal_cooling_device_register
and removes the warnings generated by scripts/kernel-doc -v.
Signed-off-by: Eduardo Valentin <eduardo.valentin@ti.com>
Signed-off-by: Zhang Rui <rui.zhang@intel.com>
Diffstat (limited to 'drivers/thermal')
| -rw-r--r-- | drivers/thermal/thermal_core.c | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/drivers/thermal/thermal_core.c b/drivers/thermal/thermal_core.c index 9550e6897114..15220f9c849f 100644 --- a/drivers/thermal/thermal_core.c +++ b/drivers/thermal/thermal_core.c @@ -1287,10 +1287,17 @@ static struct class thermal_class = { }; /** - * thermal_cooling_device_register - register a new thermal cooling device + * thermal_cooling_device_register() - register a new thermal cooling device * @type: the thermal cooling device type. * @devdata: device private data. * @ops: standard thermal cooling devices callbacks. + * + * This interface function adds a new thermal cooling device (fan/processor/...) + * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself + * to all the thermal zone devices registered at the same time. + * + * Return: a pointer to the created struct thermal_cooling_device or an + * ERR_PTR. Caller must check return value with IS_ERR*() helpers. */ struct thermal_cooling_device * thermal_cooling_device_register(char *type, void *devdata, |