Fix some javadocs. (openhab#2349)

Includes: - some multi line comments changed to javadoc - some javadocs moved to the correct place See: #openhab/static-code-analysis/52 Signed-off-by: Svilen Valkanov <[email protected]>
aogorek · Jul 5, 2017 · 0375b7e · 0375b7e
1 parent aab3ec9
commit 0375b7e
Show file tree

Hide file tree

Showing 13 changed files with 27 additions and 27 deletions.
diff --git a/...masternet/src/main/java/org/openhab/binding/coolmasternet/internal/ControllerHandler.java b/...masternet/src/main/java/org/openhab/binding/coolmasternet/internal/ControllerHandler.java
@@ -36,7 +36,8 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/* Bridge to access a CoolMasterNet unit's ASCII protocol via TCP socket.
+/**
+ * Bridge to access a CoolMasterNet unit's ASCII protocol via TCP socket.
  *
  * A single CoolMasterNet can be connected to one or more HVAC units, each with a unique UID.
  * These are individual Things inside the bridge.

diff --git a/...cache/src/main/java/org/openhab/binding/globalcache/internal/command/AbstractCommand.java b/...cache/src/main/java/org/openhab/binding/globalcache/internal/command/AbstractCommand.java
@@ -20,7 +20,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/*
+/**
  * The {@link AbstractCommand} class implements the basic functionality needed for all GlobalCache commands.
  *
  * @author Mark Hilbush - Initial contribution

diff --git a/...che/src/main/java/org/openhab/binding/globalcache/internal/command/CommandGetdevices.java b/...che/src/main/java/org/openhab/binding/globalcache/internal/command/CommandGetdevices.java
@@ -15,7 +15,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/*
+/**
  * The {@link CommandGetdevices} class implements the GlobalCache getdevices command.
  *
  * @author Mark Hilbush - Initial contribution

diff --git a/...ache/src/main/java/org/openhab/binding/globalcache/internal/command/CommandGetserial.java b/...ache/src/main/java/org/openhab/binding/globalcache/internal/command/CommandGetserial.java
@@ -17,7 +17,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/*
+/**
  * The {@link CommandGetserial} class implements the GlobalCache get_SERIAL command, which retrieves the serial
  * port parameters (baud, flow control, and parity) from the device.
  *

diff --git a/...cache/src/main/java/org/openhab/binding/globalcache/internal/command/CommandGetstate.java b/...cache/src/main/java/org/openhab/binding/globalcache/internal/command/CommandGetstate.java
@@ -18,7 +18,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/*
+/**
  * The {@link CommandGetstate} class implements the GlobalCache getstate command, which retrieves the
  * current state of the contact closure on the device.
  *

diff --git a/...che/src/main/java/org/openhab/binding/globalcache/internal/command/CommandGetversion.java b/...che/src/main/java/org/openhab/binding/globalcache/internal/command/CommandGetversion.java
@@ -15,7 +15,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/*
+/**
  * The {@link CommandGetversion} class implements the GlobalCache getversion command, which retrieves software
  * version of the device.
  *

diff --git a/...ache/src/main/java/org/openhab/binding/globalcache/internal/command/CommandInterface.java b/...ache/src/main/java/org/openhab/binding/globalcache/internal/command/CommandInterface.java
@@ -8,7 +8,7 @@
  */
 package org.openhab.binding.globalcache.internal.command;
 
-/*
+/**
  * The {@link CommandInterface} interface class defines the methods that all command classes must implement.
  *
  * @author Mark Hilbush - Initial contribution

diff --git a/...alcache/src/main/java/org/openhab/binding/globalcache/internal/command/CommandSendir.java b/...alcache/src/main/java/org/openhab/binding/globalcache/internal/command/CommandSendir.java
@@ -16,7 +16,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/*
+/**
  * The {@link CommandSendir} class implements the GlobalCache sendir command, which sends
  * an infrared command to the device.
  *

diff --git a/...che/src/main/java/org/openhab/binding/globalcache/internal/command/CommandSendserial.java b/...che/src/main/java/org/openhab/binding/globalcache/internal/command/CommandSendserial.java
@@ -16,7 +16,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/*
+/**
  * The {@link CommandSendserial} class sends a serial command string to the device.
  *
  * @author Mark Hilbush - Initial contribution

diff --git a/...ache/src/main/java/org/openhab/binding/globalcache/internal/command/CommandSetserial.java b/...ache/src/main/java/org/openhab/binding/globalcache/internal/command/CommandSetserial.java
@@ -17,7 +17,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/*
+/**
  * The {@link CommandSetserial} class implements the GlobalCache set_SERIAL command, which sets the serial
  * port parameters (baud, flow control, and parity) on the device.
  *

diff --git a/...cache/src/main/java/org/openhab/binding/globalcache/internal/command/CommandSetstate.java b/...cache/src/main/java/org/openhab/binding/globalcache/internal/command/CommandSetstate.java
@@ -19,8 +19,9 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/*
- * The {@link CommandSetstate} class implements the GlobalCache setstate command for devices that support contact closure.
+/**
+ * The {@link CommandSetstate} class implements the GlobalCache setstate command for devices that support contact
+ * closure.
  *
  * @author Mark Hilbush - Initial contribution
  */

diff --git a/...otronic/src/main/java/org/openhab/binding/vitotronic/handler/VitotronicBridgeHandler.java b/...otronic/src/main/java/org/openhab/binding/vitotronic/handler/VitotronicBridgeHandler.java
@@ -8,13 +8,6 @@
  */
 package org.openhab.binding.vitotronic.handler;
 
-/**
- * The {@link VitotronicBridgeHandler} class handles the connection to the
- * optolink adapter.
- *
- * @author Stefan Andres - Initial contribution
- */
-
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.PrintStream;
@@ -44,6 +37,12 @@
 import org.xml.sax.XMLReader;
 import org.xml.sax.helpers.XMLReaderFactory;
 
+/**
+ * The {@link VitotronicBridgeHandler} class handles the connection to the
+ * optolink adapter.
+ *
+ * @author Stefan Andres - Initial contribution
+ */
 public class VitotronicBridgeHandler extends BaseBridgeHandler {
 
     private Logger logger = LoggerFactory.getLogger(VitotronicBridgeHandler.class);

diff --git a/...in/java/org/openhab/binding/vitotronic/internal/discovery/VitotronicDiscoveryService.java b/...in/java/org/openhab/binding/vitotronic/internal/discovery/VitotronicDiscoveryService.java
@@ -8,14 +8,6 @@
  */
 package org.openhab.binding.vitotronic.internal.discovery;
 
-/**
- * The {@link VitotronicBridgeDiscovery} class handles the discovery of things.
- * with broadcasting and put it to inbox, if found.
- *
- *
- * @author Stefan Andres - Initial contribution
- */
-
 import org.eclipse.smarthome.config.discovery.AbstractDiscoveryService;
 import org.eclipse.smarthome.config.discovery.DiscoveryResult;
 import org.eclipse.smarthome.config.discovery.DiscoveryResultBuilder;
@@ -25,6 +17,13 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * The {@link VitotronicBridgeDiscovery} class handles the discovery of things.
+ * with broadcasting and put it to inbox, if found.
+ *
+ *
+ * @author Stefan Andres - Initial contribution
+ */
 public class VitotronicDiscoveryService extends AbstractDiscoveryService {
 
     private Logger logger = LoggerFactory.getLogger(VitotronicDiscoveryService.class);
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,7 +8,7 @@ @@
      */
     package org.openhab.binding.globalcache.internal.command;
-    /*
+    /**
      * The {@link CommandInterface} interface class defines the methods that all command classes must implement.
      *
      * @author Mark Hilbush - Initial contribution
@@ Expand Down @@