Merge branch 'miketran78727-iss364' into bugfix-issue-346

Author: jpwsutton

org.eclipse.paho.sample.utility/src/main/java/org/eclipse/paho/sample/utility/ConnOpts.java

@@ -65,9 +65,8 @@ public class ConnOpts extends JPanel implements ActionListener {
 
 	/**
 	 * Constructor for ConnOpts. The constructor builds all the GUI objects required and creates the
-	 * dialog in hidden mode ready to be made visible when required.
-	 * @param owner Required by the JDialog superclass
-	 * @param title The text displayed in the window title bar. Required by the JDialog superclass.
+	 * dialog in hidden mode ready to be made visible when required.
+	 *
 	 * @param mgr The object that manages the MQIsdp connection
 	 * @param props The properties object created from the config file on disk
 	 */

org.eclipse.paho.sample.utility/src/main/java/org/eclipse/paho/sample/utility/LED.java

@@ -235,7 +235,11 @@ public void setAmber() {
 	repaint();
 }
 /**
- * Set the LED colour to a user specified RGB
+ * Set the LED colour to a user specified RGB
+ *
+ * @param r red value
+ * @param g green value
+ * @param b blue value
  */
 public void setColor(int r, int g, int b) {
 
@@ -253,7 +257,9 @@ public void setColor(int r, int g, int b) {
 
 /**
  * Query the flashing variable to determine if the LED is 
- * currently in a state of flashing or not.
+ * currently in a state of flashing or not.
+ *
+ * @return true if flashing
  */
 public boolean isFlashing() {
 	return flashing;

org.eclipse.paho.sample.utility/src/main/java/org/eclipse/paho/sample/utility/MQTTFrame.java

@@ -309,6 +309,7 @@ protected void init( Container contentPane ) {
      * @param message The data to be published
      * @param qos The Quality of Service at which the publication should be delivered.
      * @param retained Is this a retained publication or not?
+     * @throws Exception on error
      */
     public void publish( String topic, byte[] message, int qos, boolean retained ) throws Exception {
 		setTitleText( "" );
@@ -369,12 +370,12 @@ public void disconnect() {
     /**
      * A wrapper for the MQTT connect method. If the ip address, port number or persistence flag
      * has changed since the last time then a new MqttClient object is required. If these values haven't changed then
-     * any previously created object can be used.<P>
-     * Check whether Last Will & Testament is required and call the appropriate connect method. The only persistence implementation supported at the moment is
-     * MqttFilePersistence.
-     * @param ipAddr The IP address or hostname to connect to.
-     * @param port The IP port number to connect to.
+     * any previously created object can be used.
+     * Check whether Last Will and Testament is required and call the appropriate connect method.
+     * The only persistence implementation supported at the moment is MqttFilePersistence.
+     * @param connStr Connection string
      * @param usePersistence Is persistence required?
+     * @throws MqttException on error
      */
     public void connect( String connStr, boolean usePersistence ) throws MqttException {
 		// Connect to the broker
@@ -723,6 +724,7 @@ public boolean updateComboBoxList( JComboBox list, String itemName ) {
 
     /**
      * This method calls the MQTT startTrace method to produce trace of the protocol flows
+     * @throws MqttException on error
      */    
     public void startTrace() throws MqttException {
     	traceEnabled = true;

org.eclipse.paho.sample.utility/src/main/java/org/eclipse/paho/sample/utility/MQTTHist.java

@@ -46,8 +46,7 @@ public class MQTTHist extends JDialog implements ActionListener, Runnable {
 
 	/**
 	 * Constructor for MQTTHist.
-	 * @param owner The frame from whcih this dialog is descended
-	 * @param title The title text to display in the window bar
+	 * @param theOwner The frame owner
 	 * @param connOptions the COnnOpts panel which started this dialog
 	 */
 	public MQTTHist( JFrame theOwner, ConnOpts connOptions ) {