Bug 200211 Malformed javadoc tags
diff --git a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/internal/runtime/LocalizationUtils.java b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/internal/runtime/LocalizationUtils.java
index ba6c64e..a679c7c 100644
--- a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/internal/runtime/LocalizationUtils.java
+++ b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/internal/runtime/LocalizationUtils.java
@@ -23,9 +23,9 @@
* use the NLS-based translation routine. If it falls, the method returns the original
* non-translated key.
*
- * @param key case-sensetive name of the filed in the translation file representing
+ * @param key case-sensitive name of the filed in the translation file representing
* the string to be translated
- * @return
+ * @return The localized message or the non-translated key
*/
static public String safeLocalize(String key) {
try {
diff --git a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/internal/runtime/RuntimeLog.java b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/internal/runtime/RuntimeLog.java
index 33a0229..c8ee9ea 100644
--- a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/internal/runtime/RuntimeLog.java
+++ b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/internal/runtime/RuntimeLog.java
@@ -34,7 +34,7 @@
private static ArrayList queuedMessages = new ArrayList(5);
/**
- * @see Platform#addLogListener(ILogListener)
+ * See org.eclipse.core.runtime.Platform#addLogListener(ILogListener)
*/
public static void addLogListener(ILogListener listener) {
synchronized (logListeners) {
@@ -60,7 +60,7 @@
}
/**
- * @see Platform#removeLogListener(ILogListener)
+ * See org.eclipse.core.runtime.Platform#removeLogListener(ILogListener)
*/
public static void removeLogListener(ILogListener listener) {
synchronized (logListeners) {
diff --git a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/ILogListener.java b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/ILogListener.java
index b104e83..9b68336 100644
--- a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/ILogListener.java
+++ b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/ILogListener.java
@@ -19,8 +19,6 @@
* </p><p>
* Clients may implement this interface.
* </p>
- * @see ILog#addLogListener(ILogListener)
- * @see Platform#addLogListener(ILogListener)
*/
public interface ILogListener extends EventListener {
/**
diff --git a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IProgressMonitorWithBlocking.java b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IProgressMonitorWithBlocking.java
index 3d0e358..ea578d5 100644
--- a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IProgressMonitorWithBlocking.java
+++ b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IProgressMonitorWithBlocking.java
@@ -46,7 +46,6 @@
* reason why this operation is blocked, or <code>null</code> if this
* information is not available.
* @see #clearBlocked()
- * @see org.eclipse.core.runtime.jobs.IJobStatus
*/
public void setBlocked(IStatus reason);
diff --git a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/ISafeRunnable.java b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/ISafeRunnable.java
index d321d35..5bb4439 100644
--- a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/ISafeRunnable.java
+++ b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/ISafeRunnable.java
@@ -20,7 +20,7 @@
* </p><p>
* Clients may implement this interface.
* </p>
- * @see Platform#run(ISafeRunnable)
+ * @see SafeRunner#run(ISafeRunnable)
*/
public interface ISafeRunnable {
/**
@@ -32,7 +32,7 @@
*
* @param exception an exception which occurred during processing
* the body of this runnable (i.e., in <code>run()</code>)
- * @see Platform#run(ISafeRunnable)
+ * @see SafeRunner#run(ISafeRunnable)
*/
public void handleException(Throwable exception);
@@ -43,7 +43,7 @@
*
* @exception Exception if a problem occurred while running this method.
* The exception will be processed by <code>handleException</code>
- * @see Platform#run(ISafeRunnable)
+ * @see SafeRunner#run(ISafeRunnable)
*/
public void run() throws Exception;
}
diff --git a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/PlatformObject.java b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/PlatformObject.java
index c32b24f..4f993af 100644
--- a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/PlatformObject.java
+++ b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/PlatformObject.java
@@ -19,12 +19,13 @@
* <p>
* Note: In situations where it would be awkward to subclass this
* class, the same affect can be achieved simply by implementing
- * the <code>IAdaptable</code> interface and explicitly forwarding
- * the <code>getAdapter</code> request to the platform's
- * adapter manager. The method would look like:
+ * the {@link IAdaptable} interface and explicitly forwarding
+ * the <code>getAdapter</code> request to an implementation
+ * of the {@link IAdapterManager} service. The method would look like:
* <pre>
* public Object getAdapter(Class adapter) {
- * return Platform.getAdapterManager().getAdapter(this, adapter);
+ * IAdapterManager manager = ...;//lookup the IAdapterManager service
+ * return manager.getAdapter(this, adapter);
* }
* </pre>
* </p><p>
@@ -33,7 +34,7 @@
* Clients may subclass.
* </p>
*
- * @see Platform#getAdapterManager()
+ * @see IAdapterManager
* @see IAdaptable
*/
public abstract class PlatformObject implements IAdaptable {
@@ -60,7 +61,6 @@
* @param adapter the class to adapt to
* @return the adapted object or <code>null</code>
* @see IAdaptable#getAdapter(Class)
- * @see Platform#getAdapterManager()
*/
public Object getAdapter(Class adapter) {
return AdapterManager.getDefault().getAdapter(this, adapter);
diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/OSGiPreferencesServiceImpl.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/OSGiPreferencesServiceImpl.java
index 30f5586..e98b291 100644
--- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/OSGiPreferencesServiceImpl.java
+++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/OSGiPreferencesServiceImpl.java
@@ -51,8 +51,6 @@
/**
* If pathName is absolute make it "absolute" with respect to this root.
* If pathName is relative, just return it
- * @param pathName
- * @return
*/
private String fixPath(String pathName) {
if (pathName.startsWith("/")) {
diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/exchange/ILegacyPreferences.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/exchange/ILegacyPreferences.java
index 34f93ae..105ea47 100644
--- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/exchange/ILegacyPreferences.java
+++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/exchange/ILegacyPreferences.java
@@ -18,12 +18,11 @@
*/
public interface ILegacyPreferences {
/**
- * The method tries to initialize the preferences using the legacy Plugin method.
+ * The method tries to initialize the preferences using the legacy
+ * Plugin#initializeDefaultPluginPreferences method.
*
* @param object - plugin to initialize
* @param name - ID of the plugin to be initialized
- *
- * @see Plugin#initializeDefaultPluginPreferences
*/
public Object init(Object object, String name);
}
diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/DefaultScope.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/DefaultScope.java
index 6acc393..1f30b65 100644
--- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/DefaultScope.java
+++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/DefaultScope.java
@@ -27,9 +27,9 @@
* </p>
* <p>
* Note about product preference customization:
- * Clients who define their own {@link org.eclipse.core.runtime.IProduct}
+ * Clients who define their own org.eclipse.core.runtime.IProduct
* are able to specify a product key of "<code>preferenceCustomization</code>".
- * (defined as a constant in {@link org.eclipse.ui.branding.IProductConstants})
+ * (defined as a constant in org.eclipse.ui.branding.IProductConstants)
* Its value is either a {@link java.net.URL} or a file-system path to a
* file whose contents are used to customize default preferences.
* </p>
diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/internal/registry/ExtensionRegistry.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/internal/registry/ExtensionRegistry.java
index 1f40412..2dbb7a5 100644
--- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/internal/registry/ExtensionRegistry.java
+++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/internal/registry/ExtensionRegistry.java
@@ -78,8 +78,8 @@
* Sets new cache file manager. If existing file manager was owned by the registry,
* closes it.
*
- * @param newFileManager - new cache file manager
- * @param registryOwnsManager - true: life cycle of the file manager is controlled by the registry
+ * @param cacheBase the base location for the registry cache
+ * @param isCacheReadOnly whether the file cache is read only
*/
protected void setFileManager(File cacheBase, boolean isCacheReadOnly) {
if (cacheStorageManager != null)
diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/internal/registry/ReferenceMap.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/internal/registry/ReferenceMap.java
index 2da387c..2224431 100644
--- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/internal/registry/ReferenceMap.java
+++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/internal/registry/ReferenceMap.java
@@ -240,8 +240,8 @@
}
/**
- * @param key
- * @return
+ * @param key The key to remove
+ * @return The removed map value
*/
private Object doRemove(int key) {
int index = indexFor(key);
diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/internal/registry/osgi/Activator.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/internal/registry/osgi/Activator.java
index b25d161..3b4a48f 100644
--- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/internal/registry/osgi/Activator.java
+++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/internal/registry/osgi/Activator.java
@@ -71,8 +71,6 @@
* Look for the no registry cache flag and check to see if we should NOT be lazily loading plug-in
* definitions from the registry cache file.
* NOTE: this command line processing is only performed in the presence of OSGi
- *
- * @param args - command line arguments
*/
private void processCommandLine() {
// use a string here instead of the class to prevent class loading.