From e892da770bc0efdeb93e45697fbbc3c01b057003 Mon Sep 17 00:00:00 2001
From: Martin Oberhuber < martin.oberhuber@windriver.com>
Date: Wed, 16 Aug 2006 12:13:52 +0000
Subject: [PATCH] [cleanup] fix javadoc errors in IRemoteCmdSubSystem

---
 .../RemoteCmdSubSystemConfiguration.java          | 15 +++++++++------
 .../IRemoteCmdSubSystemConfiguration.java         |  5 ++---
 .../local/LocalShellSubSystemConfiguration.java   |  7 ++++---
 3 files changed, 15 insertions(+), 12 deletions(-)

diff --git a/rse/plugins/org.eclipse.rse.subsystems.shells.core/src/org/eclipse/rse/internal/subsystems/shells/subsystems/RemoteCmdSubSystemConfiguration.java b/rse/plugins/org.eclipse.rse.subsystems.shells.core/src/org/eclipse/rse/internal/subsystems/shells/subsystems/RemoteCmdSubSystemConfiguration.java
index 4a2938ed22f..da3e7d30f0e 100644
--- a/rse/plugins/org.eclipse.rse.subsystems.shells.core/src/org/eclipse/rse/internal/subsystems/shells/subsystems/RemoteCmdSubSystemConfiguration.java
+++ b/rse/plugins/org.eclipse.rse.subsystems.shells.core/src/org/eclipse/rse/internal/subsystems/shells/subsystems/RemoteCmdSubSystemConfiguration.java
@@ -63,9 +63,11 @@ public abstract class RemoteCmdSubSystemConfiguration extends SubSystemConfigura
 	{
 		return false;
 	}
+	
 	/**
-	 * Return true if subsystems of this factory support the environment variables property.
-	 * Return true to show it, return false to hide it. We return true.
+	 * Return true if subsystems of this configuration support the environment variables property.
+	 * For default remote command subsystems, we return <code>true</code>.
+	 * @see org.eclipse.rse.subsystems.shells.core.subsystems.IRemoteCmdSubSystemConfiguration#supportsEnvironmentVariablesPropertyPage()
 	 */
 	public boolean supportsEnvironmentVariablesPropertyPage()
 	{
@@ -174,12 +176,13 @@ public abstract class RemoteCmdSubSystemConfiguration extends SubSystemConfigura
     	return translatedType;
     }    
     
-    /**
-	 * Return in string format the character used to separate commands. Eg, ";" or "&"
-	 */
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.rse.subsystems.shells.core.subsystems.IRemoteCmdSubSystemConfiguration#getCommandSeparator()
+     */
     public String getCommandSeparator()
     {
-    	return ";";
+    	return ";"; //$NON-NLS-1$
     }
 
   
diff --git a/rse/plugins/org.eclipse.rse.subsystems.shells.core/src/org/eclipse/rse/subsystems/shells/core/subsystems/IRemoteCmdSubSystemConfiguration.java b/rse/plugins/org.eclipse.rse.subsystems.shells.core/src/org/eclipse/rse/subsystems/shells/core/subsystems/IRemoteCmdSubSystemConfiguration.java
index 20e6123cb07..c5588be3870 100644
--- a/rse/plugins/org.eclipse.rse.subsystems.shells.core/src/org/eclipse/rse/subsystems/shells/core/subsystems/IRemoteCmdSubSystemConfiguration.java
+++ b/rse/plugins/org.eclipse.rse.subsystems.shells.core/src/org/eclipse/rse/subsystems/shells/core/subsystems/IRemoteCmdSubSystemConfiguration.java
@@ -18,9 +18,6 @@ package org.eclipse.rse.subsystems.shells.core.subsystems;
 
 import org.eclipse.rse.core.subsystems.ISubSystemConfiguration;
 
-
- 
-//
 /**
  * @lastgen interface RemoteCmdSubSystemConfiguration extends SubSystemConfiguration {}
  */
@@ -30,12 +27,14 @@ public interface IRemoteCmdSubSystemConfiguration extends ISubSystemConfiguratio
 	/**
 	 * Return true if subsystems of this factory support the environment variables property.
 	 * Return true to show it, return false to hide it. 
+	 * @return <code>true</code> if environment variables are fully supported 
 	 */
 	public boolean supportsEnvironmentVariablesPropertyPage();
 	
 	
 	/**
 	 * Return in string format the character used to separate commands. Eg, ";" or "&"
+	 * @return command separator String
 	 */
     public String getCommandSeparator();
     
diff --git a/rse/plugins/org.eclipse.rse.subsystems.shells.local/src/org/eclipse/rse/subsystems/shells/local/LocalShellSubSystemConfiguration.java b/rse/plugins/org.eclipse.rse.subsystems.shells.local/src/org/eclipse/rse/subsystems/shells/local/LocalShellSubSystemConfiguration.java
index 2a94ce56cb7..b68da9d4feb 100644
--- a/rse/plugins/org.eclipse.rse.subsystems.shells.local/src/org/eclipse/rse/subsystems/shells/local/LocalShellSubSystemConfiguration.java
+++ b/rse/plugins/org.eclipse.rse.subsystems.shells.local/src/org/eclipse/rse/subsystems/shells/local/LocalShellSubSystemConfiguration.java
@@ -40,9 +40,10 @@ public class LocalShellSubSystemConfiguration extends ShellServiceSubSystemConfi
 		super();
 	}
 
-    /**
-	 * Return in string format the character used to separate commands. Eg, ";" or "&"
-	 */
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.rse.internal.subsystems.shells.subsystems.RemoteCmdSubSystemConfiguration#getCommandSeparator()
+     */
     public String getCommandSeparator()
     {
     	String os = System.getProperty("os.name").toLowerCase(); //$NON-NLS-1$