fix javadoc related errors

elsazac · elsazac · commit 40c3a0263b7f · 2025-11-06T19:40:11.000+05:30
diff --git a/ant/org.eclipse.ant.launching/src/org/eclipse/ant/internal/launching/launchConfigurations/AntHomeClasspathEntry.java b/ant/org.eclipse.ant.launching/src/org/eclipse/ant/internal/launching/launchConfigurations/AntHomeClasspathEntry.java
@@ -177,7 +177,7 @@ public int hashCode() {
 	 * Sets the ant home to use.
 	 *
 	 * @param path
-	 *            path to toor of an ant home installation
+	 *            path to root of an ant home installation
 	 */
 	public void setAntHome(String path) {
 		antHomeLocation = path;
diff --git a/debug/org.eclipse.ui.externaltools/External Tools Base/org/eclipse/ui/externaltools/internal/launchConfigurations/ExternalToolsBuildTab.java b/debug/org.eclipse.ui.externaltools/External Tools Base/org/eclipse/ui/externaltools/internal/launchConfigurations/ExternalToolsBuildTab.java
@@ -330,10 +330,10 @@ public static IProject[] getBuildProjects(ILaunchConfiguration configuration, St
 	}
 
 	/**
-	 * Whether referenced projects should be considered when building. Only valid
-	 * when a set of projects is to be built.
+	 * Whether referenced projects should be considered when building. Only
+	 * valid when a set of projects is to be built.
 	 *
-	 * @return whether referenced projects should be considerd when building
+	 * @return whether referenced projects should be considered when building
 	 * @throws CoreException if unable to access the associated attribute
 	 */
 	public static boolean isIncludeReferencedProjects(ILaunchConfiguration configuration, String includeReferencedProjectsId) throws CoreException {
diff --git a/debug/org.eclipse.ui.externaltools/External Tools Base/org/eclipse/ui/externaltools/internal/variables/BuildFilesResolver.java b/debug/org.eclipse.ui.externaltools/External Tools Base/org/eclipse/ui/externaltools/internal/variables/BuildFilesResolver.java
@@ -68,7 +68,7 @@ public String resolveValue(IDynamicVariable variable, String argument) throws Co
 					deltas |= IResourceDelta.REMOVED;
 				}
 
-				// Check wether to include files and/or directories
+				// Check whether to include files and/or directories
 				if (argument.indexOf(ARG_DIRS) > -1)
 				{
 					dirs = true;
diff --git a/debug/org.eclipse.ui.externaltools/External Tools Base/org/eclipse/ui/externaltools/internal/variables/BuildProjectResolver.java b/debug/org.eclipse.ui.externaltools/External Tools Base/org/eclipse/ui/externaltools/internal/variables/BuildProjectResolver.java
@@ -53,12 +53,12 @@ protected void abort(String message, Throwable exception) throws CoreException {
 	}
 
 	/**
-	 * Returns an expression used to reference the given variable and optional argument.
-	 * For example, <code>${var_name:arg}</code>.
+	 * Returns an expression used to reference the given variable and optional
+	 * argument. For example, <code>${var_name:arg}</code>.
 	 *
 	 * @param variable referenced variable
 	 * @param argument referenced argument or <code>null</code>
-	 * @return vraiable reference expression
+	 * @return variable reference expression
 	 */
 	protected String getReferenceExpression(IDynamicVariable variable, String argument) {
 		StringBuilder reference = new StringBuilder();
diff --git a/runtime/bundles/org.eclipse.core.runtime/src/org/eclipse/core/internal/preferences/legacy/PreferenceForwarder.java b/runtime/bundles/org.eclipse.core.runtime/src/org/eclipse/core/internal/preferences/legacy/PreferenceForwarder.java
@@ -13,12 +13,21 @@
  *******************************************************************************/
 package org.eclipse.core.internal.preferences.legacy;
 
-import java.io.*;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
 import java.util.Properties;
-import org.eclipse.core.internal.preferences.*;
+import org.eclipse.core.internal.preferences.DefaultPreferences;
+import org.eclipse.core.internal.preferences.EclipsePreferences;
+import org.eclipse.core.internal.preferences.PreferencesService;
+import org.eclipse.core.internal.preferences.PrefsMessages;
 import org.eclipse.core.internal.runtime.RuntimeLog;
-import org.eclipse.core.runtime.*;
-import org.eclipse.core.runtime.preferences.*;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.Preferences;
+import org.eclipse.core.runtime.Status;
+import org.eclipse.core.runtime.preferences.DefaultScope;
+import org.eclipse.core.runtime.preferences.IEclipsePreferences;
+import org.eclipse.core.runtime.preferences.InstanceScope;
 import org.osgi.service.prefs.BackingStoreException;
 
 /**
@@ -215,11 +224,9 @@ public boolean contains(String name) {
 	}
 
 	/**
-	 * Returns the current value of the boolean-valued property with the
-	 * given name.
-	 * Returns the default-default value (<code>false</code>) if there
-	 * is no property with the given name, or if the current value
-	 * cannot be treated as a boolean.
+	 * Returns the current value of the boolean-valued property with the given name.
+	 * Returns the default value (<code>false</code>) if there is no property with
+	 * the given name, or if the current value cannot be treated as a boolean.
 	 *
 	 * @param name the name of the property
 	 * @return the boolean-valued property
@@ -512,11 +519,9 @@ public void setDefault(String name, float value) {
 	}
 
 	/**
-	 * Returns the current value of the integer-valued property with the
-	 * given name.
-	 * Returns the default-default value (<code>0</code>) if there
-	 * is no property with the given name, or if the current value
-	 * cannot be treated as an integter.
+	 * Returns the current value of the integer-valued property with the given name.
+	 * Returns the default-default value (<code>0</code>) if there is no property
+	 * with the given name, or if the current value cannot be treated as an integer.
 	 *
 	 * @param name the name of the property
 	 * @return the int-valued property
diff --git a/runtime/bundles/org.eclipse.e4.core.services/src/org/eclipse/e4/core/internal/services/ResourceBundleTranslationProvider.java b/runtime/bundles/org.eclipse.e4.core.services/src/org/eclipse/e4/core/internal/services/ResourceBundleTranslationProvider.java
@@ -97,7 +97,7 @@ private String translate_rec(String key) {
 				result = translate_rec(underscorify(key));
 			}
 
-			// if no succes, try to de-underscorify and recurse
+			// if no success, try to de-underscorify and recurse
 			if (result == null && key.contains("_")) { //$NON-NLS-1$
 				result = translate_rec(key.replace('_', '.'));
 			}
diff --git a/team/bundles/org.eclipse.ui.net/src/org/eclipse/ui/internal/net/ProxyPreferencePage.java b/team/bundles/org.eclipse.ui.net/src/org/eclipse/ui/internal/net/ProxyPreferencePage.java
@@ -13,7 +13,7 @@
  * yyyymmdd bug      Email and other contact information
  * -------- -------- -----------------------------------------------------------
  * 20070123   154100 eu@md.pp.ru - Eugene Kuleshov, Initial UI coding
- * 20070201   154100 pmoogk@ca.ibm.com - Peter Moogk, Port internet code from WTP to Eclipse base.
+ * 20070201   154100 pmoogk@ca.ibm.com - Peter Moogk, Port Internet code from WTP to Eclipse base.
  * 20070219   174674 pmoogk@ca.ibm.com - Peter Moogk
  * 20070402   180622 brockj@tpg.com.au - Brock Janiczak, Inconsistent enablement states in network preference page
  * 20070416   177897 ymnk@jcraft.com - Atsuhiko Yamanaka, Improve UI of Proxy Preferences Page
@@ -28,8 +28,13 @@
 import org.eclipse.swt.events.SelectionEvent;
 import org.eclipse.swt.layout.GridData;
 import org.eclipse.swt.layout.GridLayout;
-import org.eclipse.swt.widgets.*;
-import org.eclipse.ui.*;
+import org.eclipse.swt.widgets.Combo;
+import org.eclipse.swt.widgets.Composite;
+import org.eclipse.swt.widgets.Control;
+import org.eclipse.swt.widgets.Label;
+import org.eclipse.ui.IWorkbench;
+import org.eclipse.ui.IWorkbenchPreferencePage;
+import org.eclipse.ui.PlatformUI;
 
 public class ProxyPreferencePage extends PreferencePage implements
 		IWorkbenchPreferencePage {
diff --git a/ua/org.eclipse.ui.intro.universal/src/org/eclipse/ui/internal/intro/universal/IUniversalIntroConstants.java b/ua/org.eclipse.ui.intro.universal/src/org/eclipse/ui/internal/intro/universal/IUniversalIntroConstants.java
@@ -47,7 +47,7 @@ public interface IUniversalIntroConstants {
 	// convention: actual string value is class name.
 	String INTRO_LINK = "IntroLink"; //$NON-NLS-1$
 
-	// key to retrive page sub-title from PageContentForm
+	// key to retrieve page sub-title from PageContentForm
 	String PAGE_SUBTITLE = "PageSubtitle"; //$NON-NLS-1$
 
 
diff --git a/ua/org.eclipse.ui.intro.universal/src/org/eclipse/ui/internal/intro/universal/util/Log.java b/ua/org.eclipse.ui.intro.universal/src/org/eclipse/ui/internal/intro/universal/util/Log.java
@@ -24,7 +24,7 @@
 
 /**
  * Utility class for logging, based on Platform logging classes. The log
- * listerner used is the base one supplied by the platform. Error messages are
+ * listener used is the base one supplied by the platform. Error messages are
  * always logged. Warning messages are only logged when the plugin is in debug
  * mode. Info messages are only logged when the /trace/logInfo debug option is
  * set to true. Performance reports are only logged when /trace/performance is
@@ -34,8 +34,8 @@ public class Log implements IUniversalIntroConstants {
 
 	/**
 	 * This MUST be set to <b>false </b> in production. <br>
-	 * Used to compile out developement debug messages. <br>
-	 * Compiler compiles out code warpped wit this flag as an optimization.
+	 * Used to compile out development debug messages. <br>
+	 * Compiler compiles out code wrapped with this flag as an optimization.
 	 */
 	public static final boolean DEBUG = false;
 
diff --git a/update/org.eclipse.update.configurator/src/org/eclipse/update/configurator/IPlatformConfiguration.java b/update/org.eclipse.update.configurator/src/org/eclipse/update/configurator/IPlatformConfiguration.java
@@ -343,12 +343,12 @@ public interface IFeatureEntry {
 	public ISiteEntry createSiteEntry(URL url, ISitePolicy policy);
 
 	/**
-	 * Create a site policy. The policy determines the way the site
-	 * plug-in are processed at startpu
+	 * Create a site policy. The policy determines the way the site plug-in are
+	 * processed at startup
 	 *
 	 * @param type policy type
 	 * @param list an array of site-relative paths representing the
-	 * inclusion/ exclusion list
+	 *             inclusion/exclusion list
 	 * @return created site policy entry
 	 * @since 2.0
 	 */
@@ -483,8 +483,9 @@ public interface IFeatureEntry {
 
 	/**
 	 * Locates the specified feature entry.
+	 *
 	 * @param id feature identifier
-	 * @return ferature entry, or <code>null</code>.
+	 * @return feature entry, or <code>null</code>.
 	 * @since 2.0
 	 */
 	@Deprecated
diff --git a/update/org.eclipse.update.configurator/src/org/eclipse/update/internal/configurator/PlatformConfiguration.java b/update/org.eclipse.update.configurator/src/org/eclipse/update/internal/configurator/PlatformConfiguration.java
@@ -715,7 +715,7 @@ private synchronized void initializeCurrent(Location platformConfigLocation) thr
 				}
 			}
 		} finally {
-			// releaes concurrent use lock
+			// release concurrent use lock
 			clearConfigurationLock();
 		}
 	}
diff --git a/update/org.eclipse.update.configurator/src/org/eclipse/update/internal/configurator/SiteEntry.java b/update/org.eclipse.update.configurator/src/org/eclipse/update/internal/configurator/SiteEntry.java
@@ -444,7 +444,7 @@ private void detectUnpackedPlugin(File file, boolean compareTimeStamps) {
 					// reliable,
 					// or that the user manually modified an existing plugin,
 					// so
-					// the apparently modifed plugin may actually be configured
+					// the apparently modified plugin may actually be configured
 					// already.
 					// We will need to double check for this. END to do.
 					if (compareTimeStamps
@@ -713,7 +713,7 @@ public Element toXML(Document doc) {
 			sb.append(list[list.length-1]);
 			siteElement.setAttribute(CFG_LIST, sb.toString());
 		}
-//		// note: we don't save features inside the site element.
+//		note: we don't save features inside the site element.
 
 		// collect feature entries
 //		configElement.setAttribute(CFG_FEATURE_ENTRY_DEFAULT, defaultFeature);
diff --git a/update/org.eclipse.update.configurator/src/org/eclipse/update/internal/configurator/Utils.java b/update/org.eclipse.update.configurator/src/org/eclipse/update/internal/configurator/Utils.java
@@ -515,8 +515,8 @@ public static synchronized URL getInstallURL() {
 
 		Location location = instanceLocation.getService();
 
-		// it is pretty much impossible for the install location to be null.  If it is, the
-		// system is in a bad way so throw and exception and get the heck outta here.
+		// It is unlikely for the install location to be null. If it is, the
+		// system is in an invalid state, so throw an exception and exit.
 		if (location == null) {
 			throw new IllegalStateException("The installation location must not be null"); //$NON-NLS-1$
 		}
diff --git a/update/org.eclipse.update.configurator/src/org/eclipse/update/internal/configurator/branding/AboutInfo.java b/update/org.eclipse.update.configurator/src/org/eclipse/update/internal/configurator/branding/AboutInfo.java
@@ -133,7 +133,7 @@ public String getFeatureImageName() {
 
 
 	/**
-	 * Returns a label for the feature plugn, or <code>null</code>.
+	 * Returns a label for the feature plugin, or <code>null</code>.
 	 */
 	public String getFeatureLabel() {
 		return featurePluginLabel;
diff --git a/update/org.eclipse.update.configurator/src/org/eclipse/update/internal/configurator/branding/IProductConstants.java b/update/org.eclipse.update.configurator/src/org/eclipse/update/internal/configurator/branding/IProductConstants.java
@@ -62,12 +62,12 @@ public interface IProductConstants {
 	public static final String WINDOW_IMAGE = "windowImage"; //$NON-NLS-1$
 
 	/**
-	 * An array of one or more images to be used for this product.  The
-	 * expectation is that the array will contain the same image rendered
-	 * at different sizes (16x16 and 32x32).
-	 * Products designed to run "headless" typically would not have such images.
+	 * An array of one or more images to be used for this product. The expectation
+	 * is that the array will contain the same image rendered at different sizes
+	 * (16x16 and 32x32). Products designed to run "headless" typically would not
+	 * have such images.
 	 * <p>
-	 * If this property is given, then it supercedes <code>WINDOW_IMAGE</code>.
+	 * If this property is given, then it supersedes <code>WINDOW_IMAGE</code>.
 	 * </p>
 	 */
 	public static final String WINDOW_IMAGES = "windowImages"; //$NON-NLS-1$
diff --git a/update/org.eclipse.update.configurator/src/org/eclipse/update/internal/configurator/branding/IniFileReader.java b/update/org.eclipse.update.configurator/src/org/eclipse/update/internal/configurator/branding/IniFileReader.java
@@ -200,7 +200,7 @@ public URL[] getURLs(String key) {
 	/**
 	 * Returns the feature plugin label, or <code>null</code>.
 	 *
-	 * @return the feature plugin lable, or <code>null</code> if none.
+	 * @return the feature plugin label, or <code>null</code> if none.
 	 */
 	public String getFeaturePluginLabel() {
 		if (bundle == null) {

Original file line number	Diff line number	Diff line change
`@@ -177,7 +177,7 @@ public int hashCode() {`
`177`	`177`	`* Sets the ant home to use.`
`178`	`178`	`*`
`179`	`179`	`* @param path`
`180`		`- * path to toor of an ant home installation`
	`180`	`+ * path to root of an ant home installation`
`181`	`181`	`*/`
`182`	`182`	`public void setAntHome(String path) {`
`183`	`183`	`antHomeLocation = path;`
Original file line number	Diff line number	Diff line change
`@@ -330,10 +330,10 @@ public static IProject[] getBuildProjects(ILaunchConfiguration configuration, St`
`330`	`330`	`}`
`331`	`331`
`332`	`332`	`/**`
`333`		`- * Whether referenced projects should be considered when building. Only valid`
`334`		`- * when a set of projects is to be built.`
	`333`	`+ * Whether referenced projects should be considered when building. Only`
	`334`	`+ * valid when a set of projects is to be built.`
`335`	`335`	`*`
`336`		`- * @return whether referenced projects should be considerd when building`
	`336`	`+ * @return whether referenced projects should be considered when building`
`337`	`337`	`* @throws CoreException if unable to access the associated attribute`
`338`	`338`	`*/`
`339`	`339`	`public static boolean isIncludeReferencedProjects(ILaunchConfiguration configuration, String includeReferencedProjectsId) throws CoreException {`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ public String resolveValue(IDynamicVariable variable, String argument) throws Co`
`68`	`68`	`deltas \|= IResourceDelta.REMOVED;`
`69`	`69`	`}`
`70`	`70`
`71`		`- // Check wether to include files and/or directories`
	`71`	`+ // Check whether to include files and/or directories`
`72`	`72`	`if (argument.indexOf(ARG_DIRS) > -1)`
`73`	`73`	`{`
`74`	`74`	`dirs = true;`
Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ private String translate_rec(String key) {`
`97`	`97`	`result = translate_rec(underscorify(key));`
`98`	`98`	`}`
`99`	`99`
`100`		`- // if no succes, try to de-underscorify and recurse`
	`100`	`+ // if no success, try to de-underscorify and recurse`
`101`	`101`	`if (result == null && key.contains("_")) { //$NON-NLS-1$`
`102`	`102`	`result = translate_rec(key.replace('_', '.'));`
`103`	`103`	`}`