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

2
bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/RadioThermostatBindingConstants.java
View File

@@ -25,7 +25,7 @@ import org.openhab.core.library.unit.Units;
import org.openhab.core.thing.ThingTypeUID;
/**
* The {@link RadioThermostatBinding} class defines common constants, which are
* The {@link RadioThermostatBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Michael Lobstein - Initial contribution

16
bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/communication/RadioThermostatConnector.java
View File

@@ -81,7 +81,7 @@ public class RadioThermostatConnector {
* Send an asynchronous http call to the thermostat, the response will be send to the
* event listeners as a RadioThermostat event when it is finally received
*
* @param resouce the url of the json resource on the thermostat
* @param resource the url of the json resource on the thermostat
*/
public void getAsyncThermostatData(String resource) {
httpClient.newRequest(buildRequestURL(resource)).method(GET).timeout(30, TimeUnit.SECONDS)
@@ -100,9 +100,9 @@ public class RadioThermostatConnector {
/**
* Sends a command to the thermostat
*
* @param the JSON attribute key for the value to be updated
* @param the value to be updated in the thermostat
* @param the end point URI to use for the command
* @param cmdKey the JSON attribute key for the value to be updated
* @param cmdVal the value to be updated in the thermostat
* @param resource the end point URI to use for the command
* @return the JSON response string from the thermostat
*/
public String sendCommand(String cmdKey, @Nullable String cmdVal, String resource) {
@@ -112,10 +112,10 @@ public class RadioThermostatConnector {
/**
* Sends a command to the thermostat
*
* @param the JSON attribute key for the value to be updated
* @param the value to be updated in the thermostat
* @param JSON string to send directly to the thermostat instead of a key/value pair
* @param the end point URI to use for the command
* @param cmdKey the JSON attribute key for the value to be updated
* @param cmdVal the value to be updated in the thermostat
* @param cmdJson JSON string to send directly to the thermostat instead of a key/value pair
* @param resource the end point URI to use for the command
* @return the JSON response string from the thermostat
*/
public String sendCommand(@Nullable String cmdKey, @Nullable String cmdVal, @Nullable String cmdJson,

7
bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/discovery/RadioThermostatDiscoveryService.java
View File

@@ -191,12 +191,7 @@ public class RadioThermostatDiscoveryService extends AbstractDiscoveryService {
* Scans all messages that arrive on the socket and scans them for the
* search keywords. The search is not case sensitive.
*
* @param socket
* The socket where the answers arrive.
* @param keywords
* The keywords to be searched for.
* @return
* @throws IOException
* @param response
*/
protected void parseResponse(String response) {

2
bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/handler/RadioThermostatHandler.java
View File

@@ -508,7 +508,7 @@ public class RadioThermostatHandler extends BaseThingHandler implements RadioThe
/**
* Update a given channelId from the thermostat data
*
* @param the channel id to be updated
* @param channelId the channel id to be updated
* @param data the RadioThermostat dto
* @return the value to be set in the state
*/