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

Improve javadoc for all addons (#15667)

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

2
bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/HeosBindingConstants.java
View File

@@ -23,7 +23,7 @@ import org.openhab.core.thing.ThingTypeUID;
import org.openhab.core.thing.type.ChannelTypeUID;
/**
* The {@link HeosBinding} class defines common constants, which are
* The {@link HeosBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Johannes Einig - Initial contribution

12
bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/api/HeosFacade.java
View File

@@ -457,8 +457,8 @@ public class HeosFacade {
/**
* Asks for the actual state of the player. The result has
* to be handled by the event controller. The system returns {@link HeosConstants.PLAY},
* {@link HeosConstants.PAUSE} or {@link HeosConstants.STOP}.
* to be handled by the event controller. The system returns {@link HeosConstants#PLAY},
* {@link HeosConstants#PAUSE} or {@link HeosConstants#STOP}.
*
* @param id The player ID the state shall get for
* @return
@@ -469,8 +469,8 @@ public class HeosFacade {
/**
* Ask for the actual mute state of the player. The result has
* to be handled by the event controller. The HEOS system returns {@link HeosConstants.ON}
* or {@link HeosConstants.OFF}.
* to be handled by the event controller. The HEOS system returns {@link HeosConstants#ON}
* or {@link HeosConstants#OFF}.
*
* @param id The player id the mute state shall get for
* @return
@@ -493,8 +493,8 @@ public class HeosFacade {
/**
* Ask for the actual shuffle mode of the player. The result has
* to be handled by the event controller. The HEOS system returns {@link HeosConstants.ON},
* {@link HeosConstants.HEOS_REPEAT_ALL} or {@link HeosConstants.HEOS_REPEAT_ONE}
* to be handled by the event controller. The HEOS system returns {@link HeosConstants#ON},
* {@link HeosConstants#HEOS_REPEAT_ALL} or {@link HeosConstants#HEOS_REPEAT_ONE}
*
* @param id The player id the shuffle mode shall get for
* @return

2
bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/resources/HeosStringPropertyChangeListener.java
View File

@@ -20,7 +20,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* The {@Link HeosStringPropertyChangeListener} provides the possibility
* The {@link HeosStringPropertyChangeListener} provides the possibility
* to add a listener to a String and get informed about the new value.
*
* @author Johannes Einig - Initial contribution