Improve javadoc for all addons (#15667)

Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
This commit is contained in:
Holger Friedrich
2023-09-30 21:49:12 +02:00
committed by GitHub
parent 0039e391cd
commit cbf4411034
618 changed files with 1106 additions and 1110 deletions

View File

@@ -60,7 +60,7 @@ public class EnergyApi extends RestManager {
*
* @param homeId The id of home (required)
* @param mode The mode. (required)
* @throws NetatmoCommunicationException when call failed, e.g. server error or cannot deserialize
* @throws NetatmoException when call failed, e.g. server error or cannot deserialize
*/
public void setThermMode(String homeId, String mode) throws NetatmoException {
UriBuilder uriBuilder = getApiUriBuilder(SUB_PATH_SET_THERM_MODE, PARAM_HOME_ID, homeId, PARAM_MODE, mode);
@@ -76,7 +76,7 @@ public class EnergyApi extends RestManager {
* @param mode The mode. (required)
* @param endtime For manual or max setpoint_mode, defines when the setpoint expires.
* @param temp For manual setpoint_mode, defines the temperature setpoint (in °C)
* @throws NetatmoCommunicationException when call failed, e.g. server error or cannot deserialize
* @throws NetatmoException when call failed, e.g. server error or cannot deserialize
*/
public void setThermpoint(String homeId, String roomId, SetpointMode mode, long endtime, double temp)
throws NetatmoException {

View File

@@ -86,7 +86,7 @@ public class WeatherUtils {
* Compute the associated scale appreciation of a given humidex index
* https://www.researchgate.net/figure/The-scale-of-Humidex-and-the-degree-of-comfort_tbl1_335293174
*
* @param Humidex index value
* @param humidex index value
* @return scale between 0 and 4
*/
public static int humidexScale(double humidex) {