public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve javadoc for some addons (#15701)

Browse Source 
Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
This commit is contained in:
Holger Friedrich
2023-10-08 00:25:04 +02:00
committed by GitHub
parent f8bcfb0c7e
commit f24a4305b8
275 changed files with 547 additions and 406 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/dto/clip2/Resource.java
View File

@@ -203,7 +203,7 @@ public class Resource {
/**
* Get the color as an HSBType. This returns an HSB that is based on an amalgamation of the color xy, dimming, and
* on/off JSON elements. It takes its 'H' & 'S' parts from the 'ColorXy' JSON element, and its 'B' part from the
* on/off JSON elements. It takes its 'H' and 'S' parts from the 'ColorXy' JSON element, and its 'B' part from the
* on/off resp. dimming JSON elements. If off the B part is 0, otherwise it is the dimming element value. Note: this
* method is only to be used on cached state DTOs which already have a defined color gamut.
*

2
bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/dto/clip2/ResourceReference.java
View File

@@ -20,7 +20,7 @@ import org.openhab.binding.hue.internal.dto.clip2.enums.ResourceType;
* DTO that contains an API reference element.
*
* The V2 API is set up in such a way that all resources of the same type are grouped together under the
* /resource/<resourcetype> endpoint, but all those resources commonly reference each other, which is done in a
* {@code /resource/<resourcetype>} endpoint, but all those resources commonly reference each other, which is done in a
* standardized way by indicating the resource type (rtype) and resource id (rid).
*
* A typical usage is in a single physical device that hosts multiple services. An existing example is the Philips Hue

3
bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/dto/clip2/helper/Setters.java
View File

@@ -80,7 +80,8 @@ public class Setters {
* (if any).
*
* @param target the target resource.
* @param command the new state command should be a QuantityType<Temperature> (but it can also handle DecimalType).
* @param command the new state command should be a {@code QuantityType<Temperature>} (but it can also handle
* {@code DecimalType}).
* @param source another resource containing the MirekSchema.
*
* @return the target resource.

2
bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/Clip2ThingHandler.java
View File

@@ -1091,7 +1091,7 @@ public class Clip2ThingHandler extends BaseThingHandler {
}
/**
* Fetch the full list of scenes from the bridge, and call updateSceneContributors(List<Resource> allScenes)
* Fetch the full list of scenes from the bridge, and call {@code updateSceneContributors(List<Resource> allScenes)}
*
* @throws ApiException if a communication error occurred.
* @throws AssetNotLoadedException if one of the assets is not loaded.