Remove blank Javadoc

This commit cleans up Javadoc that does not add information. It resolves ecj warnings: `Javadoc: Description expected after ...` It helps to prevent future empty javadoc by disabling missingJavaDoc warnings. This resolves `Javadoc: Missing ...` The modification is a result of regular expression search&replace: in files `*.java` `^[\s]*\*[\s]*(@return|@param[\s]*[^\s]+|@throws[\s]*[^\s]+)\R([\s]*\*[\s]*@|[\s]*\*/\R)` ->`$2` `^([\s]*\*[\s]*\R)([\s]*\*/\R)` ->`$2` `^[\S\t]*/\*\*\R[\s]*\*/\R` ->`` in files `org.eclipse.jdt.core.prefs` `org\.eclipse\.jdt\.core\.compiler\.problem\.missingJavadoc(Comments|Tags)\=[^\s]*` ->`org\.eclipse\.jdt\.core\.compiler\.problem\.missingJavadoc$1\=ignore`
eclipse-platform · Nov 29, 2023 · 405dab7 · 405dab7
1 parent 2bcb23f
commit 405dab7
Show file tree

Hide file tree

Showing 800 changed files with 27 additions and 2,841 deletions.
diff --git a/ant/org.eclipse.ant.core/src/org/eclipse/ant/core/AntCorePlugin.java b/ant/org.eclipse.ant.core/src/org/eclipse/ant/core/AntCorePlugin.java
@@ -165,7 +165,6 @@ public class AntCorePlugin extends Plugin {
 	 * </p>
 	 *
 	 * @since 3.1
-	 *
 	 */
 	public AntCorePlugin() {
 		plugin = this;

diff --git a/ant/org.eclipse.ant.core/src/org/eclipse/ant/core/AntCorePreferences.java b/ant/org.eclipse.ant.core/src/org/eclipse/ant/core/AntCorePreferences.java
@@ -673,10 +673,6 @@ private URL getClasspathEntryURL(Bundle bundle, String library) throws IOExcepti
 	/**
 	 * Configures the given {@link AntObject} and returns if it should be retained
 	 *
-	 * @param element
-	 * @param antObject
-	 * @param objectName
-	 * @param errorMessage
 	 * @return <code>true</code> if the object configured and should be retained, <code>false</code> otherwise
 	 */
 	private boolean configureAntObject(IConfigurationElement element, AntObject antObject, String objectName, String errorMessage) {
@@ -974,11 +970,6 @@ private URL[] getLocationURLs(File location) throws MalformedURLException {
 
 	/**
 	 * Add the libraries contributed by the Ant plug-in, to the classpath.
-	 *
-	 * @param source
-	 * @param destination
-	 * @throws IOException
-	 * @throws MalformedURLException
 	 */
 	private void addLibraries(Bundle source, List<AntClasspathEntry> destination) throws IOException, MalformedURLException {
 		ManifestElement[] libraries = null;

diff --git a/ant/org.eclipse.ant.core/src/org/eclipse/ant/internal/core/AntCoreUtil.java b/ant/org.eclipse.ant.core/src/org/eclipse/ant/internal/core/AntCoreUtil.java
@@ -138,9 +138,7 @@ public static File getFileRelativeToBaseDir(String fileName, String base, String
 	 *            the names of the properties files to load from
 	 * @param base
 	 *            the base directory name
-	 * @param buildFileLocation
 	 * @return a list of {@link Properties} objects for each filename
-	 * @throws IOException
 	 */
 	public static List<Properties> loadPropertyFiles(List<String> fileNames, String base, String buildFileLocation) throws IOException {
 		ArrayList<Properties> allProperties = new ArrayList<>(fileNames.size());

diff --git a/...core/src/org/eclipse/ant/internal/core/contentDescriber/AntBuildfileContentDescriber.java b/...core/src/org/eclipse/ant/internal/core/contentDescriber/AntBuildfileContentDescriber.java
@@ -46,8 +46,6 @@ public final class AntBuildfileContentDescriber extends XMLContentDescriber impl
 	 * @param contents the contents to be evaluated
 	 *
 	 * @return one of the following:<ul> <li><code>VALID</code></li>, <li><code>INVALID</code></li>, <li><code>INDETERMINATE</code></li> </ul>
-	 *
-	 * @throws IOException
 	 */
 	private int checkCriteria(InputSource contents) throws IOException {
 		AntHandler antHandler = new AntHandler();

diff --git a/ant/org.eclipse.ant.core/src_ant/org/eclipse/ant/internal/core/ant/InternalAntRunner.java b/ant/org.eclipse.ant.core/src_ant/org/eclipse/ant/internal/core/ant/InternalAntRunner.java
@@ -285,8 +285,6 @@ private void setProperties(Project project, boolean substituteVariables) {
 
 	/**
 	 * Sets the default <code>ant.file</code> and <code>ant.version</code> properties in the given {@link Project}
-	 *
-	 * @param project
 	 */
 	protected void setBuiltInProperties(Project project) {
 		// note also see processAntHome for system properties that are set
@@ -847,9 +845,6 @@ protected void fireBuildStarted(Project project) {
 
 	/**
 	 * Sends the the event to the backing project that the build has completed
-	 *
-	 * @param project
-	 * @param error
 	 */
 	protected void fireBuildFinished(Project project, Throwable error) {
 		if (usingXmlLogger()) {
@@ -1377,8 +1372,6 @@ private boolean processProperties(List<String> commands) {
 
 	/**
 	 * Process properties specified using <code>-D</code>
-	 *
-	 * @param commands
 	 */
 	protected void processMinusDProperties(List<String> commands) {
 		if (!commands.isEmpty() && userProperties == null) {

diff --git a/ant/org.eclipse.ant.launching/src/org/eclipse/ant/internal/launching/AntLaunchingUtil.java b/ant/org.eclipse.ant.launching/src/org/eclipse/ant/internal/launching/AntLaunchingUtil.java
@@ -285,8 +285,6 @@ public static IFile getFile(String fullPath) {
 	 *
 	 * Attempts to handle linked files; the first found linked file with the correct path is returned.
 	 *
-	 * @param path
-	 * @param buildFileParent
 	 * @return file or <code>null</code>
 	 * @see org.eclipse.core.resources.IWorkspaceRoot#findFilesForLocation(IPath)
 	 */

diff --git a/...lipse.ant.launching/src/org/eclipse/ant/internal/launching/debug/model/AntStackFrame.java b/...lipse.ant.launching/src/org/eclipse/ant/internal/launching/debug/model/AntStackFrame.java
@@ -37,7 +37,6 @@ public class AntStackFrame extends AntDebugElement implements IStackFrame {
 	/**
 	 * Constructs a stack frame in the given thread with the given id.
 	 *
-	 * @param antThread
 	 * @param id
 	 *            stack frame id (0 is the top of the stack)
 	 */

diff --git a/...g.eclipse.ant.launching/src/org/eclipse/ant/internal/launching/debug/model/AntThread.java b/...g.eclipse.ant.launching/src/org/eclipse/ant/internal/launching/debug/model/AntThread.java
@@ -92,7 +92,6 @@ public synchronized IStackFrame[] getStackFrames() throws DebugException {
 
 	/**
 	 * Retrieves the current stack frames in the thread possibly waiting until the frames are populated
-	 *
 	 */
 	private void getStackFrames0() throws DebugException {
 		synchronized (fFrames) {

diff --git a/...ng/src/org/eclipse/ant/internal/launching/launchConfigurations/AntHomeClasspathEntry.java b/...ng/src/org/eclipse/ant/internal/launching/launchConfigurations/AntHomeClasspathEntry.java
@@ -159,8 +159,6 @@ public boolean equals(Object obj) {
 	/**
 	 * Return whether s1 is equivalent to s2.
 	 *
-	 * @param s1
-	 * @param s2
 	 * @return whether s1 is equivalent to s2
 	 */
 	private boolean equalsOrNull(String s1, String s2) {

diff --git a/...unching/src/org/eclipse/ant/internal/launching/launchConfigurations/AntStreamMonitor.java b/...unching/src/org/eclipse/ant/internal/launching/launchConfigurations/AntStreamMonitor.java
@@ -43,8 +43,6 @@ public void removeListener(IStreamListener listener) {
 
 	/**
 	 * Appends the given message to this stream, and notifies listeners.
-	 *
-	 * @param message
 	 */
 	public void append(String message) {
 		if (isBuffered()) {

diff --git a/...aunching/src/org/eclipse/ant/internal/launching/launchConfigurations/AntStreamsProxy.java b/...aunching/src/org/eclipse/ant/internal/launching/launchConfigurations/AntStreamsProxy.java
@@ -17,9 +17,6 @@
 import org.eclipse.debug.core.model.IStreamMonitor;
 import org.eclipse.debug.core.model.IStreamsProxy;
 
-/**
- *
- */
 public class AntStreamsProxy implements IStreamsProxy {
 
 	private final AntStreamMonitor fErrorMonitor = new AntStreamMonitor();

diff --git a/ant/org.eclipse.ant.tests.core/tests/org/eclipse/ant/tests/core/AbstractAntTest.java b/ant/org.eclipse.ant.tests.core/tests/org/eclipse/ant/tests/core/AbstractAntTest.java
@@ -69,7 +69,6 @@ public void setUp() throws Exception {
 	/**
 	 * Ensure the welcome screen is closed because in 4.x the debug perspective opens a giant fast-view causing issues
 	 * 
-	 * @throws Exception
 	 * @since 3.8
 	 */
 	void assertWelcomeScreenClosed() throws Exception {
@@ -100,7 +99,6 @@ public IStatus runInUIThread(IProgressMonitor monitor) {
 	/**
 	 * Asserts that the test project has been created and all testing resources have been loaded each time the {@link #setUp()} method is called
 	 * 
-	 * @throws Exception
 	 * @since 3.5
 	 */
 	protected void assertProject() throws Exception {

diff --git a/ant/org.eclipse.ant.tests.core/tests/org/eclipse/ant/tests/core/tests/FrameworkTests.java b/ant/org.eclipse.ant.tests.core/tests/org/eclipse/ant/tests/core/tests/FrameworkTests.java
@@ -44,9 +44,6 @@ public class FrameworkTests extends AbstractAntTest {
 	/**
 	 * Ensures that the deprecated means of setting the class path still works correctly Do not fix deprecations unless the deprecated methods are
 	 * being removed.
-	 * 
-	 * @throws MalformedURLException
-	 * @throws CoreException
 	 */
 	@SuppressWarnings("deprecation")
 	@Test
@@ -141,8 +138,6 @@ public void testNoDefaultTarget() throws CoreException {
 
 	/**
 	 * Regression test for running a specific target from a script that has no default target. Associated with bug 294502.
-	 * 
-	 * @throws CoreException
 	 */
 	@Test
 	public void testSpecificTargetWithNoDefaultTarget() throws CoreException {
@@ -275,8 +270,6 @@ public void testGetTargets() throws CoreException {
 
 	/**
 	 * Tests bug 389564 for a class path entry as a url representing a remote file system location
-	 * 
-	 * @throws MalformedURLException
 	 */
 	@Test
 	public void testAntClasspathEntryFromUrl() throws MalformedURLException {

diff --git a/ant/org.eclipse.ant.tests.core/tests/org/eclipse/ant/tests/core/tests/OptionTests.java b/ant/org.eclipse.ant.tests.core/tests/org/eclipse/ant/tests/core/tests/OptionTests.java
@@ -313,7 +313,6 @@ public void testSpecifyBadTargetAsArg() throws CoreException {
 	/**
 	 * Tests specifying both a non-existent target and an existent target in the
 	 * command line
-	 * 
 	 */
 	@Test
 	public void testSpecifyBothBadAndGoodTargetsAsArg() throws CoreException {

diff --git a/ant/org.eclipse.ant.tests.core/tests/org/eclipse/ant/tests/core/tests/TaskTests.java b/ant/org.eclipse.ant.tests.core/tests/org/eclipse/ant/tests/core/tests/TaskTests.java
@@ -36,8 +36,6 @@ public class TaskTests extends AbstractAntTest {
 
 	/**
 	 * Testing the old deprecated API
-	 * 
-	 * @throws CoreException
 	 */
 	@SuppressWarnings("deprecation")
 	@Test

diff --git a/...pse.ant.tests.ui/Ant Debug Tests/org/eclipse/ant/tests/ui/debug/AbstractAntDebugTest.java b/...pse.ant.tests.ui/Ant Debug Tests/org/eclipse/ant/tests/ui/debug/AbstractAntDebugTest.java
@@ -127,7 +127,6 @@ protected IBreakpointManager getBreakpointManager() {
 	/**
 	 * Returns the source folder with the given name in the given project.
 	 * 
-	 * @param project
 	 * @param name
 	 *            source folder name
 	 * @return package fragment root
@@ -358,7 +357,6 @@ protected AntDebugTarget debugLaunchAndTerminate(ILaunchConfiguration config, in
 	 * @param bp
 	 *            the breakpoint that should cause a suspend event
 	 * @return thread in which the first suspend event occurred
-	 * @throws CoreException
 	 */
 	protected AntThread launchToLineBreakpoint(String buildFileName, ILineBreakpoint bp) throws CoreException {
 		ILaunchConfiguration config = getLaunchConfiguration(buildFileName);
@@ -375,7 +373,6 @@ protected AntThread launchToLineBreakpoint(String buildFileName, ILineBreakpoint
 	 * @param bp
 	 *            the breakpoint that should cause a suspend event
 	 * @return thread in which the first suspend event occurred
-	 * @throws CoreException
 	 */
 	protected AntThread launchToLineBreakpoint(ILaunchConfiguration config, ILineBreakpoint bp) throws CoreException {
 		DebugEventWaiter waiter = new DebugElementKindEventDetailWaiter(DebugEvent.SUSPEND, AntThread.class, DebugEvent.BREAKPOINT);
@@ -437,7 +434,6 @@ protected AntThread resume(AntThread thread, int timeout) throws Exception {
 	 * @param resumeThread
 	 *            thread to resume
 	 * @return thread in which the first suspend event occurs
-	 * @throws CoreException
 	 */
 	protected AntThread resumeToLineBreakpoint(AntThread resumeThread, ILineBreakpoint bp) throws CoreException {
 		DebugEventWaiter waiter = new DebugElementKindEventDetailWaiter(DebugEvent.SUSPEND, AntThread.class, DebugEvent.BREAKPOINT);
@@ -520,7 +516,6 @@ protected IResource getBreakpointResource(String typeName) throws Exception {
 	 *            line number
 	 * @param file
 	 *            the build file
-	 * @throws CoreException
 	 */
 	protected AntLineBreakpoint createLineBreakpoint(int lineNumber, IFile file) throws CoreException {
 		return new AntLineBreakpoint(file, lineNumber);
@@ -609,7 +604,6 @@ protected IBreakpoint getBreakpoint(IThread thread) {
 	 * 
 	 * @param frame
 	 *            stack frame to step in
-	 * @throws DebugException
 	 */
 	protected AntThread stepOver(AntStackFrame frame) throws DebugException {
 		org.eclipse.ant.tests.ui.testplugin.DebugEventWaiter waiter = new DebugElementKindEventDetailWaiter(DebugEvent.SUSPEND, AntThread.class, DebugEvent.STEP_END);
@@ -630,7 +624,6 @@ protected AntThread stepOver(AntStackFrame frame) throws DebugException {
 	 * 
 	 * @param frame
 	 *            stack frame to step in
-	 * @throws DebugException
 	 */
 	protected AntThread stepOverToHitBreakpoint(AntStackFrame frame) throws DebugException {
 		org.eclipse.ant.tests.ui.testplugin.DebugEventWaiter waiter = new DebugElementKindEventDetailWaiter(DebugEvent.SUSPEND, AntThread.class, DebugEvent.BREAKPOINT);

diff --git a/...g.eclipse.ant.tests.ui/Ant Debug Tests/org/eclipse/ant/tests/ui/debug/RunToLineTests.java b/...g.eclipse.ant.tests.ui/Ant Debug Tests/org/eclipse/ant/tests/ui/debug/RunToLineTests.java
@@ -76,8 +76,6 @@ public void perspectiveChanged(IWorkbenchPage page, IPerspectiveDescriptor persp
 
 	/**
 	 * Test a run to line, with no extra breakpoints.
-	 * 
-	 * @throws Exception
 	 */
 	@Test
 	public void testRunToLine() throws Exception {
@@ -86,8 +84,6 @@ public void testRunToLine() throws Exception {
 
 	/**
 	 * Test a run to line, with no extra breakpoints in separate VM.
-	 * 
-	 * @throws Exception
 	 */
 	@Test
 	public void testRunToLineSepVM() throws Exception {
@@ -96,8 +92,6 @@ public void testRunToLineSepVM() throws Exception {
 
 	/**
 	 * Test a run to line, with an extra breakpoint, and preference to skip
-	 * 
-	 * @throws Exception
 	 */
 	@Test
 	public void testRunToLineSkipBreakpoint() throws Exception {
@@ -108,8 +102,6 @@ public void testRunToLineSkipBreakpoint() throws Exception {
 	/**
 	 * Test a run to line, with an extra breakpoint, and preference to skip in a
 	 * separate VM
-	 * 
-	 * @throws Exception
 	 */
 	@Test
 	public void testRunToLineSkipBreakpointSepVM() throws Exception {
@@ -119,8 +111,6 @@ public void testRunToLineSkipBreakpointSepVM() throws Exception {
 
 	/**
 	 * Test a run to line, with an extra breakpoint, and preference to *not* skip
-	 * 
-	 * @throws Exception
 	 */
 	@Test
 	public void testRunToLineHitBreakpoint() throws Exception {
@@ -130,8 +120,6 @@ public void testRunToLineHitBreakpoint() throws Exception {
 
 	/**
 	 * Test a run to line, with an extra breakpoint, and preference to *not* skip
-	 * 
-	 * @throws Exception
 	 */
 	@Test
 	public void testRunToLineHitBreakpointSepVM() throws Exception {
@@ -149,7 +137,6 @@ public void testRunToLineHitBreakpointSepVM() throws Exception {
 	 *                           skip breakpoints is off).
 	 * @param skipBreakpoints    preference value for "skip breakpoints during run
 	 *                           to line"
-	 * @throws Exception
 	 */
 	public void runToLine(final int lineNumber, int expectedLineNumber, boolean skipBreakpoints, boolean sepVM)
 			throws Exception {

diff --git a/...rg.eclipse.ant.tests.ui/Ant Debug Tests/org/eclipse/ant/tests/ui/debug/SteppingTests.java b/...rg.eclipse.ant.tests.ui/Ant Debug Tests/org/eclipse/ant/tests/ui/debug/SteppingTests.java
@@ -181,8 +181,6 @@ private AntStackFrame assertFrame(String frameName, int lineNumber, AntStackFram
 
 	/**
 	 * bug 85309
-	 * 
-	 * @throws CoreException
 	 */
 	@Test
 	public void testStepOutOfMacrodef() throws CoreException {
@@ -192,8 +190,6 @@ public void testStepOutOfMacrodef() throws CoreException {
 
 	/**
 	 * bug 85309
-	 * 
-	 * @throws CoreException
 	 */
 	@Test
 	public void testStepOutOfMacrodefSepVM() throws CoreException {
@@ -203,8 +199,6 @@ public void testStepOutOfMacrodefSepVM() throws CoreException {
 
 	/**
 	 * bug 94769
-	 * 
-	 * @throws CoreException
 	 */
 	@Test
 	public void testStepIntoMacrodef() throws CoreException {
@@ -213,8 +207,6 @@ public void testStepIntoMacrodef() throws CoreException {
 
 	/**
 	 * bug 94769
-	 * 
-	 * @throws CoreException
 	 */
 	@Test
 	public void testStepIntoMacrodefSepVM() throws CoreException {

diff --git a/...lipse.ant.tests.ui/Ant Debug Tests/org/eclipse/ant/tests/ui/debug/TestAgainException.java b/...lipse.ant.tests.ui/Ant Debug Tests/org/eclipse/ant/tests/ui/debug/TestAgainException.java
@@ -27,8 +27,6 @@ public class TestAgainException extends RuntimeException {
 
 	/**
 	 * Constructor
-	 * 
-	 * @param string
 	 */
 	public TestAgainException(String string) {
 		super(string);

diff --git a/...sts.ui/Ant Editor Tests/org/eclipse/ant/tests/ui/editor/AntEditorContentOutlineTests.java b/...sts.ui/Ant Editor Tests/org/eclipse/ant/tests/ui/editor/AntEditorContentOutlineTests.java
@@ -33,7 +33,6 @@
 
 /**
  * Tests the correct creation of the outline for an xml file.
- *
  */
 public class AntEditorContentOutlineTests extends AbstractAntUITest {
 

diff --git a/...pse.ant.tests.ui/Ant Editor Tests/org/eclipse/ant/tests/ui/editor/CodeCompletionTest.java b/...pse.ant.tests.ui/Ant Editor Tests/org/eclipse/ant/tests/ui/editor/CodeCompletionTest.java
@@ -55,7 +55,6 @@
 
 /**
  * Tests everything about code completion and code assistance.
- *
  */
 @SuppressWarnings("restriction")
 public class CodeCompletionTest extends AbstractAntUITest {