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

21
bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/InputWithPlayControl.java
View File

@@ -37,49 +37,56 @@ public interface InputWithPlayControl extends IStateUpdatable {
* Start the playback of the content which is usually selected by the means of the Navigation control class or
* which has been stopped by stop().
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
void play() throws IOException, ReceivedMessageParseException;
/**
* Stop the currently playing content. Use start() to start again.
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
void stop() throws IOException, ReceivedMessageParseException;
/**
* Pause the currently playing content. This is not available for streaming content like on NET_RADIO.
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
void pause() throws IOException, ReceivedMessageParseException;
/**
* Skip forward. This is not available for streaming content like on NET_RADIO.
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
void skipFF() throws IOException, ReceivedMessageParseException;
/**
* Skip reverse. This is not available for streaming content like on NET_RADIO.
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
void skipREV() throws IOException, ReceivedMessageParseException;
/**
* Next track. This is not available for streaming content like on NET_RADIO.
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
void nextTrack() throws IOException, ReceivedMessageParseException;
/**
* Previous track. This is not available for streaming content like on NET_RADIO.
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
void previousTrack() throws IOException, ReceivedMessageParseException;
}

3
bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/InputWithPresetControl.java
View File

@@ -40,7 +40,8 @@ public interface InputWithPresetControl extends IStateUpdatable {
* Select a preset channel.
*
* @param presetChannel The preset position [1,40]
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
void selectItemByPresetNumber(int presetChannel) throws IOException, ReceivedMessageParseException;
}

3
bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/InputWithTunerBandControl.java
View File

@@ -34,7 +34,8 @@ public interface InputWithTunerBandControl extends IStateUpdatable {
* Select a DAB band by name.
*
* @param band The band name (e.g. FM or DAB)
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
void selectBandByName(String band) throws IOException, ReceivedMessageParseException;
}

24
bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/InputWithNavigationControlXML.java
View File

@@ -88,7 +88,8 @@ public class InputWithNavigationControlXML extends AbstractInputControlXML imple
/**
* Navigate back
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
@Override
public void goBack() throws IOException, ReceivedMessageParseException {
@@ -98,7 +99,8 @@ public class InputWithNavigationControlXML extends AbstractInputControlXML imple
/**
* Navigate up
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
@Override
public void goUp() throws IOException, ReceivedMessageParseException {
@@ -108,7 +110,8 @@ public class InputWithNavigationControlXML extends AbstractInputControlXML imple
/**
* Navigate down
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
@Override
public void goDown() throws IOException, ReceivedMessageParseException {
@@ -118,7 +121,8 @@ public class InputWithNavigationControlXML extends AbstractInputControlXML imple
/**
* Navigate left. Not for all zones or functions available.
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
@Override
public void goLeft() throws IOException, ReceivedMessageParseException {
@@ -128,7 +132,8 @@ public class InputWithNavigationControlXML extends AbstractInputControlXML imple
/**
* Navigate right. Not for all zones or functions available.
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
@Override
public void goRight() throws IOException, ReceivedMessageParseException {
@@ -138,7 +143,8 @@ public class InputWithNavigationControlXML extends AbstractInputControlXML imple
/**
* Select current item. Not for all zones or functions available.
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
@Override
public void selectCurrentItem() throws IOException, ReceivedMessageParseException {
@@ -148,7 +154,8 @@ public class InputWithNavigationControlXML extends AbstractInputControlXML imple
/**
* Navigate to root menu
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
@Override
public boolean goToRoot() throws IOException, ReceivedMessageParseException {
@@ -270,7 +277,8 @@ public class InputWithNavigationControlXML extends AbstractInputControlXML imple
* some time because it retries the request for up to MENU_MAX_WAITING_TIME or the menu state reports
* "Ready", whatever comes first.
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
@Override
public void update() throws IOException, ReceivedMessageParseException {

24
bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/InputWithPlayControlXML.java
View File

@@ -102,7 +102,8 @@ public class InputWithPlayControlXML extends AbstractInputControlXML implements
* Start the playback of the content which is usually selected by the means of the Navigation control class or
* which has been stopped by stop().
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
@Override
public void play() throws IOException, ReceivedMessageParseException {
@@ -112,7 +113,8 @@ public class InputWithPlayControlXML extends AbstractInputControlXML implements
/**
* Stop the currently playing content. Use start() to start again.
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
@Override
public void stop() throws IOException, ReceivedMessageParseException {
@@ -122,7 +124,8 @@ public class InputWithPlayControlXML extends AbstractInputControlXML implements
/**
* Pause the currently playing content. This is not available for streaming content like on NET_RADIO.
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
@Override
public void pause() throws IOException, ReceivedMessageParseException {
@@ -132,7 +135,8 @@ public class InputWithPlayControlXML extends AbstractInputControlXML implements
/**
* Skip forward. This is not available for streaming content like on NET_RADIO.
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
@Override
public void skipFF() throws IOException, ReceivedMessageParseException {
@@ -146,7 +150,8 @@ public class InputWithPlayControlXML extends AbstractInputControlXML implements
/**
* Skip reverse. This is not available for streaming content like on NET_RADIO.
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
@Override
public void skipREV() throws IOException, ReceivedMessageParseException {
@@ -160,7 +165,8 @@ public class InputWithPlayControlXML extends AbstractInputControlXML implements
/**
* Next track. This is not available for streaming content like on NET_RADIO.
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
@Override
public void nextTrack() throws IOException, ReceivedMessageParseException {
@@ -170,7 +176,8 @@ public class InputWithPlayControlXML extends AbstractInputControlXML implements
/**
* Previous track. This is not available for streaming content like on NET_RADIO.
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
@Override
public void previousTrack() throws IOException, ReceivedMessageParseException {
@@ -192,7 +199,8 @@ public class InputWithPlayControlXML extends AbstractInputControlXML implements
/**
* Updates the playback information
*
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
@Override
public void update() throws IOException, ReceivedMessageParseException {

8
bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/InputWithPresetControlXML.java
View File

@@ -86,8 +86,9 @@ public class InputWithPresetControlXML extends AbstractInputControlXML implement
/**
* Updates the preset information
*
* @throws Exception
*
* @throws IOException
* @throws ReceivedMessageParseException
*/
@Override
public void update() throws IOException, ReceivedMessageParseException {
@@ -168,7 +169,8 @@ public class InputWithPresetControlXML extends AbstractInputControlXML implement
* Select a preset channel.
*
* @param presetChannel The preset position [1,40]
* @throws Exception
* @throws IOException
* @throws ReceivedMessageParseException
*/
@Override
public void selectItemByPresetNumber(int presetChannel) throws IOException, ReceivedMessageParseException {