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

4
bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/api/TapoDeviceConnector.java
View File

@@ -194,7 +194,7 @@ public class TapoDeviceConnector extends TapoDeviceHttpApi {
/**
* send multiple "set_device_info" commands to device
*
* @param map HashMap<String, Object> (name, value of parameter)
* @param map {@code HashMap<String, Object> (name, value of parameter)}
*/
public void sendDeviceCommands(HashMap<String, Object> map) {
sendDeviceCommands(DEVICE_CMD_SETINFO, map);
@@ -204,7 +204,7 @@ public class TapoDeviceConnector extends TapoDeviceHttpApi {
* send multiple commands to device
*
* @param method Method command belongs to
* @param map HashMap<String, Object> (name, value of parameter)
* @param map {@code HashMap<String, Object> (name, value of parameter)}
*/
public void sendDeviceCommands(String method, HashMap<String, Object> map) {
long now = System.currentTimeMillis();

2
bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoBridgeHandler.java
View File

@@ -177,7 +177,7 @@ public class TapoBridgeHandler extends BaseBridgeHandler {
/**
* Stop scheduler
*
* @param scheduler ScheduledFeature<?> which schould be stopped
* @param scheduler {@code ScheduledFeature<?>} which schould be stopped
*/
protected void stopScheduler(@Nullable ScheduledFuture<?> scheduler) {
if (scheduler != null) {

2
bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoDevice.java
View File

@@ -206,7 +206,7 @@ public abstract class TapoDevice extends BaseThingHandler {
/**
* Stop scheduler
*
* @param scheduler ScheduledFeature<?> which schould be stopped
* @param scheduler {@code ScheduledFeature<?>} which schould be stopped
*/
protected void stopScheduler(@Nullable ScheduledFuture<?> scheduler) {
if (scheduler != null) {

12
bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoUtils.java
View File

@@ -340,8 +340,8 @@ public class TapoUtils {
* Return QuantityType with Time
*
* @param numVal Number with value
* @param unit TimeUnit (Unit<Time>)
* @return QuantityType<Time>
* @param unit TimeUnit ({@code Unit<Time>})
* @return {@code QuantityType<Time>}
*/
public static QuantityType<Time> getTimeType(@Nullable Number numVal, Unit<Time> unit) {
return new QuantityType<>((numVal != null ? numVal : 0), unit);
@@ -351,8 +351,8 @@ public class TapoUtils {
* Return QuantityType with Power
*
* @param numVal Number with value
* @param unit PowerUnit (Unit<Power>)
* @return QuantityType<Power>
* @param unit PowerUnit ({@code Unit<Power>})
* @return {@code QuantityType<Power>}
*/
public static QuantityType<Power> getPowerType(@Nullable Number numVal, Unit<Power> unit) {
return new QuantityType<>((numVal != null ? numVal : 0), unit);
@@ -362,8 +362,8 @@ public class TapoUtils {
* Return QuantityType with Energy
*
* @param numVal Number with value
* @param unit PowerUnit (Unit<Power>)
* @return QuantityType<Energy>
* @param unit PowerUnit ({@code Unit<Power>})
* @return {@code QuantityType<Energy>}
*/
public static QuantityType<Energy> getEnergyType(@Nullable Number numVal, Unit<Energy> unit) {
return new QuantityType<>((numVal != null ? numVal : 0), unit);

2
bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/structures/TapoSubRequest.java
View File

@@ -21,7 +21,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
import com.google.gson.annotations.SerializedName;
/**
* {@TapoSubRequest} holds data sent to device in order to act on a child
* {@link TapoSubRequest} holds data sent to device in order to act on a child
*
* @author Gaël L'hopital - Initial contribution
*/