Improve javadoc for all addons (#15667)

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

View File

@@ -15,7 +15,7 @@ package org.openhab.binding.modbus;
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
* The {@link ModbusBinding} class defines some constants
* The {@link ModbusBindingConstants} class defines some constants
* public that might be used from other bundles as well.
*
* @author Sami Salonen - Initial contribution

View File

@@ -135,7 +135,7 @@ public class ModbusDiscoveryService extends AbstractDiscoveryService {
* Running bridges have a ModbusThingHandlerDiscoveryService connected
* which will be responsible for the discovery
*
* @param handler the Modbus bridge handler
* @param service discovery service
*/
@Reference(cardinality = ReferenceCardinality.MULTIPLE, policy = ReferencePolicy.DYNAMIC)
protected void addModbusEndpoint(ModbusThingHandlerDiscoveryService service) {
@@ -146,7 +146,7 @@ public class ModbusDiscoveryService extends AbstractDiscoveryService {
/**
* Remove an already registered thing handler discovery component
*
* @param handler the handler that has been removed
* @param service discovery service
*/
protected void removeModbusEndpoint(ModbusThingHandlerDiscoveryService service) {
logger.trace("Removed handler: {}", service);

View File

@@ -98,8 +98,8 @@ public abstract class BaseModbusThingHandler extends BaseThingHandler {
* @param request request to send
* @param pollPeriodMillis poll interval, in milliseconds
* @param initialDelayMillis initial delay before starting polling, in milliseconds
* @param callback callback to call with data
* @param callback callback to call in case of failure
* @param resultCallback callback to call with data
* @param failureCallback callback to call in case of failure
* @return poll task representing the regular poll
* @throws IllegalStateException when this communication has been closed already
*/
@@ -133,8 +133,8 @@ public abstract class BaseModbusThingHandler extends BaseThingHandler {
* background.
*
* @param request request to send
* @param callback callback to call with data
* @param callback callback to call in case of failure
* @param resultCallback callback to call with data
* @param failureCallback callback to call in case of failure
* @return future representing the polled task
* @throws IllegalStateException when this communication has been closed already
*/
@@ -152,8 +152,8 @@ public abstract class BaseModbusThingHandler extends BaseThingHandler {
* background.
*
* @param request request to send
* @param callback callback to call with response
* @param callback callback to call in case of failure
* @param resultCallback callback to call with response
* @param failureCallback callback to call in case of failure
* @return future representing the task
* @throws IllegalStateException when this communication has been closed already
*/

View File

@@ -22,7 +22,7 @@ import org.openhab.core.io.transport.modbus.ModbusReadFunctionCode;
import org.openhab.core.thing.ThingTypeUID;
/**
* The {@link ModbusBinding} class defines common constants, which are
* The {@link ModbusBindingConstantsInternal} class defines common constants, which are
* used across the whole binding.
*
* @author Sami Salonen - Initial contribution

View File

@@ -38,7 +38,7 @@ public interface ValueTransformation {
*
* @param context
* @param types types to used to parse the transformation result
* @param command
* @param state
* @return Transformed command, or null if no transformation was possible
*/
default @Nullable State transformState(BundleContext context, List<Class<? extends State>> types, State state) {