Skip to content

Commit 537c1e3

Browse files
EcljpseB0Tjukzi
authored andcommitted
debug: fix javadoc
1 parent 74056dc commit 537c1e3

File tree

101 files changed

+557
-625
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

101 files changed

+557
-625
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
eclipse.preferences.version=1
2+
encoding/<project>=UTF-8

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ public void testJDIThreadGroup() {
233233
}
234234

235235
/**
236-
* Test JDI addPlatformThreadsOnlyFilter() is skipped in old JDK version (<=18).
236+
* Test JDI addPlatformThreadsOnlyFilter() is skipped in old JDK version ({@code <=18}).
237237
*/
238238
public void testJDIPlatformThreadsOnlyFilter() {
239239
// 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

+83-62
Original file line numberDiff line numberDiff line change
@@ -467,7 +467,7 @@ synchronized void assert18Project() {
467467
jp = createProject(ONE_EIGHT_PROJECT_NAME, JavaProjectHelper.TEST_1_8_SRC_DIR.toString(), JavaProjectHelper.JAVA_SE_1_8_EE_NAME, false);
468468
IPath lib = new Path(JavaTestPlugin.getDefault().getFileInPlugin(new Path("testjars").append("gh275").append("debug-lib.jar")).getAbsolutePath());
469469
JavaProjectHelper.addLibrary(jp, lib);
470-
470+
471471
cfgs.add(createLaunchConfiguration(jp, "EvalTest18"));
472472
cfgs.add(createLaunchConfiguration(jp, "FunctionalCaptureTest18"));
473473
cfgs.add(createLaunchConfiguration(jp, "EvalTestIntf18"));
@@ -952,16 +952,20 @@ protected IJavaProject getJavaProject(String name) {
952952
}
953953

954954
/**
955-
* Creates a new {@link IJavaProject} with the given name and optionally initializing it from the given
956-
* resource path from the testing bundle.
957-
* <br><br>
958-
* The project has the default <code>src</code> and <code>bin</code> folders. It is also created with a default
959-
* <code>launchConfigurations</code> folder.
955+
* Creates a new {@link IJavaProject} with the given name and optionally initializing it from the given resource path from the testing bundle.
956+
* <br>
957+
* <br>
958+
* The project has the default <code>src</code> and <code>bin</code> folders. It is also created with a default <code>launchConfigurations</code>
959+
* folder.
960960
*
961-
* @param name the name for the project
962-
* @param contentpath the path within the jdt.debug test bundle to initialize the source from
963-
* @param ee the level of execution environment to use
964-
* @param if an existing project should be deleted
961+
* @param name
962+
* the name for the project
963+
* @param contentpath
964+
* the path within the jdt.debug test bundle to initialize the source from
965+
* @param ee
966+
* the level of execution environment to use
967+
* @param delete
968+
* if an existing project should be deleted
965969
* @return the new Java project
966970
*/
967971
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,
9981002
}
9991003

10001004
/**
1001-
* Creates a new {@link IJavaProject} with the given name and initializes the contents from the given
1002-
* resource path from the testing bundle.
1003-
* <br><br>
1004-
* The project has the default <code>src</code> and <code>bin</code> folders. It is also created with a default
1005-
* <code>launchConfigurations</code> folder.
1005+
* Creates a new {@link IJavaProject} with the given name and initializes the contents from the given resource path from the testing bundle. <br>
1006+
* <br>
1007+
* The project has the default <code>src</code> and <code>bin</code> folders. It is also created with a default <code>launchConfigurations</code>
1008+
* folder.
10061009
*
1007-
* @param name the name for the project
1008-
* @param contentpath the path within the jdt.debug test bundle to initialize the source from
1009-
* @param ee the level of execution environment to use
1010-
* @param if an existing project should be deleted
1010+
* @param name
1011+
* the name for the project
1012+
* @param contentpath
1013+
* the path within the jdt.debug test bundle to initialize the source from
1014+
* @param ee
1015+
* the level of execution environment to use
1016+
* @param delete
1017+
* if an existing project should be deleted
10111018
* @return the new Java project
10121019
*/
10131020
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
10531060
}
10541061

