Improve javadoc for all addons (#15667)
Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
This commit is contained in:
@@ -21,7 +21,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
|
||||
import org.openhab.core.thing.ThingTypeUID;
|
||||
|
||||
/**
|
||||
* The {@link PowermaxBinding} class defines common constants, which are
|
||||
* The {@link PowermaxBindingConstants} class defines common constants, which are
|
||||
* used across the whole binding.
|
||||
*
|
||||
* @author Laurent Garnier - Initial contribution
|
||||
|
||||
@@ -228,7 +228,7 @@ public abstract class PowermaxConnector implements PowermaxConnectorInterface {
|
||||
/**
|
||||
* Set the start time of the time frame to receive a response
|
||||
*
|
||||
* @param timeLastReceive the time in milliseconds
|
||||
* @param waitingForResponse the time in milliseconds
|
||||
*/
|
||||
public synchronized void setWaitingForResponse(long waitingForResponse) {
|
||||
this.waitingForResponse = waitingForResponse;
|
||||
|
||||
@@ -38,7 +38,7 @@ public interface PowermaxConnectorInterface {
|
||||
/**
|
||||
* Returns connection status
|
||||
*
|
||||
* @return: true if connected or false if not
|
||||
* @return true if connected or false if not
|
||||
**/
|
||||
boolean isConnected();
|
||||
|
||||
|
||||
@@ -41,7 +41,6 @@ public class PowermaxReaderThread extends Thread {
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param in the input stream
|
||||
* @param connector the object that should handle the received message
|
||||
* @param threadName the name of the thread
|
||||
*/
|
||||
|
||||
@@ -126,8 +126,8 @@ public class PowermaxCommManager implements PowermaxMessageEventListener {
|
||||
* @param panelType the panel type to be used when in standard mode
|
||||
* @param forceStandardMode true to force the standard mode rather than trying using the Powerlink mode
|
||||
* @param autoSyncTime true for automatic sync time
|
||||
* @param serialPortManager
|
||||
* @param threadName the prefix name of threads to be created
|
||||
* @param timeZoneProvider
|
||||
*/
|
||||
public PowermaxCommManager(String ip, int port, PowermaxPanelType panelType, boolean forceStandardMode,
|
||||
boolean autoSyncTime, String threadName, TimeZoneProvider timeZoneProvider) {
|
||||
@@ -163,8 +163,6 @@ public class PowermaxCommManager implements PowermaxMessageEventListener {
|
||||
|
||||
/**
|
||||
* Connect to the Powermax alarm system
|
||||
*
|
||||
* @return true if connected or false if not
|
||||
*/
|
||||
public void open() throws Exception {
|
||||
connector.open();
|
||||
@@ -201,7 +199,7 @@ public class PowermaxCommManager implements PowermaxMessageEventListener {
|
||||
/**
|
||||
* Process and store all the panel settings from the raw buffers
|
||||
*
|
||||
* @param PowerlinkMode true if in Powerlink mode or false if in standard mode
|
||||
* @param powerlinkMode true if in Powerlink mode or false if in standard mode
|
||||
*
|
||||
* @return true if no problem encountered to get all the settings; false if not
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user