public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve javadoc for some addons (#15701)

Browse Source 
Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
This commit is contained in:
Holger Friedrich
2023-10-08 00:25:04 +02:00
committed by GitHub
parent f8bcfb0c7e
commit f24a4305b8
275 changed files with 547 additions and 406 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/account/SmartherAccountHandler.java
View File

@@ -71,7 +71,7 @@ public interface SmartherAccountHandler extends ThingHandler {
*
* @return the list of registered plants, or an empty {@link List} in case of no plants found
*
* @throws {@link SmartherGatewayException}
* @throws SmartherGatewayException
* in case of communication issues with the Smarther API
*/
List<Plant> getPlants() throws SmartherGatewayException;

2
bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/model/ModuleSettings.java
View File

@@ -79,7 +79,7 @@ public class ModuleSettings {
* @param chronothermostat
* the chronothermostat dto to get data from
*
* @throws {@link SmartherIllegalPropertyValueException}
* @throws SmartherIllegalPropertyValueException
* if at least one of the module properties cannot be mapped to any valid enum value
*/
public void updateFromChronothermostat(Chronothermostat chronothermostat)

8
bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/util/DateUtil.java
View File

@@ -116,7 +116,7 @@ public final class DateUtil {
*
* @return a string representing the local date and time object
*
* @throws DateTimeException if an error occurs during printing
* @throws DateTimeParseException if an error occurs during printing
*/
public static String format(LocalDateTime date, String pattern) {
DateTimeFormatter dtf = DateTimeFormatter.ofPattern(pattern);
@@ -133,7 +133,7 @@ public final class DateUtil {
*
* @return a string representing the date and time with timezone object
*
* @throws DateTimeException if an error occurs during printing
* @throws DateTimeParseException if an error occurs during printing
*/
public static String format(ZonedDateTime date, String pattern) {
DateTimeFormatter dtf = DateTimeFormatter.ofPattern(pattern);
@@ -153,7 +153,7 @@ public final class DateUtil {
*
* @return a string representing the range between the two local date and time objects
*
* @throws DateTimeException if an error occurs during printing
* @throws DateTimeParseException if an error occurs during printing
*/
public static String formatRange(LocalDateTime date1, LocalDateTime date2, String pattern) {
DateTimeFormatter dtf = DateTimeFormatter.ofPattern(pattern);
@@ -174,7 +174,7 @@ public final class DateUtil {
*
* @return a string representing the range between the two date and time with timezone objects
*
* @throws DateTimeException if an error occurs during printing
* @throws DateTimeParseException if an error occurs during printing
*/
public static String formatRange(ZonedDateTime date1, ZonedDateTime date2, String pattern) {
DateTimeFormatter dtf = DateTimeFormatter.ofPattern(pattern);