Update kernel doc entry and correct the format. Now kernel doc does not complain about it.
In this change we reuse the comment that explain the algorithm as a kernel doc entry. However, blank lines are added, otherwise it will appear in a single paragraph in the kernel doc output. Signed-off-by: Eduardo Valentin <[email protected]> --- drivers/thermal/step_wise.c | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/drivers/thermal/step_wise.c b/drivers/thermal/step_wise.c index fdd1f52..413ee30 100644 --- a/drivers/thermal/step_wise.c +++ b/drivers/thermal/step_wise.c @@ -27,22 +27,34 @@ #include "thermal_core.h" -/* - * If the temperature is higher than a trip point, +/** + * DOC: Algorithm + * + * If the temperature is higher than a trip point: + * * a. if the trend is THERMAL_TREND_RAISING, use higher cooling * state for this trip point + * * b. if the trend is THERMAL_TREND_DROPPING, use lower cooling * state for this trip point + * * c. if the trend is THERMAL_TREND_RAISE_FULL, use upper limit * for this trip point + * * d. if the trend is THERMAL_TREND_DROP_FULL, use lower limit * for this trip point + * + * * If the temperature is lower than a trip point, + * * a. if the trend is THERMAL_TREND_RAISING, do nothing + * * b. if the trend is THERMAL_TREND_DROPPING, use lower cooling * state for this trip point, if the cooling state already * equals lower limit, deactivate the thermal instance + * * c. if the trend is THERMAL_TREND_RAISE_FULL, do nothing + * * d. if the trend is THERMAL_TREND_DROP_FULL, use lower limit, * if the cooling state already equals lower limit, * deactive the thermal instance @@ -169,16 +181,17 @@ static void thermal_zone_trip_update(struct thermal_zone_device *tz, int trip) } /** - * step_wise_throttle - throttles devices asscciated with the given zone - * @tz - thermal_zone_device - * @trip - the trip point - * @trip_type - type of the trip point + * step_wise_throttle - throttles devices associated with the given zone + * @tz: thermal_zone_device + * @trip: the trip point * * Throttling Logic: This uses the trend of the thermal zone to throttle. * If the thermal zone is 'heating up' this throttles all the cooling * devices associated with the zone and its particular trip point, by one * step. If the zone is 'cooling down' it brings back the performance of * the devices by one step. + * + * Return: 0. */ static int step_wise_throttle(struct thermal_zone_device *tz, int trip) { -- 2.1.3 -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
