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

8
bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/config/OAuthAuthorizationHandler.java
View File

@@ -42,7 +42,8 @@ public interface OAuthAuthorizationHandler {
* service.
* @return The authorization URL to which the user is redirected for the log in.
* @throws NoOngoingAuthorizationException if there is no ongoing authorization.
* @throws OAuthException if the authorization URL cannot be determined. In this case the ongoing authorization is
* @throws org.openhab.core.auth.client.oauth2.OAuthException if the authorization URL cannot be determined. In this
* case the ongoing authorization is
* cancelled.
*/
String getAuthorizationUrl(String redirectUri);
@@ -65,7 +66,8 @@ public interface OAuthAuthorizationHandler {
* @param redirectUrlWithParameters The URL the remote service redirected the user to. This is the URL our servlet
* was called with.
* @throws NoOngoingAuthorizationException if there is no ongoing authorization.
* @throws OAuthException if the authorization failed. In this case the ongoing authorization is cancelled.
* @throws org.openhab.core.auth.client.oauth2.OAuthException if the authorization failed. In this case the ongoing
* authorization is cancelled.
*/
void completeAuthorization(String redirectUrlWithParameters);
@@ -74,7 +76,7 @@ public interface OAuthAuthorizationHandler {
*
* @param email E-mail address for which the access token is requested.
* @return The access token.
* @throws OAuthException if the access token cannot be obtained.
* @throws org.openhab.core.auth.client.oauth2.OAuthException if the access token cannot be obtained.
*/
String getAccessToken(String email);
}

2
bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/handler/AbstractMieleThingHandler.java
View File

@@ -282,7 +282,7 @@ public abstract class AbstractMieleThingHandler extends BaseThingHandler {
/**
* Updates the device action state channels.
*
* @param action The {@link ActionsChannelState} information to update the action channel states with.
* @param actions The {@link ActionsChannelState} information to update the action channel states with.
*/
protected abstract void updateActionState(ActionsChannelState actions);
}

2
bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/webservice/DeviceStateListener.java
View File

@@ -33,7 +33,7 @@ public interface DeviceStateListener {
/**
* Invoked when a new process action is available for a device.
*
* @param ActionsState The action state information.
* @param actionState The action state information.
*/
void onProcessActionUpdated(ActionsState actionState);

2
bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/webservice/MieleWebservice.java
View File

@@ -92,7 +92,7 @@ public interface MieleWebservice extends AutoCloseable {
* Performs a PUT operation setting the active program.
*
* @param deviceId ID of the device to trigger the action for.
* @param program The program to activate.
* @param programId The program to activate.
* @throws MieleWebserviceException if an error occurs during webservice requests or content parsing.
* @throws AuthorizationFailedException if the authorization against the webservice failed.
* @throws TooManyRequestsException if too many requests have been made against the webservice recently.

2
bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/webservice/api/json/ProcessAction.java
View File

@@ -24,7 +24,7 @@ import com.google.gson.annotations.SerializedName;
@NonNullByDefault
public enum ProcessAction {
/**
* {@StateType} for unknown states.
* {@link StateType} for unknown states.
*/
UNKNOWN,