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

@@ -44,7 +44,7 @@ public interface ChannelStateUpdateListener {
* The channel is of kind Trigger.
*
* @param channelUID The channel uid
* @param value The new value. Doesn't necessarily need to be different than the value before.
* @param eventPayload The new value. Doesn't necessarily need to be different than the value before.
*/
void triggerChannel(ChannelUID channelUID, String eventPayload);
}

View File

@@ -41,7 +41,7 @@ import org.slf4j.LoggerFactory;
* To automatically subscribe to all fields, a call to
* {@link #subscribeAndReceive(MqttBrokerConnection, ScheduledExecutorService, String, AttributeChanged, int)} is
* required.
* Unsubscribe with a call to {@link #unsubscribe(AbstractMqttAttributeClass)}.
* Unsubscribe with a call to {@link #unsubscribe()}.
* </p>
*
* <p>
@@ -134,8 +134,6 @@ public abstract class AbstractMqttAttributeClass implements SubscribeFieldToMQTT
/**
* Unsubscribe from all topics of the managed object.
*
* @param connection A broker connection to remove the subscriptions from.
* @param objectWithFields A bean class
* @return Returns a future that completes as soon as all unsubscriptions have been performed.
*/
public CompletableFuture<@Nullable Void> unsubscribe() {

View File

@@ -67,7 +67,6 @@ public class ChildMap<T> {
/**
* Modifies the map in way that it matches the entries of the given childIDs.
*
* @param future A future that completes as soon as all children have their added-action performed.
* @param childIDs The list of IDs that should be in the map. Everything else currently in the map will be removed.
* @param addedAction A function where the newly added child is given as an argument to perform any actions on it.
* A future is expected as a return value that completes as soon as said action is performed.
@@ -75,7 +74,7 @@ public class ChildMap<T> {
* expected as a
* result.
* @param removedCallback A callback, that is called whenever a child got removed by the
* {@link #apply(CompletableFuture, String[], Function)} method.
* {@link #apply(String[], Function, Function, Consumer)} method.
* @return Complete successfully if all "addedAction" complete successfully, otherwise complete exceptionally.
*/
public CompletableFuture<@Nullable Void> apply(String[] childIDs,