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.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/BindingConstants.java
View File

@@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
import org.openhab.core.thing.ThingTypeUID;
/**
* The {@link OJElectronicsBindingConstants} class defines common constants, which are
* The {@link BindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Christian Kittel - Initial contribution

4
bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/ThermostatHandlerFactory.java
View File

@@ -29,7 +29,7 @@ import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
/**
* The {@link ThermostatHandlerFactory} is responsible for creating {@link OJElectronicsThermostatHandler}.
* The {@link ThermostatHandlerFactory} is responsible for creating {@link ThermostatHandler}.
*
* @author Christian Kittel - Initial contribution
*/
@@ -43,7 +43,7 @@ public class ThermostatHandlerFactory extends BaseThingHandlerFactory {
/**
* Creates a new factory
*
* @param httpClientFactory Factory for HttpClient
* @param timeZoneProvider
*/
@Activate
public ThermostatHandlerFactory(@Reference TimeZoneProvider timeZoneProvider) {

2
bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/common/OJGSonBuilder.java
View File

@@ -29,7 +29,7 @@ public final class OJGSonBuilder {
/**
* Gets a correct initialized {@link Gson}
*
* @return {@link GSon}
* @return {@link com.google.gson.GSon}
*/
public static Gson getGSon() {
return new GsonBuilder().setFieldNamingPolicy(FieldNamingPolicy.UPPER_CAMEL_CASE).setPrettyPrinting()

2
bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/config/OJElectronicsBridgeConfiguration.java
View File

@@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
/**
* The configuration for {@link org.openhab.binding.ojelectronics.internal.OJElectronicsCloudHandler}
* The configuration for {@link org.openhab.binding.ojelectronics.internal.OJCloudHandler}
*
* @author Christian Kittel - Initial contribution
*/

2
bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/config/OJElectronicsThermostatConfiguration.java
View File

@@ -15,7 +15,7 @@ package org.openhab.binding.ojelectronics.internal.config;
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
* The configuration for {@link org.openhab.binding.ojelectronics.internal.OJElectronicsThermostatHandler}
* The configuration for {@link org.openhab.binding.ojelectronics.internal.ThermostatHandler}
*
* @author Christian Kittel - Initial contribution
*/

3
bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/services/RefreshService.java
View File

@@ -65,7 +65,6 @@ public final class RefreshService implements AutoCloseable {
*
* @param config Configuration of the bridge
* @param httpClient HTTP client
* @param updateService Service to update the thermostat in the cloud
*/
public RefreshService(OJElectronicsBridgeConfiguration config, HttpClient httpClient) {
this.config = config;
@@ -78,7 +77,7 @@ public final class RefreshService implements AutoCloseable {
*
* @param sessionId Session-Id
* @param refreshDone This method is called if refreshing is done.
* @param connectionLosed This method is called if no connection could established.
* @param connectionLost This method is called if no connection could established.
* @param unauthorized This method is called if the result is unauthorized.
*/
public void start(String sessionId,