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

8
bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/BoschSHCHandler.java
View File

@@ -113,8 +113,7 @@ public abstract class BoschSHCHandler extends BaseThingHandler {
public abstract @Nullable String getBoschID();
/**
* Initializes this handler. Use this method to register all services of the device with
* {@link #registerService(TService, Consumer<TState>, Collection<String>, boolean)}.
* Initializes this handler.
*/
@Override
public void initialize() {
@@ -165,7 +164,8 @@ public abstract class BoschSHCHandler extends BaseThingHandler {
}
/**
* Should be used by handlers to create their required services.
* Use this method to register all services of the device with
* {@link #registerService(BoschSHCService, Consumer, Collection, boolean)}.
*/
protected void initializeServices() throws BoschSHCException {
}
@@ -193,7 +193,7 @@ public abstract class BoschSHCHandler extends BaseThingHandler {
/**
* Query the Bosch Smart Home Controller for the state of the service with the specified name.
*
* @note Use services instead of directly requesting a state.
* @implNote Use services instead of directly requesting a state.
*
* @param stateName Name of the service to query
* @param classOfT Class to convert the resulting JSON to

2
bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/bridge/BoschHttpClient.java
View File

@@ -44,7 +44,7 @@ import org.slf4j.LoggerFactory;
import com.google.gson.JsonSyntaxException;
/**
* HTTP client using own context with private & Bosch Certs
* HTTP client using own context with private and Bosch Certs
* to pair and connect to the Bosch Smart Home Controller.
*
* @author Gerd Zanker - Initial contribution