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

Improve javadoc for all addons (#15667)

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

7
bundles/org.openhab.binding.konnected/src/main/java/org/openhab/binding/konnected/internal/KonnectedConfiguration.java
View File

@@ -22,9 +22,12 @@ import org.openhab.core.config.core.Configuration;
public class KonnectedConfiguration extends Configuration {
/**
* @param blink identifies whether the Konnected Alarm Panel LED will blink on transmission of Wifi Commands
* @param discovery identifies whether the Konnected Alarm Panel will be discoverable via UPnP
* blink identifies whether the Konnected Alarm Panel LED will blink on transmission of Wifi Commands.
*/
public boolean blink;
/**
* discovery identifies whether the Konnected Alarm Panel will be discoverable via UPnP.
*/
public boolean discovery;
}

4
bundles/org.openhab.binding.konnected/src/main/java/org/openhab/binding/konnected/internal/KonnectedHTTPUtils.java
View File

@@ -96,7 +96,7 @@ public class KonnectedHTTPUtils {
*
* @param urlAddress the address to send the request
* @param payload the json payload you want to send as part of the request, may be null.
* @param retry the number of retries before throwing the IOexpcetion back to the handler
* @param retryCount the number of retries before throwing the IOexpcetion back to the handler
*/
public synchronized String doGet(String urlAddress, String payload, int retryCount)
throws KonnectedHttpRetryExceeded {
@@ -126,7 +126,7 @@ public class KonnectedHTTPUtils {
*
* @param urlAddress the address to send the request
* @param payload the json payload you want to send as part of the request
* @param retry the number of retries before throwing the IOexpcetion back to the handler
* @param retryCount the number of retries before throwing the IOexpcetion back to the handler
*/
public synchronized String doPut(String urlAddress, String payload, int retryCount)
throws KonnectedHttpRetryExceeded {

2
bundles/org.openhab.binding.konnected/src/main/java/org/openhab/binding/konnected/internal/ZoneConfiguration.java
View File

@@ -18,7 +18,7 @@ import org.eclipse.jdt.annotation.Nullable;
/**
* The {@link ZoneConfiguration} class contains the configuration parameters for the zone.
*
* @author Haavar Valeur
* @author Haavar Valeur - Initial contribution
*/
@NonNullByDefault
public class ZoneConfiguration {

5
bundles/org.openhab.binding.konnected/src/main/java/org/openhab/binding/konnected/internal/handler/KonnectedHandler.java
View File

@@ -65,10 +65,7 @@ public class KonnectedHandler extends BaseThingHandler {
* This is the constructor of the Konnected Handler.
*
* @param thing the instance of the Konnected thing
* @param webHookServlet the instance of the callback servlet that is running for communication with the Konnected
* Module
* @param hostAddress the webaddress of the openHAB server instance obtained by the runtime
* @param port the port on which the openHAB instance is running that was obtained by the runtime.
* @param callbackUrl the webaddress of the openHAB server instance obtained by the runtime
*/
public KonnectedHandler(Thing thing, String callbackUrl) {
super(thing);