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.miio/src/main/java/org/openhab/binding/miio/internal/Utils.java
View File

@@ -114,7 +114,7 @@ public final class Utils {
* Saves string to file in userdata folder
*
* @param filename
* @param string with content
* @param data String with content
* @param logger
*/
public static void saveToFile(String filename, String data, Logger logger) {

4
bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/cloud/CloudUtil.java
View File

@@ -72,11 +72,11 @@ public class CloudUtil {
/**
* Generate signature for the request.
*
* @param method http request method. GET or POST
* @param requestUrl the full request url. e.g.: http://api.xiaomi.com/getUser?id=123321
* @param signedNonce secret key for encryption.
* @param nonce
* @param params request params. This should be a TreeMap because the
* parameters are required to be in lexicographic order.
* @param signedNonce secret key for encryption.
* @return hash value for the values provided
* @throws MiIoCryptoException
*/

8
bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/handler/MiIoAbstractHandler.java
View File

@@ -275,7 +275,7 @@ public abstract class MiIoAbstractHandler extends BaseThingHandler implements Mi
* between [] brackets. This to allow for unimplemented commands to be executed
*
* @param commandString command to be executed
* @param cloud server to be used or empty string for direct sending to the device
* @param cloudServer server to be used or empty string for direct sending to the device
* @return message id
*/
protected int sendCommand(String commandString, String cloudServer) {
@@ -300,9 +300,9 @@ public abstract class MiIoAbstractHandler extends BaseThingHandler implements Mi
* Sends commands to the {@link MiIoAsyncCommunication} for transmission to the Mi devices or cloud
*
* @param command (method) to be queued for execution
* @param parameters to be send with the command
* @param cloud server to be used or empty string for direct sending to the device
* @param sending subdevice or empty string for regular device
* @param params to be send with the command
* @param cloudServer server to be used or empty string for direct sending to the device
* @param sender subdevice or empty string for regular device
* @return message id
*/
protected int sendCommand(String command, String params, String cloudServer, String sender) {

2
bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/miot/MiIoQuantiyTypesConversion.java
View File

@@ -20,7 +20,7 @@ import org.eclipse.jdt.annotation.Nullable;
/**
* Enum of the unitTypes used in the miio protocol
* Used to find the right {@link javax.measure.unitType} given the string of the unitType
* Used to find the right {@link javax.measure.Unit} given the string of the unitType
*
* @author Marcel Verpaalen - Initial contribution
*/