summaryrefslogtreecommitdiffstats
path: root/drivers/thermal
diff options
context:
space:
mode:
authorEduardo Valentin <eduardo.valentin@ti.com>2013-04-23 21:48:17 +0000
committerZhang Rui <rui.zhang@intel.com>2013-04-25 00:56:28 +0800
commit9892e5dc56f185d104e6dddd1e2d0f6ae8f4f211 (patch)
tree60f48898bb5984d00a7d2e30298863267820a63a /drivers/thermal
parentd2e4eb83e7523c5b673ce3004d514c1d1ec32618 (diff)
downloadtalos-obmc-linux-9892e5dc56f185d104e6dddd1e2d0f6ae8f4f211.tar.gz
talos-obmc-linux-9892e5dc56f185d104e6dddd1e2d0f6ae8f4f211.zip
thermal: update kernel-doc for thermal_zone_unbind_cooling_device
This patch updates the documentation for thermal_zone_unbind_cooling_device 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.c11
1 files changed, 8 insertions, 3 deletions
diff --git a/drivers/thermal/thermal_core.c b/drivers/thermal/thermal_core.c
index 5f6af8ade324..9550e6897114 100644
--- a/drivers/thermal/thermal_core.c
+++ b/drivers/thermal/thermal_core.c
@@ -1222,13 +1222,18 @@ free_mem:
EXPORT_SYMBOL_GPL(thermal_zone_bind_cooling_device);
/**
- * thermal_zone_unbind_cooling_device - unbind a cooling device from a thermal zone
- * @tz: thermal zone device
+ * thermal_zone_unbind_cooling_device() - unbind a cooling device from a
+ * thermal zone.
+ * @tz: pointer to a struct thermal_zone_device.
* @trip: indicates which trip point the cooling devices is
* associated with in this thermal zone.
- * @cdev: thermal cooling device
+ * @cdev: pointer to a struct thermal_cooling_device.
*
+ * This interface function unbind a thermal cooling device from the certain
+ * trip point of a thermal zone device.
* This function is usually called in the thermal zone device .unbind callback.
+ *
+ * Return: 0 on success, the proper error value otherwise.
*/
int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
int trip,
OpenPOWER on IntegriCloud