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

@@ -98,9 +98,11 @@ import com.google.gson.JsonSyntaxException;
*
* It uses the following connection mechanisms:
*
* <ul>
* <li>The primary communication uses HTTP 2 streams over a shared permanent HTTP 2 session.</li>
* <li>The 'registerApplicationKey()' method uses HTTP/1.1 over the OH common Jetty client.</li>
* <li>The 'isClip2Supported()' static method uses HTTP/1.1 over the OH common Jetty client via 'HttpUtil'.</li>
* </ul>
*
* @author Andrew Fiddian-Green - Initial Contribution
*/

View File

@@ -43,7 +43,7 @@ import org.slf4j.LoggerFactory;
/**
* The {@link HueBridgeMDNSDiscoveryParticipant} is responsible for discovering new and removed Hue Bridges. It uses the
* central MDNSDiscoveryService.
* central {@link org.openhab.core.config.discovery.mdns.internal.MDNSDiscoveryService}.
*
* @author Kai Kreuzer - Initial contribution
* @author Thomas Höfer - Added representation

View File

@@ -51,7 +51,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* The {@link HueBridgeServiceTracker} tracks for Hue lights, sensors and groups which are connected
* The {@link HueDeviceDiscoveryService} tracks for Hue lights, sensors and groups which are connected
* to a paired Hue Bridge. The default search time for Hue is 60 seconds.
*
* @author Kai Kreuzer - Initial contribution

View File

@@ -62,7 +62,7 @@ public interface GroupStatusListener {
/**
* This method is called whenever the list of available scenes is updated.
*
* @param updatedScenes available scenes
* @param scenes available scenes
*/
void onScenesUpdated(List<Scene> scenes);
}

View File

@@ -799,7 +799,6 @@ public class HueBridgeHandler extends ConfigStatusBridgeHandler implements HueCl
* If there is a user name available, it attempts to re-authenticate. Otherwise new authentication credentials will
* be requested from the bridge.
*
* @param bridge the Hue Bridge the connection is not authorized
* @return returns {@code true} if re-authentication was successful, {@code false} otherwise
*/
public boolean onNotAuthenticated() {

View File

@@ -320,7 +320,6 @@ public abstract class HueSensorHandler extends BaseThingHandler implements Senso
* Handles the sensor change. Implementation should also update sensor-specific configuration that changed since the
* last update.
*
* @param bridge the bridge
* @param sensor the sensor
* @param config the configuration in which to update the config states of the sensor
*/

View File

@@ -294,7 +294,7 @@ public class LightStateConverter {
* <li>{@value #ALERT_MODE_NONE}.
* <li>{@value #ALERT_MODE_SELECT}.
* <li>{@value #ALERT_MODE_LONG_SELECT}.
* <ul>
* </ul>
* @return light state containing the {@link AlertMode} or <b><code>null </code></b> if the provided
* {@link StringType} represents unsupported mode.
*/