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

18
bundles/org.openhab.binding.vizio/src/main/java/org/openhab/binding/vizio/internal/communication/VizioCommunicator.java
View File

@@ -109,7 +109,7 @@ public class VizioCommunicator {
/**
* Change the volume of the Vizio TV
*
* @param the command JSON for the desired volue
* @param commandJSON the command JSON for the desired volue
* @return A PutResponse response object
* @throws VizioException
*
@@ -132,7 +132,7 @@ public class VizioCommunicator {
/**
* Change the currently selected input of the Vizio TV
*
* @param the command JSON for the selected input
* @param commandJSON the command JSON for the selected input
* @return A PutResponse response object
* @throws VizioException
*
@@ -166,7 +166,7 @@ public class VizioCommunicator {
/**
* Launch a given streaming app on the Vizio TV
*
* @param the VizioAppConfig data for the app to launch
* @param appConfig the VizioAppConfig data for the app to launch
* @return A PutResponse response object
* @throws VizioException
*
@@ -178,7 +178,7 @@ public class VizioCommunicator {
/**
* Send a key press command to the Vizio TV
*
* @param the command JSON for the key press
* @param commandJSON the command JSON for the key press
* @return A PutResponse response object
* @throws VizioException
*
@@ -190,8 +190,8 @@ public class VizioCommunicator {
/**
* Start the pairing process to obtain an auth token from the TV
*
* @param the deviceName that is displayed in the TV settings after the device is registered
* @param the deviceId a unique number that identifies this pairing request
* @param deviceName the deviceName that is displayed in the TV settings after the device is registered
* @param deviceId the deviceId a unique number that identifies this pairing request
* @return A PairingStart response object
* @throws VizioException
*
@@ -206,9 +206,9 @@ public class VizioCommunicator {
/**
* Finish the pairing process by submitting the code that was displayed on the TV to obtain the auth token
*
* @param the same deviceId that was used by startPairing()
* @param the pairingCode that was displayed on the TV
* @param the pairingToken returned by startPairing()
* @param deviceId the same deviceId that was used by startPairing()
* @param pairingCode the pairingCode that was displayed on the TV
* @param pairingToken the pairingToken returned by startPairing()
* @return A PairingComplete response object
* @throws VizioException
*