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,8 +15,10 @@ package org.openhab.binding.boschindego.internal;
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
* {@link} AuthorizationListener} is used for notifying {@link BoschAccountHandler}
* when authorization state has changed and for notifying {@link BoschIndegoHandler}
* {@link AuthorizationListener} is used for notifying
* {@link org.openhab.binding.boschindego.internal.handler.BoschAccountHandler}
* when authorization state has changed and for notifying
* {@link org.openhab.binding.boschindego.internal.handler.BoschIndegoHandler}
* when authorization flow is completed.
*
* @author Jacob Laursen - Initial contribution

View File

@@ -18,7 +18,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
import org.openhab.core.thing.ThingTypeUID;
/**
* The {@link BoschIndegoBinding} class defines common constants, which are
* The {@link BoschIndegoBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Jonas Fleck - Initial contribution

View File

@@ -261,7 +261,8 @@ public class IndegoController {
/**
* Sends a PUT/POST request to the server.
*
* @param method the type of request ({@link HttpMethod.PUT} or {@link HttpMethod.POST})
* @param method the type of request ({@link org.eclipse.jetty.http.HttpMethod.PUT} or
* {@link org.eclipse.jetty.http.HttpMethod.POST})
* @param path the relative path to which the request should be sent
* @param requestDto the DTO which should be sent to the server as JSON
* @throws IndegoAuthenticationException if request was rejected as unauthorized

View File

@@ -14,7 +14,8 @@
package org.openhab.binding.boschindego.internal.dto.response.runtime;
/**
* Total/session runtime information for {@link DeviceStateResponse}
* Total/session runtime information for
* {@link org.openhab.binding.boschindego.internal.dto.response.DeviceStateResponse}
*
* @author Jacob Laursen - Initial contribution
*/