Fix several Javadoc errors in org.eclipse.core.tests.resources

HeikoKlare · Nov 3, 2023 · 7e45fa6 · 7e45fa6
1 parent 6beceea
commit 7e45fa6
Show file tree

Hide file tree

Showing 12 changed files with 9 additions and 94 deletions.
diff --git a/...ts.resources/src/org/eclipse/core/tests/internal/builders/BuildDeltaVerificationTest.java b/...ts.resources/src/org/eclipse/core/tests/internal/builders/BuildDeltaVerificationTest.java
@@ -51,8 +51,6 @@ public BuildDeltaVerificationTest(String name) {
 
 	/**
 	 * Tests that the builder is receiving an appropriate delta
-	 * @see SortBuilderPlugin
-	 * @see SortBuilder
 	 */
 	public void assertDelta() {
 		if (!verifier.isDeltaValid()) {
@@ -134,8 +132,6 @@ protected void setUp() throws Exception {
 
 	/**
 	 * Tests that the builder is receiving an appropriate delta
-	 * @see SortBuilderPlugin
-	 * @see SortBuilder
 	 */
 	public void testAddAndRemoveFile() {
 		try {
@@ -155,8 +151,6 @@ public void testAddAndRemoveFile() {
 
 	/**
 	 * Tests that the builder is receiving an appropriate delta
-	 * @see SortBuilderPlugin
-	 * @see SortBuilder
 	 */
 	public void testAddAndRemoveFolder() {
 		try {
@@ -175,8 +169,6 @@ public void testAddAndRemoveFolder() {
 
 	/**
 	 * Tests that the builder is receiving an appropriate delta
-	 * @see SortBuilderPlugin
-	 * @see SortBuilder
 	 */
 	public void testAddFile() {
 		try {
@@ -192,8 +184,6 @@ public void testAddFile() {
 
 	/**
 	 * Tests that the builder is receiving an appropriate delta
-	 * @see SortBuilderPlugin
-	 * @see SortBuilder
 	 */
 	public void testAddFileAndFolder() {
 		try {
@@ -211,8 +201,6 @@ public void testAddFileAndFolder() {
 
 	/**
 	 * Tests that the builder is receiving an appropriate delta
-	 * @see SortBuilderPlugin
-	 * @see SortBuilder
 	 */
 	public void testAddFolder() {
 		try {
@@ -227,8 +215,6 @@ public void testAddFolder() {
 
 	/**
 	 * Tests that the builder is receiving an appropriate delta
-	 * @see SortBuilderPlugin
-	 * @see SortBuilder
 	 */
 	public void testAddProject() {
 		try {
@@ -244,8 +230,6 @@ public void testAddProject() {
 
 	/**
 	 * Tests that the builder is receiving an appropriate delta
-	 * @see SortBuilderPlugin
-	 * @see SortBuilder
 	 */
 	public void testChangeFile() {
 		try {
@@ -262,8 +246,6 @@ public void testChangeFile() {
 
 	/**
 	 * Tests that the builder is receiving an appropriate delta
-	 * @see SortBuilderPlugin
-	 * @see SortBuilder
 	 */
 	public void testChangeFileToFolder() {
 		try {
@@ -281,8 +263,6 @@ public void testChangeFileToFolder() {
 
 	/**
 	 * Tests that the builder is receiving an appropriate delta
-	 * @see SortBuilderPlugin
-	 * @see SortBuilder
 	 */
 	public void testChangeFolderToFile() {
 		try {
@@ -305,8 +285,6 @@ public void testChangeFolderToFile() {
 
 	/**
 	 * Tests that the builder is receiving an appropriate delta
-	 * @see SortBuilderPlugin
-	 * @see SortBuilder
 	 */
 	public void testCloseOpenReplaceFile() {
 		try {
@@ -331,8 +309,6 @@ public void testCloseOpenReplaceFile() {
 
 	/**
 	 * Tests that the builder is receiving an appropriate delta
-	 * @see SortBuilderPlugin
-	 * @see SortBuilder
 	 */
 	public void testMoveFile() {
 		try {
@@ -351,8 +327,6 @@ public void testMoveFile() {
 
 	/**
 	 * Tests that the builder is receiving an appropriate delta
-	 * @see SortBuilderPlugin
-	 * @see SortBuilder
 	 */
 	public void testRemoveFile() {
 		try {
@@ -367,8 +341,6 @@ public void testRemoveFile() {
 
 	/**
 	 * Tests that the builder is receiving an appropriate delta
-	 * @see SortBuilderPlugin
-	 * @see SortBuilder
 	 */
 	public void testRemoveFileAndFolder() {
 		try {
@@ -384,8 +356,6 @@ public void testRemoveFileAndFolder() {
 
 	/**
 	 * Tests that the builder is receiving an appropriate delta
-	 * @see SortBuilderPlugin
-	 * @see SortBuilder
 	 */
 	public void testReplaceFile() {
 		try {
@@ -403,8 +373,6 @@ public void testReplaceFile() {
 
 	/**
 	 * Tests that the builder is receiving an appropriate delta
-	 * @see SortBuilderPlugin
-	 * @see SortBuilder
 	 */
 	public void testTwoFileChanges() {
 		try {

diff --git a/...re.tests.resources/src/org/eclipse/core/tests/internal/builders/DeltaVerifierBuilder.java b/...re.tests.resources/src/org/eclipse/core/tests/internal/builders/DeltaVerifierBuilder.java
@@ -94,9 +94,6 @@ public DeltaVerifierBuilder() {
 	 *                  the type of change (ADDED, REMOVED, CHANGED)
 	 * @param changeFlags
 	 *                  the type of change (CONTENT, SYNC, etc)
-	 * @param movedPath
-	 *                  or null
-	 * @see IResourceConstants
 	 */
 	public void addExpectedChange(IResource resource, IResource topLevelParent, int status, int changeFlags) {
 		verifier.addExpectedChange(resource, topLevelParent, status, changeFlags, null, null);
@@ -115,7 +112,9 @@ public void addExpectedChange(IResource resource, IResource topLevelParent, int
 	 *                  the type of change (ADDED, REMOVED, CHANGED)
 	 * @param changeFlags
 	 *                  the type of change (CONTENT, SYNC, etc)
-	 * @param movedPath
+	 * @param movedFromPath
+	 *                  or null
+	 * @param movedToPath
 	 *                  or null
 	 * @see IResourceConstants
 	 */

diff --git a/...clipse.core.tests.resources/src/org/eclipse/core/tests/internal/builders/SnowBuilder.java b/...clipse.core.tests.resources/src/org/eclipse/core/tests/internal/builders/SnowBuilder.java
@@ -51,9 +51,6 @@ public static SnowBuilder getInstance() {
 		return singleton;
 	}
 
-	/**
-	 * @see InternalBuilder#build(int, Map, IProgressMonitor)
-	 */
 	@Override
 	protected IProject[] build(int kind, Map<String, String> args, IProgressMonitor monitor) throws CoreException {
 		wasDeltaNull = getDelta(getProject()) == null;

diff --git a/...clipse.core.tests.resources/src/org/eclipse/core/tests/internal/builders/SortBuilder.java b/...clipse.core.tests.resources/src/org/eclipse/core/tests/internal/builders/SortBuilder.java
@@ -130,11 +130,6 @@ private void build(IFile unsortedFile) throws CoreException {
 		sortedFile.setContents(bis, true, false, null);
 	}
 
-	/**
-	 * Implements the inherited abstract method in
-	 * <code>BaseBuilder</code>.
-	 * @see BaseBuilder#build(IResourceDelta,int,IProgressMonitor)
-	 */
 	@Override
 	protected IProject[] build(int kind, Map<String, String> args, IProgressMonitor monitor) throws CoreException {
 		arguments = args;

diff --git a/...pse.core.tests.resources/src/org/eclipse/core/tests/internal/dtree/DeltaDataTreeTest.java b/...pse.core.tests.resources/src/org/eclipse/core/tests/internal/dtree/DeltaDataTreeTest.java
@@ -393,7 +393,7 @@ public void testCreateChild() {
 	/**
 	 * Delete the child with the specified local name from the specified
 	 * node.  Note: this method requires both parentKey and localName,
-	 * making it impossible to delete the root node.<p>
+	 * making it impossible to delete the root node.
 	 *
 	 * @exception ObjectNotFoundException
 	 *	a child of parentKey with name localName does not exist in the receiver
@@ -613,9 +613,6 @@ public void testForwardDeltaWithEquality() {
 	 * Answer the key of the child with the given index of the
 	 * specified node.<p>
 	 *
-	 * @param NodeKey, int
-	 * @return NodeKey
-	 *
 	 * @exception ObjectNotFoundException
 	 * 	parentKey does not exist in the receiver
 	 * @exception ArrayIndexOutOfBoundsException

diff --git a/...e.core.tests.resources/src/org/eclipse/core/tests/internal/mapping/TestModelProvider.java b/...e.core.tests.resources/src/org/eclipse/core/tests/internal/mapping/TestModelProvider.java
@@ -31,7 +31,7 @@ public class TestModelProvider extends ModelProvider {
 	/**
 	 * Flag to check if the given delta proposes contents deletion. If set to
 	 * {@code true}, the {@link #validateChange(IResourceDelta, IProgressMonitor)}
-	 * will add {@link IStatus.ERROR} to the change description to indicate contents
+	 * will add {@link IStatus#ERROR} to the change description to indicate contents
 	 * deletion proposal.
 	 */
 	public static boolean checkContentsDeletion;

diff --git a/...sts.resources/src/org/eclipse/core/tests/internal/resources/WorkspacePreferencesTest.java b/...sts.resources/src/org/eclipse/core/tests/internal/resources/WorkspacePreferencesTest.java
@@ -29,9 +29,6 @@ public class WorkspacePreferencesTest extends WorkspaceSessionTest {
 	private IWorkspace workspace;
 	private Preferences preferences;
 
-	/**
-	 * @see TestCase#setUp()
-	 */
 	@Override
 	protected void setUp() throws Exception {
 		super.setUp();
@@ -40,9 +37,6 @@ protected void setUp() throws Exception {
 		workspace.setDescription(Workspace.defaultWorkspaceDescription());
 	}
 
-	/**
-	 * @see TestCase#tearDown()
-	 */
 	@Override
 	protected void tearDown() throws Exception {
 		super.tearDown();

diff --git a/...ore.tests.resources/src/org/eclipse/core/tests/resources/IResourceChangeListenerTest.java b/...ore.tests.resources/src/org/eclipse/core/tests/resources/IResourceChangeListenerTest.java
@@ -134,9 +134,6 @@ public void resourceChanged(IResourceChangeEvent event) {
 
 	/**
 	 * Tests that the builder is receiving an appropriate delta
-	 *
-	 * @see SortBuilderPlugin
-	 * @see SortBuilder
 	 */
 	public void assertDelta() {
 		assertTrue(verifier.getMessage(), verifier.isDeltaValid());

diff --git a/...eclipse.core.tests.resources/src/org/eclipse/core/tests/resources/LinkedResourceTest.java b/...eclipse.core.tests.resources/src/org/eclipse/core/tests/resources/LinkedResourceTest.java
@@ -1070,11 +1070,6 @@ public void testIsLinked() {
 
 	}
 
-	/**
-	 * Tests the
-	 * {@link org.eclipse.core.resources.IResource#setLinkLocation(URI , int , IProgressMonitor )}
-	 * method.
-	 */
 	public void testsetLinkLocation() {
 		// initially nothing is linked
 		IResource[] toTest = new IResource[] {closedProject, existingFileInExistingProject, existingFolderInExistingFolder, existingFolderInExistingProject, existingProject, nonExistingFileInExistingFolder, nonExistingFileInExistingProject, nonExistingFileInOtherExistingProject, nonExistingFolderInExistingFolder, nonExistingFolderInExistingProject, nonExistingFolderInNonExistingFolder, nonExistingFolderInNonExistingProject, nonExistingFolderInOtherExistingProject, nonExistingProject, otherExistingProject};
@@ -1152,11 +1147,6 @@ public void testSetLinkLocationSwapLinkedResource() {
 		}
 	}
 
-	/**
-	 * Tests the
-	 * {@link org.eclipse.core.resources.IResource#setLinkLocation(IPath, int , IProgressMonitor )}
-	 * method.
-	 */
 	public void testsetLinkLocationPath() {
 		//initially nothing is linked
 		IResource[] toTest = new IResource[] {closedProject, existingFileInExistingProject, existingFolderInExistingFolder, existingFolderInExistingProject, existingProject, nonExistingFileInExistingFolder, nonExistingFileInExistingProject, nonExistingFileInOtherExistingProject, nonExistingFolderInExistingFolder, nonExistingFolderInExistingProject, nonExistingFolderInNonExistingFolder, nonExistingFolderInNonExistingProject, nonExistingFolderInOtherExistingProject, nonExistingProject, otherExistingProject};

diff --git a/...ts.resources/src/org/eclipse/core/tests/resources/LinkedResourceWithPathVariableTest.java b/...ts.resources/src/org/eclipse/core/tests/resources/LinkedResourceWithPathVariableTest.java
@@ -131,9 +131,6 @@ protected void convertLineEndings(IFileStore inStore, IFileStore outStore, IProg
 		}
 	}
 
-	/**
-	 * @see org.eclipse.core.tests.harness.ResourceTest#getRandomLocation()
-	 */
 	@Override
 	public IPath getRandomLocation() {
 		IPathVariableManager pathVars = getWorkspace().getPathVariableManager();
@@ -152,9 +149,6 @@ public IPath getRandomLocation() {
 		return path;
 	}
 
-	/**
-	 * @see org.eclipse.core.tests.harness.ResourceTest#getRandomLocation()
-	 */
 	public IPath getRandomProjectLocation() {
 		IPathVariableManager pathVars = getWorkspace().getPathVariableManager();
 		// low order bits are current time, high order bits are static counter
@@ -172,9 +166,6 @@ public IPath getRandomProjectLocation() {
 		return path;
 	}
 
-	/**
-	 * @see org.eclipse.core.tests.harness.ResourceTest#getRandomLocation()
-	 */
 	public IPath getRandomRelativeProjectLocation() {
 		IPathVariableManager pathVars = getWorkspace().getPathVariableManager();
 		// low order bits are current time, high order bits are static counter
@@ -192,17 +183,11 @@ public IPath getRandomRelativeProjectLocation() {
 		return path;
 	}
 
-	/**
-	 * @see LinkedResourceTest#resolve(org.eclipse.core.runtime.IPath)
-	 */
 	@Override
 	protected IPath resolve(IPath path) {
 		return getWorkspace().getPathVariableManager().resolvePath(path);
 	}
 
-	/**
-	 * @see LinkedResourceTest#resolve(java.net.URI)
-	 */
 	@Override
 	protected URI resolve(URI uri) {
 		return getWorkspace().getPathVariableManager().resolveURI(uri);

diff --git a/...ipse.core.tests.resources/src/org/eclipse/core/tests/resources/ResourceDeltaVerifier.java b/...ipse.core.tests.resources/src/org/eclipse/core/tests/resources/ResourceDeltaVerifier.java
@@ -163,7 +163,6 @@ public void addExpectedDeletion(IResource resource) {
 	 * @param resource the resource that is expected to change
 	 * @param status the type of change (ADDED, REMOVED, CHANGED)
 	 * @param changeFlags the type of change (CONTENT, SYNC, etc)
-	 * @see IResourceConstants
 	 */
 	public void addExpectedChange(IResource resource, int status, int changeFlags) {
 		addExpectedChange(resource, null, status, changeFlags, null, null);
@@ -176,8 +175,8 @@ public void addExpectedChange(IResource resource, int status, int changeFlags) {
 	 * @param resource the resource that is expected to change
 	 * @param status the type of change (ADDED, REMOVED, CHANGED)
 	 * @param changeFlags the type of change (CONTENT, SYNC, etc)
-	 * @param movedPath or null
-	 * @see IResourceConstants
+	 * @param movedFromPath or null
+	 * @param movedToPath or null
 	 */
 	public void addExpectedChange(IResource resource, int status, int changeFlags, IPath movedFromPath, IPath movedToPath) {
 		addExpectedChange(resource, null, status, changeFlags, movedFromPath, movedToPath);
@@ -191,8 +190,6 @@ public void addExpectedChange(IResource resource, int status, int changeFlags, I
 	 * @param topLevelParent Do not added expected changes above this parent
 	 * @param status the type of change (ADDED, REMOVED, CHANGED)
 	 * @param changeFlags the type of change (CONTENT, SYNC, etc)
-	 * @param movedPath or null
-	 * @see IResourceConstants
 	 */
 	public void addExpectedChange(IResource resource, IResource topLevelParent, int status, int changeFlags) {
 		addExpectedChange(resource, topLevelParent, status, changeFlags, null, null);
@@ -206,8 +203,8 @@ public void addExpectedChange(IResource resource, IResource topLevelParent, int
 	 * @param topLevelParent Do not added expected changes above this parent
 	 * @param status the type of change (ADDED, REMOVED, CHANGED)
 	 * @param changeFlags the type of change (CONTENT, SYNC, etc)
-	 * @param movedPath or null
-	 * @see IResourceConstants
+	 * @param movedFromPath or null
+	 * @param movedToPath or null
 	 */
 	public void addExpectedChange(IResource resource, IResource topLevelParent, int status, int changeFlags, IPath movedFromPath, IPath movedToPath) {
 		resetIfNecessary();
@@ -800,7 +797,6 @@ private void resetIfNecessary() {
 
 	/**
 	 * Part of the <code>IResourceChangedListener</code> interface.
-	 * @see IResourceChangedListener
 	 */
 	@Override
 	public void resourceChanged(IResourceChangeEvent e) {

diff --git a/...ore.tests.resources/src/org/eclipse/core/tests/resources/usecase/ConcurrentOperation.java b/...ore.tests.resources/src/org/eclipse/core/tests/resources/usecase/ConcurrentOperation.java
@@ -106,9 +106,6 @@ protected void logException(Exception e) {
 		}
 	}
 
-	/**
-	 * @see #waitNotification
-	 */
 	public synchronized void proceed() {
 		go = true;
 		notify();