Bug 579230 - fix Java-doc and NLS warnings
Change-Id: I6bfb09415c93cf487cd1b2319fd1362b0853d11f
Signed-off-by: Hannes Wellmann <wellmann.hannes1@gmx.net>
Reviewed-on: https://git.eclipse.org/r/c/pde/eclipse.pde.ui/+/191975
Tested-by: PDE Bot <pde-bot@eclipse.org>
Reviewed-by: Alexander Kurtakov <akurtako@redhat.com>
diff --git a/apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/util/tests/SignaturesTests.java b/apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/util/tests/SignaturesTests.java
index f457532..f2811f5 100644
--- a/apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/util/tests/SignaturesTests.java
+++ b/apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/util/tests/SignaturesTests.java
@@ -30,7 +30,6 @@
*
* @since 1.0.0
*/
-@SuppressWarnings("nls")
public class SignaturesTests {
/**
@@ -289,61 +288,61 @@
@Test
public void testMatchesInnerClasses() {
- assertTrue("Signatures should match", Signatures.matchesSignatures("(QInnerMost;)V", "(Lmy.package.Class$InnerMost;)V"));
- assertTrue("Signatures should match", Signatures.matchesSignatures("(QInnerMost;)V", "(Lmy.package.Class$Inner$InnerMost;)V"));
+ assertTrue("Signatures should match", Signatures.matchesSignatures("(QInnerMost;)V", "(Lmy.package.Class$InnerMost;)V")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ assertTrue("Signatures should match", Signatures.matchesSignatures("(QInnerMost;)V", "(Lmy.package.Class$Inner$InnerMost;)V")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
}
@Test
public void testMatchesArgumentPackages() {
- assertTrue("Same packages should match", Signatures.matchesSignatures("(Lmy.package.Class;)V", "(Lmy.package.Class;)V"));
- assertFalse("Differing packages should not match", Signatures.matchesSignatures("(Lmy.package.Class;)V", "(Lother.package.Class;)V"));
- assertFalse("Differing packages should not match", Signatures.matchesSignatures("(Lmy.package.Class$InnerMost;)V", "(Lother.package.Class$InnerMost;)V"));
+ assertTrue("Same packages should match", Signatures.matchesSignatures("(Lmy.package.Class;)V", "(Lmy.package.Class;)V")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ assertFalse("Differing packages should not match", Signatures.matchesSignatures("(Lmy.package.Class;)V", "(Lother.package.Class;)V")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ assertFalse("Differing packages should not match", Signatures.matchesSignatures("(Lmy.package.Class$InnerMost;)V", "(Lother.package.Class$InnerMost;)V")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
}
@Test
public void testMatchesGenericsBug456945_ex1() {
// This is the example from bug 456945
- assertTrue("Signatures should match", Signatures.matchesSignatures("(QIterable<+QCharSequence;>;QIAcceptor<QResult;>;)V", "(Ljava.lang.Iterable<+Ljava.lang.CharSequence;>;Lorg.eclipse.xtext.util.IAcceptor<Lorg.eclipse.xtext.xbase.compiler.CompilationTestHelper$Result;>;)V"));
+ assertTrue("Signatures should match", Signatures.matchesSignatures("(QIterable<+QCharSequence;>;QIAcceptor<QResult;>;)V", "(Ljava.lang.Iterable<+Ljava.lang.CharSequence;>;Lorg.eclipse.xtext.util.IAcceptor<Lorg.eclipse.xtext.xbase.compiler.CompilationTestHelper$Result;>;)V")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
}
@Test
public void testMatchesGenericsBug456945_ex2() {
// Modified example that included parameterized return type
- assertTrue("Wildcard signatures should match", Signatures.matchesSignatures("(QIterable<+QCharSequence;>;QIAcceptor<QResult;>;)QT;", "(Ljava.lang.Iterable<+Ljava.lang.CharSequence;>;Lorg.eclipse.xtext.util.IAcceptor<Lorg.eclipse.xtext.xbase.compiler.CompilationTestHelper$Result;>;)TT;"));
+ assertTrue("Wildcard signatures should match", Signatures.matchesSignatures("(QIterable<+QCharSequence;>;QIAcceptor<QResult;>;)QT;", "(Ljava.lang.Iterable<+Ljava.lang.CharSequence;>;Lorg.eclipse.xtext.util.IAcceptor<Lorg.eclipse.xtext.xbase.compiler.CompilationTestHelper$Result;>;)TT;")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
}
@Test
public void testMatchesGenericsBug334281_c1() {
// Example from bug 334281 comment 1
- assertTrue("Wildcard signatures should match", Signatures.matchesSignatures("(QClass<+QITmfEvent;>;QTmfTimeRange;JII)V", "(Ljava.lang.Class<+Lorg.eclipse.linuxtools.tmf.core.event.ITmfEvent;>;Lorg.eclipse.linuxtools.tmf.core.timestamp.TmfTimeRange;JII)V"));
+ assertTrue("Wildcard signatures should match", Signatures.matchesSignatures("(QClass<+QITmfEvent;>;QTmfTimeRange;JII)V", "(Ljava.lang.Class<+Lorg.eclipse.linuxtools.tmf.core.event.ITmfEvent;>;Lorg.eclipse.linuxtools.tmf.core.timestamp.TmfTimeRange;JII)V")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
// and heck, let's ensure arrays work too
- assertTrue("Array wildcard signatures should match", Signatures.matchesSignatures("(QClass<[+QITmfEvent;>;QTmfTimeRange;JII)V", "(Ljava.lang.Class<[+Lorg.eclipse.linuxtools.tmf.core.event.ITmfEvent;>;Lorg.eclipse.linuxtools.tmf.core.timestamp.TmfTimeRange;JII)V"));
+ assertTrue("Array wildcard signatures should match", Signatures.matchesSignatures("(QClass<[+QITmfEvent;>;QTmfTimeRange;JII)V", "(Ljava.lang.Class<[+Lorg.eclipse.linuxtools.tmf.core.event.ITmfEvent;>;Lorg.eclipse.linuxtools.tmf.core.timestamp.TmfTimeRange;JII)V")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
}
@Test
public void testMatchesMismatchedGenericTypes() {
- assertFalse("Different generic type names should not match", Signatures.matchesSignatures("(QIterable<QCharSequence;>;)V", "(QList<QCharSequence;>;)V"));
+ assertFalse("Different generic type names should not match", Signatures.matchesSignatures("(QIterable<QCharSequence;>;)V", "(QList<QCharSequence;>;)V")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
}
/** Tests the {@link Signatures#matches(String, String)} method */
@Test
public void testTypeMatches() {
- assertTrue("Signatures should match", Signatures.matches("I", "I"));
- assertTrue("Signatures should match", Signatures.matches("QClass;", "Ljava.lang.Class;"));
- assertTrue("Signatures should match", Signatures.matches("Ljava.lang.Class;", "Ljava.lang.Class;"));
- assertTrue("Signatures should match", Signatures.matches("QClass;", "QClass;"));
- assertTrue("Signatures should match", Signatures.matches("QClass<QITmfEvent;>;", "Ljava.lang.Class<Lorg.eclipse.linuxtools.tmf.core.event.ITmfEvent;>;"));
- assertFalse("Signatures should not match", Signatures.matches("QIterable<QCharSequence;>;", "QList<QCharSequence;>;"));
- assertFalse("Signatures should not match", Signatures.matches("QList<QCharSequence;>;", "Ljava.lang.Iterable<QCharSequence;>;"));
- assertFalse("Differing packages should not match", Signatures.matches("Lmy.package.Class;", "Lother.package.Class;"));
- assertFalse("Differing packages should not match", Signatures.matches("Lmy.package.Class$InnerMost;", "Lother.package.Class$InnerMost;"));
- assertTrue("Inner class should match", Signatures.matches("QInnerMost;", "Lmy.package.Class$InnerMost;"));
- assertTrue("Signatures should match", Signatures.matches("QInnerMost;", "Lmy.package.Class$Inner$InnerMost;")); //$NON-NLS-1$
- assertTrue("Super signatures should match", Signatures.matches("QClass<-QITmfEvent;>;", "Ljava.lang.Class<-Lorg.eclipse.linuxtools.tmf.core.event.ITmfEvent;>;"));
- assertTrue("Extends signatures should match", Signatures.matches("QClass<+QITmfEvent;>;", "Ljava.lang.Class<+Lorg.eclipse.linuxtools.tmf.core.event.ITmfEvent;>;"));
- assertTrue("Unbound wildcard signatures should match", Signatures.matches("QClass<*>;", "Ljava.lang.Class<*>;"));
- assertFalse("Different wildcard signatures should not match", Signatures.matches("QClass<+QITmfEvent;>;", "Ljava.lang.Class<-Lorg.eclipse.linuxtools.tmf.core.event.ITmfEvent;>;"));
- assertFalse("Different wildcard signatures should not match", Signatures.matches("QClass<+QITmfEvent;>;", "Ljava.lang.Class<*>;"));
+ assertTrue("Signatures should match", Signatures.matches("I", "I")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ assertTrue("Signatures should match", Signatures.matches("QClass;", "Ljava.lang.Class;")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ assertTrue("Signatures should match", Signatures.matches("Ljava.lang.Class;", "Ljava.lang.Class;")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ assertTrue("Signatures should match", Signatures.matches("QClass;", "QClass;")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ assertTrue("Signatures should match", Signatures.matches("QClass<QITmfEvent;>;", "Ljava.lang.Class<Lorg.eclipse.linuxtools.tmf.core.event.ITmfEvent;>;")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ assertFalse("Signatures should not match", Signatures.matches("QIterable<QCharSequence;>;", "QList<QCharSequence;>;")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ assertFalse("Signatures should not match", Signatures.matches("QList<QCharSequence;>;", "Ljava.lang.Iterable<QCharSequence;>;")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ assertFalse("Differing packages should not match", Signatures.matches("Lmy.package.Class;", "Lother.package.Class;")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ assertFalse("Differing packages should not match", Signatures.matches("Lmy.package.Class$InnerMost;", "Lother.package.Class$InnerMost;")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ assertTrue("Inner class should match", Signatures.matches("QInnerMost;", "Lmy.package.Class$InnerMost;")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ assertTrue("Signatures should match", Signatures.matches("QInnerMost;", "Lmy.package.Class$Inner$InnerMost;")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ assertTrue("Super signatures should match", Signatures.matches("QClass<-QITmfEvent;>;", "Ljava.lang.Class<-Lorg.eclipse.linuxtools.tmf.core.event.ITmfEvent;>;")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ assertTrue("Extends signatures should match", Signatures.matches("QClass<+QITmfEvent;>;", "Ljava.lang.Class<+Lorg.eclipse.linuxtools.tmf.core.event.ITmfEvent;>;")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ assertTrue("Unbound wildcard signatures should match", Signatures.matches("QClass<*>;", "Ljava.lang.Class<*>;")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ assertFalse("Different wildcard signatures should not match", Signatures.matches("QClass<+QITmfEvent;>;", "Ljava.lang.Class<-Lorg.eclipse.linuxtools.tmf.core.event.ITmfEvent;>;")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ assertFalse("Different wildcard signatures should not match", Signatures.matches("QClass<+QITmfEvent;>;", "Ljava.lang.Class<*>;")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
}
/**
diff --git a/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/util/ManifestUtils.java b/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/util/ManifestUtils.java
index 4536b1e..249f44e 100644
--- a/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/util/ManifestUtils.java
+++ b/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/util/ManifestUtils.java
@@ -75,8 +75,8 @@
* be checked for an old style plug-in.
* <p>
* If this method is being called from a dev mode workspace, the returned map
- * should be passed to {@link TargetWeaver#weaveManifest(Map)} so that the
- * bundle classpath can be corrected.
+ * should be passed to {@link TargetWeaver#weaveManifest(Map, File)} so that the
+ * bundle classpath can be corrected.
* </p>
* <p>
* This method is called by
diff --git a/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/launcher/LaunchArgumentsHelper.java b/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/launcher/LaunchArgumentsHelper.java
index 084b8a1..b576171 100644
--- a/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/launcher/LaunchArgumentsHelper.java
+++ b/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/launcher/LaunchArgumentsHelper.java
@@ -264,7 +264,6 @@
*
* @param packageName name of the launcher package, typically {@link IPDEBuildConstants#BUNDLE_EQUINOX_LAUNCHER}
* @return the path to the equinox launcher jar or <code>null</code>
- * @throws CoreException
*/
private static String getEquinoxStartupPath(String packageName) throws CoreException {
// See if PDE has the launcher in the workspace or target
diff --git a/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/launcher/LaunchConfigurationHelper.java b/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/launcher/LaunchConfigurationHelper.java
index 044353f..4afc7ae 100644
--- a/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/launcher/LaunchConfigurationHelper.java
+++ b/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/launcher/LaunchConfigurationHelper.java
@@ -105,7 +105,6 @@
* @param bundlesWithStartLevels map of plug-in model to a string containing start level information
* @param configurationDirectory config directory where the created files will be placed
* @return a properties object containing the properties written out to config.ini
- * @throws CoreException
*/
public static Properties createConfigIniFile(ILaunchConfiguration configuration, String productID, Map<String, List<IPluginModelBase>> bundles, Map<IPluginModelBase, String> bundlesWithStartLevels, File configurationDirectory) throws CoreException {
Properties properties = null;
diff --git a/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/launcher/LaunchListener.java b/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/launcher/LaunchListener.java
index e6e0e28..073697e 100644
--- a/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/launcher/LaunchListener.java
+++ b/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/launcher/LaunchListener.java
@@ -156,7 +156,6 @@
* in configuration location or null if none found.
*
* @returns log file or null
- * @throws CoreException
* @since 3.4
*/
public static File getMostRecentLogFile(ILaunchConfiguration configuration) throws CoreException {
diff --git a/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/launcher/OSGiFrameworkManager.java b/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/launcher/OSGiFrameworkManager.java
index a2e1580..54cc0e0 100644
--- a/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/launcher/OSGiFrameworkManager.java
+++ b/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/launcher/OSGiFrameworkManager.java
@@ -128,7 +128,7 @@
/**
* Returns the {@link IConfigurationElement} for the framework with the given ID
* or <code>null</code> if no element exists with that ID.
- * @param frameworkId
+ * @param frameworkId the id of the framework to return
* @return the {@link IConfigurationElement} for the framework with the given ID or <code>null</code>
*
* @since 3.5
diff --git a/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/sourcelookup/PDESourceLookupQuery.java b/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/sourcelookup/PDESourceLookupQuery.java
index 5919a45..a4ab796 100644
--- a/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/sourcelookup/PDESourceLookupQuery.java
+++ b/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/sourcelookup/PDESourceLookupQuery.java
@@ -154,7 +154,6 @@
* @param object Bundle class loader object
* @param typeName fully qualified name of the source type being searched for
* @return source element
- * @throws CoreException
*/
protected Object findSourceElement34(IJavaObject object, String typeName) throws CoreException {
IJavaObject manager = getObject(object, "manager", false); //$NON-NLS-1$
@@ -176,7 +175,6 @@
* @param object Bundle class loader object
* @param typeName fully qualified name of the source type being searched for
* @return source element
- * @throws CoreException
*/
protected Object findSourceElement(IJavaObject object, String typeName) throws CoreException {
IJavaObject manager = getObject(object, "manager", false); //$NON-NLS-1$
@@ -210,10 +208,9 @@
* Search a bundle's class path entries for source for the type of given name.
* This is used for 3.5 and greater.
*
- * @param entriesOwner
- * @param typeName
+ * @param entriesOwner the java object providing the classpath entries
+ * @param typeName qualified name of source
* @return source object or <code>null</code>
- * @throws CoreException
*/
private Object searchClasspathEntries(IJavaObject entriesOwner, String typeName) throws CoreException {
IJavaObject cpeArray = getObject(entriesOwner, "entries", false); //$NON-NLS-1$
@@ -280,7 +277,6 @@
* @param typeName qualified name of source
* @param checkFragments whether to guess at fragments
* @return source element or <code>null</code>
- * @throws CoreException
*/
private Object getSourceElement(String location, String id, String typeName, boolean checkFragments) throws CoreException {
if (location != null && id != null) {
