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

10
bundles/org.openhab.binding.windcentrale/src/main/java/org/openhab/binding/windcentrale/internal/api/AuthenticationHelper.java
View File

@@ -55,9 +55,13 @@ import org.slf4j.LoggerFactory;
* Helps with authenticating users to Amazon Cognito to get a JWT access token which can be used for retrieving
* information using the REST APIs.
*
* @see https://en.wikipedia.org/wiki/Secure_Remote_Password_protocol
* @see https://stackoverflow.com/questions/67528443/cognito-srp-using-aws-java-sdk-v2-x
* @see https://github.com/aws-samples/aws-cognito-java-desktop-app/blob/master/src/main/java/com/amazonaws/sample/cognitoui/AuthenticationHelper.java
* @see <a href="https://en.wikipedia.org/wiki/Secure_Remote_Password_protocol">
* https://en.wikipedia.org/wiki/Secure_Remote_Password_protocol</a>
* @see <a href="https://stackoverflow.com/questions/67528443/cognito-srp-using-aws-java-sdk-v2-x">
* https://stackoverflow.com/questions/67528443/cognito-srp-using-aws-java-sdk-v2-x</a>
* @see <a href=
* "https://github.com/aws-samples/aws-cognito-java-desktop-app/blob/master/src/main/java/com/amazonaws/sample/cognitoui/AuthenticationHelper.java">
* https://github.com/aws-samples/aws-cognito-java-desktop-app/blob/master/src/main/java/com/amazonaws/sample/cognitoui/AuthenticationHelper.java</a>
*
* @author Wouter Born - Initial contribution
*/

3
bundles/org.openhab.binding.windcentrale/src/main/java/org/openhab/binding/windcentrale/internal/dto/KeyResponse.java
View File

@@ -17,7 +17,8 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
/**
* Provides the details required for getting tokens using SRP from the Windcentrale Cognito user pool.
*
* @see https://mijn.windcentrale.nl/api/v0/labels/key?domain=mijn.windcentrale.nl
* @see <a href="https://mijn.windcentrale.nl/api/v0/labels/key?domain=mijn.windcentrale.nl">
* https://mijn.windcentrale.nl/api/v0/labels/key?domain=mijn.windcentrale.nl</a>
*
* @author Wouter Born - Initial contribution
*/