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

8
bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/RioPresetsProtocol.java
View File

@@ -194,7 +194,7 @@ public class RioPresetsProtocol extends AbstractRioProtocol {
* source type is not a tuner (however the {@link #lastUpdateTime} will be reset).
*
* @param sourceId a source identifier between 1 and 8
* @throws IllegalArgumentException if sourceId is < 1 or > 8
* @throws IllegalArgumentException if sourceId is {@code < 1} or {@code > 8}
*/
public void refreshPresets(Integer sourceId) {
if (sourceId < 1 || sourceId > 8) {
@@ -254,9 +254,9 @@ public class RioPresetsProtocol extends AbstractRioProtocol {
* @param zone a zone between 1 and 8
* @param source a source between 1 and 8
* @param presetJson the possibly empty, possibly null JSON representation of the preset
* @throws IllegalArgumentException if controller is < 1 or > 6
* @throws IllegalArgumentException if zone is < 1 or > 8
* @throws IllegalArgumentException if source is < 1 or > 8
* @throws IllegalArgumentException if controller is {@literal <} 1 or > 6
* @throws IllegalArgumentException if zone is {@literal <} 1 or > 8
* @throws IllegalArgumentException if source is {@literal <} 1 or > 8
* @throws IllegalArgumentException if presetJson contains more than one preset
*/
public void setZonePresets(int controller, int zone, int source, @Nullable String presetJson) {

4
bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/RioSystemFavoritesProtocol.java
View File

@@ -197,8 +197,8 @@ public class RioSystemFavoritesProtocol extends AbstractRioProtocol {
* @param controller the controller number between 1 and 6
* @param zone the zone number between 1 and 8
* @param favJson the possibly empty, possibly null JSON representation of system favorites
* @throws IllegalArgumentException if controller is < 1 or > 6
* @throws IllegalArgumentException if zone is < 1 or > 8
* @throws IllegalArgumentException if controller is {@literal <} 1 or > 6
* @throws IllegalArgumentException if zone is {@literal < 1} or > 8
*/
public void setSystemFavorites(int controller, int zone, @Nullable String favJson) {
if (controller < 1 || controller > 6) {

4
bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/models/RioBank.java
View File

@@ -36,7 +36,7 @@ public class RioBank {
* Create the object from the given ID (using the default name of "Bank" + id)
*
* @param id a bank identifier between 1 and 6
* @throws IllegalArgumentException if id is < 1 or > 6
* @throws IllegalArgumentException if id is {@literal <} 1 or > 6
*/
public RioBank(int id) {
this(id, null);
@@ -48,7 +48,7 @@ public class RioBank {
*
* @param id a bank identifier between 1 and 6
* @param name a possibly null, possibly empty bank name (null or empty will result in a bank name of "Bank "+ id)
* @throws IllegalArgumentException if id is < 1 or > 6
* @throws IllegalArgumentException if id is {@literal < 1} or > 6
*/
public RioBank(int id, @Nullable String name) {
if (id < 1 || id > 6) {

4
bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/models/RioFavorite.java
View File

@@ -44,7 +44,7 @@ public class RioFavorite {
* "Favorite " + id
*
* @param id a favorite ID between 1 and 32
* @throws IllegalArgumentException if id < 1 or > 32
* @throws IllegalArgumentException if id {@literal < 1} or > 32
*/
public RioFavorite(int id) {
this(id, false, null);
@@ -57,7 +57,7 @@ public class RioFavorite {
* @param id a favorite ID between 1 and 32
* @param isValid true if the favorite is valid, false otherwise
* @param name a possibly null, possibly empty favorite name
* @throws IllegalArgumentException if id < 1 or > 32
* @throws IllegalArgumentException if id {@literal < 1} or > 32
*/
public RioFavorite(int id, boolean isValid, @Nullable String name) {
if (id < 1 || id > 32) {

4
bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/models/RioPreset.java
View File

@@ -44,7 +44,7 @@ public class RioPreset {
* "Preset " + id
*
* @param id a preset ID between 1 and 36
* @throws IllegalArgumentException if id < 1 or > 36
* @throws IllegalArgumentException if id {@literal < 1} or > 36
*/
public RioPreset(int id) {
this(id, false, "Preset " + id);
@@ -57,7 +57,7 @@ public class RioPreset {
* @param id a preset ID between 1 and 36
* @param valid true if the preset is valid, false otherwise
* @param name a possibly null, possibly empty preset name
* @throws IllegalArgumentException if id < 1 or > 32
* @throws IllegalArgumentException if id {@literal < 1} or > 32
*/
public RioPreset(int id, boolean valid, @Nullable String name) {
if (id < 1 || id > 36) {

3
bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/source/RioSourceHandler.java
View File

@@ -198,7 +198,8 @@ public class RioSourceHandler extends AbstractThingHandler<RioSourceProtocol> im
/**
* Initializes the bridge. Confirms the configuration is valid and that our parent bridge is a
* {@link RioSystemHandler}. Once validated, a {@link RioSystemProtocol} is set via
* {@link RioSystemHandler}. Once validated, a
* {@link org.openhab.binding.russound.internal.rio.system.RioSystemProtocol} is set via
* {@link #setProtocolHandler(RioSystemProtocol)} and the bridge comes online.
*/
@Override