[releng][cleanup] Fix @since tags according to API Tooling

rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/SystemEncodingUtil.java

@@ -76,12 +76,12 @@ public class SystemEncodingUtil {
    	/**
 	 * Change the default encoding provider.
 	 * 
-    * This is a system-wide change, and clients will not be notified
+	 * This is a system-wide change, and clients will not be notified of changed
-    * of changed default encodings due to changing the provider. Therefore,
+	 * default encodings due to changing the provider. Therefore, changing the
-    * changing the provider should be done only once during early system 
+	 * provider should be done only once during early system startup.
-    * startup.
 	 * 
 	 * @param p the new encoding provider.
+	 * @since 3.0
 	 */
 	public void setDefaultEncodingProvider(DefaultEncodingProvider p) {
 	    _defaultEncodingProvider = p;
@@ -89,10 +89,11 @@ public class SystemEncodingUtil {
 
 	/**
 	 * Returns the local default encoding as provided by the default encoding
-	 * provider.  This method should be called after RSE startup is complete
+	 * provider. This method should be called after RSE startup is complete in
-	 * in order to get the proper default workspace encoding.    
+	 * order to get the proper default workspace encoding.
 	 *
 	 * @return the local default encoding
+	 * @since 3.0
 	 */
 	public String getLocalDefaultEncoding() {
 	   return _defaultEncodingProvider.getLocalDefaultEncoding();

rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/SystemOperationMonitor.java

@@ -13,6 +13,12 @@
 
 package org.eclipse.rse.services.clientserver;
 
+/**
+ * A monitor to support cancellation of operations in an environment
+ * where Eclipse IProgressMonitor is not available.
+ * 
+ * @since 3.0
+ */
 public class SystemOperationMonitor implements ISystemOperationMonitor
 {
 	private boolean cancelled = false;

rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/SystemReentrantMutex.java

@@ -18,27 +18,26 @@ import java.util.LinkedList;
 import java.util.List;
 
 /**
- * A SystemMutex Exclusion Lock for Threads that need to access a resource
+ * A reentrant Exclusion Lock for Threads that need to access a resource in a
- * in a serialized manner.
+ * serialized manner. If the request for the lock is running on the same thread
- * If the request for the lock is running on the same thread who is currently holding the lock,
+ * who is currently holding the lock, it will "borrow" the lock, and the call to
- * it will "borrow" the lock, and the call to waitForLock() will go through.
+ * waitForLock() will go through. A SystemOperationMonitor is accepted in order
- * An SystemOperationMonitor is accepted
+ * to support cancellation when waiting for the Mutex. This is a clone of
- * in order to support cancellation when waiting for the SystemMutex.
+ * {@link org.eclipse.rse.services.Mutex} with some modification to make sure the
- * This is a clone for org.eclipse.rse.services.Mutex with some modification to make sure the
+ * sequential calls to waitForLock() method in the same thread will not be
- * sequential calls to waitForLock() method in the same thread will not be blocked.
+ * blocked.
  * 
- * Usage Example:
+ * Usage Example: <code>
- * <code>
+ *    private SystemReentrantMutex fooMutex = new SystemReentrantMutex();
- *    private SystemMutex fooMutex = new SystemMutex();
  *    boolean doFooSerialized()(ISystemOperationMonitor monitor) {
- *    	  int mutexLockStatus = SystemMutex.LOCK_STATUS_NOLOCK;
+ *    	  int mutexLockStatus = SystemReentrantMutex.LOCK_STATUS_NOLOCK;
  *        mutexLockStatus = fooMutex.waitForLock(monitor, 1000);
- *        if (SystemMutex.LOCK_STATUS_NOLOCK != mutexLockStatus) {
+ *        if (mutexLockStatus != SystemReentrantMutex.LOCK_STATUS_NOLOCK) {
  *            try {
  *                return doFoo();
  *            } finally {
  *                //We only release the mutex if we acquire it, not borrowed it.
- *   	          if (SystemMutex.LOCK_STATUS_AQUIRED == mutexLockStatus)
+ *   	          if (mutexLockStatus == SystemReentrantMutex.LOCK_STATUS_AQUIRED)
  * 		          {
  * 			          fooMutex.release();
  * 		          }
@@ -48,6 +47,7 @@ import java.util.List;
  *    }
  * </code>
  * 
+ * @since 3.0
  */
 public class SystemReentrantMutex {
 

rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/archiveutils/SystemTgzHandler.java

@@ -19,7 +19,9 @@ import java.util.zip.GZIPOutputStream;
 import org.eclipse.rse.internal.services.clientserver.archiveutils.TgzFile;
 
 /**
- * handler class for .tar.gz and .tgz files
+ * Handler class for .tar.gz and .tgz files.
+ * 
+ * @since 3.0
  */
 public class SystemTgzHandler extends SystemTarHandler {
 

rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/messages/CommonMessages.java

@@ -17,7 +17,10 @@ package org.eclipse.rse.services.clientserver.messages;
 
 import org.eclipse.osgi.util.NLS;
 
-
+/**
+ * Externalized Strings for common messages that all clients can use.
+ * @since 3.0
+ */
 public class CommonMessages extends NLS {
 	private static String BUNDLE_NAME = "org.eclipse.rse.services.clientserver.messages.CommonMessages";//$NON-NLS-1$
 

rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/messages/SimpleSystemMessage.java

@@ -21,7 +21,11 @@ import java.io.StringWriter;
 
 import org.eclipse.core.runtime.IStatus;
 
-
+/**
+ * An RSE SystemMessage that can be created from Strings (without XML parsing).
+ * 
+ * @since 3.0
+ */
 public class SimpleSystemMessage extends SystemMessage {
 
 	private String _pluginId;

rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/shells/AbstractHostShellOutputReader.java

@@ -104,6 +104,7 @@ public abstract class AbstractHostShellOutputReader  extends Thread implements I
 		}
 	}
 
+	/** @since 3.0 */
 	protected final synchronized void startIfNotAlive() {
 		if (!isAlive()) {
 			start();