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

@@ -45,7 +45,7 @@ import org.slf4j.LoggerFactory;
* handlers.
*
* @author Markus Katter - Initial contribution
* @contributer Jan Vybíral - Improved thing id generation
* @author Jan Vybíral - Improved thing id generation
*/
@Component(service = ThingHandlerFactory.class, configurationPid = "binding.nuki")
@NonNullByDefault

6
bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/constants/NukiBindingConstants.java
View File

@@ -20,12 +20,12 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
import org.openhab.core.thing.ThingTypeUID;
/**
* The {@link NukiBinding} class defines common constants, which are
* The {@link NukiBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Markus Katter - Initial contribution
* @contributer Christian Hoefler - Door sensor integration
* @contributer Jan Vybíral - Opener integration
* @author Christian Hoefler - Door sensor integration
* @author Jan Vybíral - Opener integration
*/
@NonNullByDefault
public class NukiBindingConstants {

2
bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dataexchange/BridgeLockStateResponse.java
View File

@@ -18,7 +18,7 @@ import org.openhab.binding.nuki.internal.dto.BridgeApiLockStateDto;
* The {@link BridgeLockStateResponse} class wraps {@link BridgeApiLockStateDto} class.
*
* @author Markus Katter - Initial contribution
* @contributer Christian Hoefler - Door sensor integration
* @author Christian Hoefler - Door sensor integration
*/
public class BridgeLockStateResponse extends NukiBaseResponse {

4
bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dataexchange/NukiApiServlet.java
View File

@@ -46,8 +46,8 @@ import com.google.gson.Gson;
* The {@link NukiApiServlet} class is responsible for handling the callbacks from the Nuki Bridge.
*
* @author Markus Katter - Initial contribution
* @contributer Christian Hoefler - Door sensor integration
* @contributer Jan Vybíral - Added Opener support, improved callback handling
* @author Christian Hoefler - Door sensor integration
* @author Jan Vybíral - Added Opener support, improved callback handling
*/
@NonNullByDefault
public class NukiApiServlet extends HttpServlet {

2
bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dataexchange/NukiHttpClient.java
View File

@@ -44,7 +44,7 @@ import com.google.gson.Gson;
* The {@link NukiHttpClient} class is responsible for getting data from the Nuki Bridge.
*
* @author Markus Katter - Initial contribution
* @contributer Jan Vybíral - Hashed token authentication
* @author Jan Vybíral - Hashed token authentication
*/
@NonNullByDefault
public class NukiHttpClient {

2
bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dto/BridgeApiLockStateDto.java
View File

@@ -17,7 +17,7 @@ package org.openhab.binding.nuki.internal.dto;
* endpoint.
*
* @author Markus Katter - Initial contribution
* @contributer Christian Hoefler - Door sensor integration
* @author Christian Hoefler - Door sensor integration
*/
public class BridgeApiLockStateDto extends BridgeApiDeviceStateDto {
private boolean success;

2
bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dto/BridgeApiLockStateRequestDto.java
View File

@@ -17,7 +17,7 @@ package org.openhab.binding.nuki.internal.dto;
* Bridge to the openHAB Server.
*
* @author Markus Katter - Initial contribution
* @contributer Christian Hoefler - Door sensor integration
* @author Christian Hoefler - Door sensor integration
*/
public class BridgeApiLockStateRequestDto extends BridgeApiDeviceStateDto {

2
bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/handler/NukiBridgeHandler.java
View File

@@ -53,7 +53,7 @@ import org.slf4j.LoggerFactory;
* sent to one of the channels.
*
* @author Markus Katter - Initial contribution
* @contributer Jan Vybíral - Improved callback handling
* @author Jan Vybíral - Improved callback handling
*/
@NonNullByDefault
public class NukiBridgeHandler extends BaseBridgeHandler {

4
bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/handler/NukiSmartLockHandler.java
View File

@@ -29,8 +29,8 @@ import org.openhab.core.types.Command;
* sent to one of the channels.
*
* @author Markus Katter - Initial contribution
* @contributer Christian Hoefler - Door sensor integration
* @contributer Jan Vybíral - Refactoring, added more channels
* @author Christian Hoefler - Door sensor integration
* @author Jan Vybíral - Refactoring, added more channels
*/
@NonNullByDefault
public class NukiSmartLockHandler extends AbstractNukiDeviceHandler<NukiSmartLockConfiguration> {