Merge pull request #132 from conglisc/master

Addressed warning messages in SPLDOC during spl-make-doc

com.ibm.streamsx.messaging/com.ibm.streamsx.messaging.mqtt/MSGTypes.spl

@@ -14,7 +14,7 @@ type MQTTBlobMsg = blob data;
 type MQTTRStringMsg = rstring data;
 
 
-/*
+/**
 * Composite that defines types to be used to update MQTTSource operator using control port
 */
 public composite MQTTSourceUpdate
@@ -44,21 +44,24 @@ public composite MQTTSourceUpdate
             rstring> mqttConfig;
 }
 
-/*
+/**
 * Composite that contains types to be used to update MQTTSink operator using control port
 */
 public composite MQTTSinkUpdate
 {
     type
-       /*
+       /**
        * The expected schema for the control input port in the MQTTSink operator
        */
         static ControlPortType = map<rstring, rstring> mqttConfig;
 }
 
 /** Convenience method for creating a control signal that modifies
  * subscription setting for MQTTSource operator
- * 
+ * @param action the action to apply for the topics specified
+ * @param topics list of topics to add / remove / update or replace
+ * @param qos qos of the topics to be added, updated or replaced
+ * @return a control signal with expected schema value populated for the control port
  */
 public MQTTSourceUpdate.ControlPortType
 	newControlSignal(MQTTSourceUpdate.TopicsUpdateAction action,

com.ibm.streamsx.messaging/com.ibm.streamsx.messaging.mqtt/namespace-info.spl

@@ -47,7 +47,7 @@
  *       and the quality of service (QoS) to be provided for each of the topics.
  *     * The QoS applies only for ADD, REPLACE, and UPDATE operations.
  *       For ADD and REPLACE operations, the QoS is applied to the topics that are added or replaced.
- *     * **Tip**: To update the QoS for all the subscribed topics, use asterisk (*) as a wildcard character for the topics element.
+ *     * **Tip**: To update the QoS for all the subscribed topics, use asterisk (\*) as a wildcard character for the topics element.
  * 
  * The following list contains descriptions of the configuration options for the control port.
  * The updated configuration options are used immediately and the operator does not wait until a connection failure to apply these values.
@@ -91,7 +91,7 @@
  *        }
  *     }
  * 
- * The following example shows how to update QoS for all the existing topics by using the wildcard character (*):
+ * The following example shows how to update QoS for all the existing topics by using the wildcard character (\*):
  * 
  *     stream<MQTTSourceUpdate.ControlPortType> ControlOp_out2 = Custom(){
  *       logic

com.ibm.streamsx.messaging/impl/java/src/com/ibm/streamsx/messaging/mqtt/SPLDocConstants.java

@@ -14,7 +14,7 @@ public class SPLDocConstants {
 	static final String MQTTSRC_OUTPUT_PORT_1 = "The optional output port is an error port where the operator submits a single tuple for each failed message. The tuple contains a single attribute of type rstring or ustring, which contains the details of the error message.";
 	static final String MQTTSRC_OUPUT_PORT_0 = "This is the data port and is mandatory.";
 	static final String MQTTSRC_INPUT_PORT0 = "This is the optional control port.  You can use the control port to update information at run time, such as the connection information that the operator uses to connect to an MQTT server, the topics that the operator subscribes to, or the QoS levels of the subscribed topics.";
-	static final String MQTTSRC_PARAM_PERIOD_DESC = "This parameter specifies the time period in seconds the operator waits before it tries to reconnect. It is an optional parameter of type float64. Default value is 60000 ms.";
+	static final String MQTTSRC_PARAM_PERIOD_DESC = "This parameter specifies the time period in milliseconds the operator waits before it tries to reconnect. It is an optional parameter of type int64. Default value is 60000 ms.";
 	static final String MQTTSRC_PARAM_RECONN_BOUND_DESC = "This optional parameter of type int32 specifies the number of successive connections that are attempted for an operator.  Specify 0 for no retry, n for n number of retries, -1 for inifinite retry.";
 	static final String MQTTSRC_PARAM_TOPICATTRNAME_DESC = "Output attribute on output data stream to assign message topic to.";
 	static final String MQTTSRC_PARAM_ERRORATTRNAME_DESC = "Output attribute on optional error output port to assign error message to.";
@@ -40,7 +40,7 @@ public class SPLDocConstants {
 
 	static final String MQTTSINK_PARAM_RETAIN_DESC = "Indicates if messages should be retained on the MQTT server.  Default is false.";
 
-	static final String MQTTSINK_PARAM_PERIOD_DESC = "This parameter specifies the time period in seconds the operator waits before it tries to reconnect. It is an optional parameter of type float64. Default value is 60000 ms.";
+	static final String MQTTSINK_PARAM_PERIOD_DESC = "This parameter specifies the time period in milliseconds the operator waits before it tries to reconnect. It is an optional parameter of type int64. Default value is 60000 ms.";
 
 	static final String MQTTSINK_PARAM_RECONN_BOUND_DESC = "This optional parameter of type int32 specifies the number of successive connections that are attempted for an operator.  Specify 0 for no retry, n for n number of retries, -1 for inifinite retry.";