debug: fix javadoc

Author: EcljpseB0T

.settings/org.eclipse.core.resources.prefs

@@ -0,0 +1,2 @@
+eclipse.preferences.version=1
+encoding/<project>=UTF-8

org.eclipse.jdt.debug.jdi.tests/tests/org/eclipse/debug/jdi/tests/ThreadReferenceTest.java

@@ -233,7 +233,7 @@ public void testJDIThreadGroup() {
 	}
 
 	/**
-	 * Test JDI addPlatformThreadsOnlyFilter() is skipped in old JDK version (<=18).
+	 * Test JDI addPlatformThreadsOnlyFilter() is skipped in old JDK version ({@code <=18}).
 	 */
 	public void testJDIPlatformThreadsOnlyFilter() {
 		// Make sure the entire VM is not suspended before we start a new thread

org.eclipse.jdt.debug.tests/tests/org/eclipse/jdt/debug/tests/AbstractDebugTest.java

@@ -467,7 +467,7 @@ synchronized void assert18Project() {
 	        	jp = createProject(ONE_EIGHT_PROJECT_NAME, JavaProjectHelper.TEST_1_8_SRC_DIR.toString(), JavaProjectHelper.JAVA_SE_1_8_EE_NAME, false);
 				IPath lib = new Path(JavaTestPlugin.getDefault().getFileInPlugin(new Path("testjars").append("gh275").append("debug-lib.jar")).getAbsolutePath());
 				JavaProjectHelper.addLibrary(jp, lib);
-	
+
 	    		cfgs.add(createLaunchConfiguration(jp, "EvalTest18"));
 	    		cfgs.add(createLaunchConfiguration(jp, "FunctionalCaptureTest18"));
 	    		cfgs.add(createLaunchConfiguration(jp, "EvalTestIntf18"));
@@ -952,16 +952,20 @@ protected IJavaProject getJavaProject(String name) {
 	}
 
 	/**
-	 * Creates a new {@link IJavaProject} with the given name and optionally initializing it from the given
-	 * resource path from the testing bundle.
-	 * <br><br>
-	 * The project has the default <code>src</code> and <code>bin</code> folders. It is also created with a default
-	 * <code>launchConfigurations</code> folder.
+	 * Creates a new {@link IJavaProject} with the given name and optionally initializing it from the given resource path from the testing bundle.
+	 * <br>
+	 * <br>
+	 * The project has the default <code>src</code> and <code>bin</code> folders. It is also created with a default <code>launchConfigurations</code>
+	 * folder.
 	 *
-	 * @param name the name for the project
-	 * @param contentpath the path within the jdt.debug test bundle to initialize the source from
-	 * @param ee the level of execution environment to use
-	 * @param if an existing project should be deleted
+	 * @param name
+	 *            the name for the project
+	 * @param contentpath
+	 *            the path within the jdt.debug test bundle to initialize the source from
+	 * @param ee
+	 *            the level of execution environment to use
+	 * @param delete
+	 *            if an existing project should be deleted
 	 * @return the new Java project
 	 */
 	protected IJavaProject createProject(String name, String contentpath, String ee, boolean delete) throws Exception {
@@ -998,16 +1002,19 @@ protected IJavaProject createProject(String name, String contentpath, String ee,
 	}
 
 	/**
-	 * Creates a new {@link IJavaProject} with the given name and initializes the contents from the given
-	 * resource path from the testing bundle.
-	 * <br><br>
-	 * The project has the default <code>src</code> and <code>bin</code> folders. It is also created with a default
-	 * <code>launchConfigurations</code> folder.
+	 * Creates a new {@link IJavaProject} with the given name and initializes the contents from the given resource path from the testing bundle. <br>
+	 * <br>
+	 * The project has the default <code>src</code> and <code>bin</code> folders. It is also created with a default <code>launchConfigurations</code>
+	 * folder.
 	 *
-	 * @param name the name for the project
-	 * @param contentpath the path within the jdt.debug test bundle to initialize the source from
-	 * @param ee the level of execution environment to use
-	 * @param if an existing project should be deleted
+	 * @param name
+	 *            the name for the project
+	 * @param contentpath
+	 *            the path within the jdt.debug test bundle to initialize the source from
+	 * @param ee
+	 *            the level of execution environment to use
+	 * @param delete
+	 *            if an existing project should be deleted
 	 * @return the new Java project
 	 */
 	protected IJavaProject createJavaProjectClone(String name, String contentpath, String ee, boolean delete) throws Exception {
@@ -1053,12 +1060,14 @@ protected IJavaProject createJavaProjectClone(String name, String contentpath, S
 	}
 
 	/**
-	 * Creates a new {@link IProject} with the given name and initializes the contents from the given
-	 * resource path from the testing bundle.
+	 * Creates a new {@link IProject} with the given name and initializes the contents from the given resource path from the testing bundle.
 	 *
-	 * @param name the name for the project
-	 * @param contentpath the path within the jdt.debug test bundle to initialize the source from
-	 * @param if an existing project should be deleted
+	 * @param name
+	 *            the name for the project
+	 * @param contentpath
+	 *            the path within the jdt.debug test bundle to initialize the source from
+	 * @param delete
+	 *            if an existing project should be deleted
 	 * @return the new project
 	 */
 	protected IProject createProjectClone(String name, String contentpath, boolean delete) throws Exception {
@@ -1170,45 +1179,54 @@ protected IHyperlink getHyperlink(int offset, IDocument doc) {
 	}
 
 	/**
-	 * Launches the given configuration and waits for an event. Returns the
-	 * source of the event. If the event is not received, the launch is
+	 * Launches the given configuration and waits for an event. Returns the source of the event. If the event is not received, the launch is
 	 * terminated and an exception is thrown.
 	 *
-	 * @param configuration the configuration to launch
-	 * @param waiter the event waiter to use
+	 * @param configuration
+	 *            the configuration to launch
+	 * @param waiter
+	 *            the event waiter to use
 	 * @return Object the source of the event
-	 * @exception Exception if the event is never received.
+	 * @throws CoreException
+	 *             if the event is never received.
 	 */
 	protected Object launchAndWait(ILaunchConfiguration configuration, DebugEventWaiter waiter) throws CoreException {
 	    return launchAndWait(configuration, waiter, true);
 	}
 
 	/**
-	 * Launches the given configuration in debug mode and waits for an event.
-	 * Returns the source of the event. If the event is not received, the
+	 * Launches the given configuration in debug mode and waits for an event. Returns the source of the event. If the event is not received, the
 	 * launch is terminated and an exception is thrown.
 	 *
-	 * @param configuration the configuration to launch
-	 * @param waiter the event waiter to use
-	 * @param register whether to register the launch
+	 * @param configuration
+	 *            the configuration to launch
+	 * @param waiter
+	 *            the event waiter to use
+	 * @param register
+	 *            whether to register the launch
 	 * @return Object the source of the event
-	 * @exception Exception if the event is never received.
+	 * @throws CoreException
+	 *             if the event is never received.
 	 */
 	protected Object launchAndWait(ILaunchConfiguration configuration, DebugEventWaiter waiter, boolean register) throws CoreException {
 		return launchAndWait(configuration, ILaunchManager.DEBUG_MODE, waiter, register);
 	}
 
 	/**
-	 * Launches the given configuration and waits for an event. Returns the
-	 * source of the event. If the event is not received, the launch is
+	 * Launches the given configuration and waits for an event. Returns the source of the event. If the event is not received, the launch is
 	 * terminated and an exception is thrown.
 	 *
-	 * @param configuration the configuration to launch
-	 * @param mode the mode to launch the configuration in
-	 * @param waiter the event waiter to use
-	 * @param register whether to register the launch
+	 * @param configuration
+	 *            the configuration to launch
+	 * @param mode
+	 *            the mode to launch the configuration in
+	 * @param waiter
+	 *            the event waiter to use
+	 * @param register
+	 *            whether to register the launch
 	 * @return Object the source of the event
-	 * @exception Exception if the event is never received.
+	 * @throws CoreException
+	 *             if the event is never received.
 	 */
 	protected Object launchAndWait(ILaunchConfiguration configuration, String mode, DebugEventWaiter waiter, boolean register) throws CoreException {
 		ILaunch launch = configuration.launch(mode, null, false, register);
@@ -1367,12 +1385,13 @@ protected IJavaThread launchToBreakpoint(ILaunchConfiguration config) throws Cor
 	}
 
 	/**
-	 * Launches the given configuration in debug mode, and waits for a breakpoint-caused
-	 * suspend event in that program. Returns the thread in which the suspend
-	 * event occurred.
+	 * Launches the given configuration in debug mode, and waits for a breakpoint-caused suspend event in that program. Returns the thread in which
+	 * the suspend event occurred.
 	 *
-	 * @param config the configuration to launch
-	 * @param whether to register the launch
+	 * @param config
+	 *            the configuration to launch
+	 * @param register
+	 *            whether to register the launch
 	 * @return thread in which the first suspend event occurred
 	 */
 	protected IJavaThread launchToBreakpoint(ILaunchConfiguration config, boolean register) throws CoreException {
@@ -1391,7 +1410,6 @@ protected IJavaThread launchToBreakpoint(ILaunchConfiguration config, boolean re
 	 * event occurred.
 	 *
 	 * @param mainTypeName the program to launch
-	 * @param timeout the number of milliseconds to wait for a terminate event
 	 * @return debug target in which the terminate event occurred
 	 */
 	protected IJavaDebugTarget launchAndTerminate(String mainTypeName) throws Exception {
@@ -1551,10 +1569,11 @@ protected IJavaThread resume(IJavaThread thread, int timeout) throws Exception {
 	}
 
 	/**
-	 * Resumes the given thread, and waits for a suspend event caused by the specified
-	 * line breakpoint.  Returns the thread in which the suspend event occurs.
+	 * Resumes the given thread, and waits for a suspend event caused by the specified line breakpoint. Returns the thread in which the suspend event
+	 * occurs.
 	 *
-	 * @param thread thread to resume
+	 * @param resumeThread
+	 *            thread to resume
 	 * @return thread in which the first suspend event occurs
 	 */
 	protected IJavaThread resumeToLineBreakpoint(IJavaThread resumeThread, ILineBreakpoint bp) throws Exception {
@@ -2028,7 +2047,6 @@ protected IJavaClassPrepareBreakpoint createClassPrepareBreakpoint(String typeNa
 	/**
 	 * Creates and returns a class prepare breakpoint on the type with the given fully qualified name.
 	 *
-	 * @param typeName type on which to create the breakpoint
 	 * @return breakpoint
 	 */
 	protected IJavaClassPrepareBreakpoint createClassPrepareBreakpoint(String root,
@@ -2082,10 +2100,14 @@ protected IType getType(String typeName) throws Exception {
 	/**
 	 * Creates and returns a watchpoint
 	 *
-	 * @param typeNmae type name
-	 * @param fieldName field name
-	 * @param access whether to suspend on field access
-	 * @param modification whether to suspend on field modification
+	 * @param typeName
+	 *            type name
+	 * @param fieldName
+	 *            field name
+	 * @param access
+	 *            whether to suspend on field access
+	 * @param modification
+	 *            whether to suspend on field modification
 	 */
 	protected IJavaWatchpoint createWatchpoint(String typeName, String fieldName, boolean access, boolean modification) throws Exception {
 		IType type = getType(typeName);
@@ -2133,7 +2155,6 @@ protected IJavaExceptionBreakpoint createExceptionBreakpoint(String exName, bool
 	 * @return a watchpoint
 	 * @throws CoreException
 	 *
-	 * <p>
 	 * <pre>
 	 * Syntax example:
 	 * Type$InnerType$MethodNameAndSignature$AnonymousTypeDeclarationNumber$FieldName
@@ -2150,7 +2171,6 @@ protected IJavaExceptionBreakpoint createExceptionBreakpoint(String exName, bool
 	 * 			}
 	 * 		}
 	 * }</pre>
-	 * </p>
 	 * To get the anonymous toString, syntax of fullTargetName would be: <code>Foo$Inner$aMethod()V$1$anIntField</code>
 	 */
 	protected IJavaWatchpoint createNestedTypeWatchPoint(String root, String packageName, String cuName,
@@ -2428,11 +2448,12 @@ protected IJavaThread stepIntoWithFilters(IJavaStackFrame frame) throws Exceptio
 	}
 
 	/**
-	 * Performs a step into with filters in the given stack frame and returns when
-	 * complete.
+	 * Performs a step into with filters in the given stack frame and returns when complete.
 	 *
-	 * @param whether to step thru or step return from a filtered location
-	 * @param frame stack frame to step in
+	 * @param frame
+	 *            stack frame to step in
+	 * @param stepThru
+	 *            whether to step thru or step return from a filtered location
 	 */
 	protected IJavaThread stepIntoWithFilters(IJavaStackFrame frame, boolean stepThru) throws Exception {
 		DebugEventWaiter waiter= new DebugElementKindEventWaiter(DebugEvent.SUSPEND, IJavaThread.class);

org.eclipse.jdt.debug.tests/tests/org/eclipse/jdt/debug/tests/breakpoints/BreakpointLocationVerificationTests.java

@@ -81,7 +81,7 @@ private void testLocation(int lineToTry, int expectedLineNumber, String baseType
 	/**
 	 * Tests setting a line breakpoint on a final field that is initialized
 	 *
-	 * @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
+	 * @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354"
 	 */
 	public void testFinalFieldWithTypeDecl() throws Exception {
 		testLocation(17, 17, "FinalBreakpointLocations");
@@ -90,61 +90,61 @@ public void testFinalFieldWithTypeDecl() throws Exception {
 	/**
 	 * Tests setting a line breakpoint on a final field that is initialized looking for best match
 	 *
-	 * @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
+	 * @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354"
 	 */
 	public void testFinalFieldWithTypeDecla() throws Exception {
 		testLocation(17, 17, "FinalBreakpointLocations", "FinalBreakpointLocations", true);
 	}
 
 	/**
-	 * Tests setting a line breakpoint on an inner type member for the initializer of
-	 * a final local field variable
-	 * @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
+	 * Tests setting a line breakpoint on an inner type member for the initializer of a final local field variable
+	 *
+	 * @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354"
 	 */
 	public void testFinalFieldWithTypeDecl3() throws Exception {
 		testLocation(17, 17, "FinalBreakpointLocations");
 	}
 
 	/**
-	 * Tests setting a line breakpoint on an inner type member for the initializer of looking
-	 * for best match
-	 * a final local field variable
-	 * @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
+	 * Tests setting a line breakpoint on an inner type member for the initializer of looking for best match a final local field variable
+	 *
+	 * @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354"
 	 */
 	public void testFinalFieldWithTypeDecl3a() throws Exception {
 		testLocation(17, 17, "FinalBreakpointLocations", "FinalBreakpointLocations", true);
 	}
 
 	/**
-	 * Tests setting a line breakpoint on an inner-inner type member for the initializer of
-	 * a final local field variable
-	 * @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
+	 * Tests setting a line breakpoint on an inner-inner type member for the initializer of a final local field variable
+	 *
+	 * @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354"
 	 */
 	public void testFinalFieldWithTypeDecl4() throws Exception {
 		testLocation(20, 20, "FinalBreakpointLocations");
 	}
 
 	/**
-	 * Tests setting a line breakpoint on an inner-inner type member for the initializer of
-	 * a final local field variable looking for best match
-	 * @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
+	 * Tests setting a line breakpoint on an inner-inner type member for the initializer of a final local field variable looking for best match
+	 *
+	 * @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354"
 	 */
 	public void testFinalFieldWithTypeDecl4a() throws Exception {
 		testLocation(20, 20, "FinalBreakpointLocations", "FinalBreakpointLocations", true);
 	}
 
 	/**
 	 * Tests setting a line breakpoint on a final field that has not been initialized
-	 * @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
+	 *
+	 * @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354"
 	 */
 	public void testFinalFieldWithTypeDecl5() throws Exception {
 		testLocation(30, 33, "FinalBreakpointLocations");
 	}
 
 	/**
-	 * Tests setting a line breakpoint on a final field that has not been initialized looking
-	 * for best match
-	 * @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
+	 * Tests setting a line breakpoint on a final field that has not been initialized looking for best match
+	 *
+	 * @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354"
 	 */
 	public void testFinalFieldWithTypeDecl5a() throws Exception {
 		testLocation(30, 33, "FinalBreakpointLocations", "FinalBreakpointLocations", true);

org.eclipse.jdt.debug.tests/tests/org/eclipse/jdt/debug/tests/breakpoints/BreakpointMethodLocator.java

@@ -69,16 +69,15 @@ public String getMethodName() {
 	 * Return <code>null</code> if there is no method declaration at the given position or
 	 * if not possible to compute the signature of the method declared at the given
 	 * position.
-	 * @see BreakpointFieldLocator#getMethodName()
 	 */
 	public String getMethodSignature() {
 		return fMethodSignature;
 	}
 
 	/**
-	 * Return the name of type in which the method is declared.
-	 * Return <code>null</code> if there is no method declaration at the given position.
-	 * @see BreakpointFieldLocator#getMethodName()
+	 * Return the name of type in which the method is declared. Return <code>null</code> if there is no method declaration at the given position.
+	 *
+	 * @see BreakpointFieldLocator#getTypeName()
 	 */
 	public String getTypeName() {
 		return fTypeName;

org.eclipse.jdt.debug.tests/tests/org/eclipse/jdt/debug/tests/breakpoints/BreakpointWorkingSetTests.java

@@ -71,12 +71,11 @@ public void testNoDefaultWorkingSet() throws Exception {
 	}
 
 	/**
-	 * Tests that we can have N working set shown in the view and add additional breakpoints
-	 * to the default ones without causing exceptions
+	 * Tests that we can have N working set shown in the view and add additional breakpoints to the default ones without causing exceptions
 	 *
 	 * In this test we have to open / show the view to cause the insert update to occur
 	 *
-	 * @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=380614
+	 * @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=380614"
 	 * @since 3.8.100
 	 */
 	public void testInsertIntoDefaultSet() throws Exception {