10551062
/**
1056-
* Creates a new {@link IProject} with the given name and initializes the contents from the given
1057-
* resource path from the testing bundle.
1063+
* Creates a new {@link IProject} with the given name and initializes the contents from the given resource path from the testing bundle.
10581064
*
1059-
* @param name the name for the project
1060-
* @param contentpath the path within the jdt.debug test bundle to initialize the source from
1061-
* @param if an existing project should be deleted
1065+
* @param name
1066+
* the name for the project
1067+
* @param contentpath
1068+
* the path within the jdt.debug test bundle to initialize the source from
1069+
* @param delete
1070+
* if an existing project should be deleted
10621071
* @return the new project
10631072
*/
10641073
protected IProject createProjectClone(String name, String contentpath, boolean delete) throws Exception {
@@ -1170,45 +1179,54 @@ protected IHyperlink getHyperlink(int offset, IDocument doc) {
11701179
}
11711180

11721181
/**
1173-
* Launches the given configuration and waits for an event. Returns the
1174-
* source of the event. If the event is not received, the launch is
1182+
* Launches the given configuration and waits for an event. Returns the source of the event. If the event is not received, the launch is
11751183
* terminated and an exception is thrown.
11761184
*
1177-
* @param configuration the configuration to launch
1178-
* @param waiter the event waiter to use
1185+
* @param configuration
1186+
* the configuration to launch
1187+
* @param waiter
1188+
* the event waiter to use
11791189
* @return Object the source of the event
1180-
* @exception Exception if the event is never received.
1190+
* @throws CoreException
1191+
* if the event is never received.
11811192
*/
11821193
protected Object launchAndWait(ILaunchConfiguration configuration, DebugEventWaiter waiter) throws CoreException {
11831194
return launchAndWait(configuration, waiter, true);
11841195
}
11851196

11861197
/**
1187-
* Launches the given configuration in debug mode and waits for an event.
1188-
* Returns the source of the event. If the event is not received, the
1198+
* 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
11891199
* launch is terminated and an exception is thrown.
11901200
*
1191-
* @param configuration the configuration to launch
1192-
* @param waiter the event waiter to use
1193-
* @param register whether to register the launch
1201+
* @param configuration
1202+
* the configuration to launch
1203+
* @param waiter
1204+
* the event waiter to use
1205+
* @param register
1206+
* whether to register the launch
11941207
* @return Object the source of the event
1195-
* @exception Exception if the event is never received.
1208+
* @throws CoreException
1209+
* if the event is never received.
11961210
*/
11971211
protected Object launchAndWait(ILaunchConfiguration configuration, DebugEventWaiter waiter, boolean register) throws CoreException {
11981212
return launchAndWait(configuration, ILaunchManager.DEBUG_MODE, waiter, register);
11991213
}
12001214

12011215
/**
1202-
* Launches the given configuration and waits for an event. Returns the
1203-
* source of the event. If the event is not received, the launch is
1216+
* Launches the given configuration and waits for an event. Returns the source of the event. If the event is not received, the launch is
12041217
* terminated and an exception is thrown.
12051218
*
1206-
* @param configuration the configuration to launch
1207-
* @param mode the mode to launch the configuration in
1208-
* @param waiter the event waiter to use
1209-
* @param register whether to register the launch
1219+
* @param configuration
1220+
* the configuration to launch
1221+
* @param mode
1222+
* the mode to launch the configuration in
1223+
* @param waiter
1224+
* the event waiter to use
1225+
* @param register
1226+
* whether to register the launch
12101227
* @return Object the source of the event
1211-
* @exception Exception if the event is never received.
1228+
* @throws CoreException
1229+
* if the event is never received.
12121230
*/
12131231
protected Object launchAndWait(ILaunchConfiguration configuration, String mode, DebugEventWaiter waiter, boolean register) throws CoreException {
12141232
ILaunch launch = configuration.launch(mode, null, false, register);
@@ -1367,12 +1385,13 @@ protected IJavaThread launchToBreakpoint(ILaunchConfiguration config) throws Cor
13671385
}
13681386

13691387
/**
1370-
* Launches the given configuration in debug mode, and waits for a breakpoint-caused
1371-
* suspend event in that program. Returns the thread in which the suspend
1372-
* event occurred.
1388+
* Launches the given configuration in debug mode, and waits for a breakpoint-caused suspend event in that program. Returns the thread in which
1389+
* the suspend event occurred.
13731390
*
1374-
* @param config the configuration to launch
1375-
* @param whether to register the launch
1391+
* @param config
1392+
* the configuration to launch
1393+
* @param register
1394+
* whether to register the launch
13761395
* @return thread in which the first suspend event occurred
13771396
*/
13781397
protected IJavaThread launchToBreakpoint(ILaunchConfiguration config, boolean register) throws CoreException {
@@ -1391,7 +1410,6 @@ protected IJavaThread launchToBreakpoint(ILaunchConfiguration config, boolean re
13911410
* event occurred.
13921411
*
13931412
* @param mainTypeName the program to launch
1394-
* @param timeout the number of milliseconds to wait for a terminate event
13951413
* @return debug target in which the terminate event occurred
13961414
*/
13971415
protected IJavaDebugTarget launchAndTerminate(String mainTypeName) throws Exception {
@@ -1551,10 +1569,11 @@ protected IJavaThread resume(IJavaThread thread, int timeout) throws Exception {
15511569
}
15521570

15531571
/**
1554-
* Resumes the given thread, and waits for a suspend event caused by the specified
1555-
* line breakpoint. Returns the thread in which the suspend event occurs.
1572+
* Resumes the given thread, and waits for a suspend event caused by the specified line breakpoint. Returns the thread in which the suspend event
1573+
* occurs.
15561574
*
1557-
* @param thread thread to resume
1575+
* @param resumeThread
1576+
* thread to resume
15581577
* @return thread in which the first suspend event occurs
15591578
*/
15601579
protected IJavaThread resumeToLineBreakpoint(IJavaThread resumeThread, ILineBreakpoint bp) throws Exception {
@@ -2028,7 +2047,6 @@ protected IJavaClassPrepareBreakpoint createClassPrepareBreakpoint(String typeNa
20282047
/**
20292048
* Creates and returns a class prepare breakpoint on the type with the given fully qualified name.
20302049
*
2031-
* @param typeName type on which to create the breakpoint
20322050
* @return breakpoint
20332051
*/
20342052
protected IJavaClassPrepareBreakpoint createClassPrepareBreakpoint(String root,
@@ -2082,10 +2100,14 @@ protected IType getType(String typeName) throws Exception {
20822100
/**
20832101
* Creates and returns a watchpoint
20842102
*
2085-
* @param typeNmae type name
2086-
* @param fieldName field name
2087-
* @param access whether to suspend on field access
2088-
* @param modification whether to suspend on field modification
2103+
* @param typeName
2104+
* type name
2105+
* @param fieldName
2106+
* field name
2107+
* @param access
2108+
* whether to suspend on field access
2109+
* @param modification
2110+
* whether to suspend on field modification
20892111
*/
20902112
protected IJavaWatchpoint createWatchpoint(String typeName, String fieldName, boolean access, boolean modification) throws Exception {
20912113
IType type = getType(typeName);
@@ -2133,7 +2155,6 @@ protected IJavaExceptionBreakpoint createExceptionBreakpoint(String exName, bool
21332155
* @return a watchpoint
21342156
* @throws CoreException
21352157
*
2136-
* <p>
21372158
* <pre>
21382159
* Syntax example:
21392160
* Type$InnerType$MethodNameAndSignature$AnonymousTypeDeclarationNumber$FieldName
@@ -2150,7 +2171,6 @@ protected IJavaExceptionBreakpoint createExceptionBreakpoint(String exName, bool
21502171
* }
21512172
* }
21522173
* }</pre>
2153-
* </p>
21542174
* To get the anonymous toString, syntax of fullTargetName would be: <code>Foo$Inner$aMethod()V$1$anIntField</code>
21552175
*/
21562176
protected IJavaWatchpoint createNestedTypeWatchPoint(String root, String packageName, String cuName,
@@ -2428,11 +2448,12 @@ protected IJavaThread stepIntoWithFilters(IJavaStackFrame frame) throws Exceptio
24282448
}
24292449

24302450
/**
2431-
* Performs a step into with filters in the given stack frame and returns when
2432-
* complete.
2451+
* Performs a step into with filters in the given stack frame and returns when complete.
24332452
*
2434-
* @param whether to step thru or step return from a filtered location
2435-
* @param frame stack frame to step in
2453+
* @param frame
2454+
* stack frame to step in
2455+
* @param stepThru
2456+
* whether to step thru or step return from a filtered location
24362457
*/
24372458
protected IJavaThread stepIntoWithFilters(IJavaStackFrame frame, boolean stepThru) throws Exception {
24382459
DebugEventWaiter waiter= new DebugElementKindEventWaiter(DebugEvent.SUSPEND, IJavaThread.class);

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

+19-19
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ private void testLocation(int lineToTry, int expectedLineNumber, String baseType
8181
/**
8282
* Tests setting a line breakpoint on a final field that is initialized
8383
*
84-
* @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
84+
* @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354"
8585
*/
8686
public void testFinalFieldWithTypeDecl() throws Exception {
8787
testLocation(17, 17, "FinalBreakpointLocations");
@@ -90,61 +90,61 @@ public void testFinalFieldWithTypeDecl() throws Exception {
9090
/**
9191
* Tests setting a line breakpoint on a final field that is initialized looking for best match
9292
*
93-
* @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
93+
* @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354"
9494
*/
9595
public void testFinalFieldWithTypeDecla() throws Exception {
9696
testLocation(17, 17, "FinalBreakpointLocations", "FinalBreakpointLocations", true);
9797
}
9898

9999
/**
100-
* Tests setting a line breakpoint on an inner type member for the initializer of
101-
* a final local field variable
102-
* @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
100+
* Tests setting a line breakpoint on an inner type member for the initializer of a final local field variable
101+
*
102+
* @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354"
103103
*/
104104
public void testFinalFieldWithTypeDecl3() throws Exception {
105105
testLocation(17, 17, "FinalBreakpointLocations");
106106
}
107107

108108
/**
109-
* Tests setting a line breakpoint on an inner type member for the initializer of looking
110-
* for best match
111-
* a final local field variable
112-
* @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
109+
* Tests setting a line breakpoint on an inner type member for the initializer of looking for best match a final local field variable
110+
*
111+
* @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354"
113112
*/
114113
public void testFinalFieldWithTypeDecl3a() throws Exception {
115114
testLocation(17, 17, "FinalBreakpointLocations", "FinalBreakpointLocations", true);
116115
}
117116

118117
/**
119-
* Tests setting a line breakpoint on an inner-inner type member for the initializer of
120-
* a final local field variable
121-
* @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
118+
* Tests setting a line breakpoint on an inner-inner type member for the initializer of a final local field variable
119+
*
120+
* @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354"
122121
*/
123122
public void testFinalFieldWithTypeDecl4() throws Exception {
124123
testLocation(20, 20, "FinalBreakpointLocations");
125124
}
126125

127126
/**
128-
* Tests setting a line breakpoint on an inner-inner type member for the initializer of
129-
* a final local field variable looking for best match
130-
* @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
127+
* Tests setting a line breakpoint on an inner-inner type member for the initializer of a final local field variable looking for best match
128+
*
129+
* @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354"
131130
*/
132131
public void testFinalFieldWithTypeDecl4a() throws Exception {
133132
testLocation(20, 20, "FinalBreakpointLocations", "FinalBreakpointLocations", true);
134133
}
135134

136135
/**
137136
* Tests setting a line breakpoint on a final field that has not been initialized
138-
* @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
137+
*
138+
* @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354"
139139
*/
140140
public void testFinalFieldWithTypeDecl5() throws Exception {
141141
testLocation(30, 33, "FinalBreakpointLocations");
142142
}
143143

144144
/**
145-
* Tests setting a line breakpoint on a final field that has not been initialized looking
146-
* for best match
147-
* @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354
145+
* Tests setting a line breakpoint on a final field that has not been initialized looking for best match
146+
*
147+
* @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=376354"
148148
*/
149149
public void testFinalFieldWithTypeDecl5a() throws Exception {
150150
testLocation(30, 33, "FinalBreakpointLocations", "FinalBreakpointLocations", true);

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

+3-4
Original file line numberDiff line numberDiff line change
@@ -69,16 +69,15 @@ public String getMethodName() {
6969
* Return <code>null</code> if there is no method declaration at the given position or
7070
* if not possible to compute the signature of the method declared at the given
7171
* position.
72-
* @see BreakpointFieldLocator#getMethodName()
7372
*/
7473
public String getMethodSignature() {
7574
return fMethodSignature;
7675
}
7776

7877
/**
79-
* Return the name of type in which the method is declared.
80-
* Return <code>null</code> if there is no method declaration at the given position.
81-
* @see BreakpointFieldLocator#getMethodName()
78+
* 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.
79+
*
80+
* @see BreakpointFieldLocator#getTypeName()
8281
*/
8382
public String getTypeName() {
8483
return fTypeName;

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

+2-3
Original file line numberDiff line numberDiff line change
@@ -71,12 +71,11 @@ public void testNoDefaultWorkingSet() throws Exception {
7171
}
7272

7373
/**
74-
* Tests that we can have N working set shown in the view and add additional breakpoints
75-
* to the default ones without causing exceptions
74+
* Tests that we can have N working set shown in the view and add additional breakpoints to the default ones without causing exceptions
7675
*
7776
* In this test we have to open / show the view to cause the insert update to occur
7877
*
79-
* @see https://bugs.eclipse.org/bugs/show_bug.cgi?id=380614
78+
* @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=380614"
8079
* @since 3.8.100
8180
*/
8281
public void testInsertIntoDefaultSet() throws Exception {

0 commit comments

Comments
 (0)