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

@@ -244,7 +244,9 @@ public class WebInterface implements AtomicReferenceTrait {
/**
* Constructor to set up interface
*
* @param config Bridge configuration
* @param scheduler
* @param handler
* @param httpClient
*/
public WebInterface(ScheduledExecutorService scheduler, SolarEdgeHandler handler, HttpClient httpClient) {
this.config = handler.getConfiguration();

View File

@@ -32,8 +32,9 @@ import org.openhab.core.types.State;
@NonNullByDefault
public interface SolarEdgeHandler extends ThingHandler, ChannelProvider {
/**
* Called from {@link WebInterface#authenticate()} to update
* the thing status because updateStatus is protected.
* Called from
* {@link org.openhab.binding.solaredge.internal.connector.WebInterface.WebRequestExecutor#authenticate()}
* to update the thing status because updateStatus is protected.
*
* @param status Bridge status
* @param statusDetail Bridge status detail

View File

@@ -126,7 +126,7 @@ abstract class AbstractDataResponseTransformer {
* @param targetMap result will be put into this map
* @param channel channel to assign the value
* @param value the value to convert
* @param unit as string
* @param unitAsString unit as string
*/
protected final void putPowerType(Map<Channel, State> targetMap, @Nullable Channel channel, @Nullable Double value,
@Nullable String unitAsString) {
@@ -143,7 +143,7 @@ abstract class AbstractDataResponseTransformer {
* @param targetMap result will be put into this map
* @param channel channel to assign the value
* @param value the value to convert
* @param unit as string
* @param unitAsString as string
*/
protected final void putEnergyType(Map<Channel, State> targetMap, @Nullable Channel channel, @Nullable Double value,
@Nullable String unitAsString) {