Skip to content

Commit ed93242

Browse files
EcljpseB0Tjukzi
EcljpseB0T
authored and
jukzi
committed
Remove blank Javadoc 1
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`
1 parent bfb352c commit ed93242

File tree

749 files changed

+57
-2445
lines changed

Some content is hidden

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

749 files changed

+57
-2445
lines changed

‎examples/org.eclipse.e4.ui.examples.job/src/org/eclipse/e4/ui/examples/jobs/TestJob.java

-2
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,6 @@ public class TestJob extends Job {
6161
* Whether the job should fail
6262
* @param indeterminate
6363
* Whether the job should report indeterminate progress
64-
* @param rescheduleWait
65-
* @param reschedule
6664
*/
6765
public TestJob(long duration, boolean lock, boolean failure,
6866
boolean indeterminate, boolean reschedule, long rescheduleWait) {

‎examples/org.eclipse.e4.ui.examples.job/src/org/eclipse/e4/ui/examples/jobs/TestJobRule.java

-2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818

1919
/**
2020
* TestJobRule is a scheduling rules that makes all jobs sequential.
21-
*
2221
*/
2322
public class TestJobRule implements ISchedulingRule {
2423
private final int jobOrder;
@@ -43,7 +42,6 @@ public boolean isConflicting(ISchedulingRule rule) {
4342

4443
/**
4544
* Return the order of this rule.
46-
* @return
4745
*/
4846
public int getJobOrder() {
4947
return jobOrder;

‎examples/org.eclipse.e4.ui.examples.job/src/org/eclipse/e4/ui/examples/jobs/views/JobsView.java

-6
Original file line numberDiff line numberDiff line change
@@ -182,8 +182,6 @@ public void createPartControl(Composite parent) {
182182

183183
/**
184184
* Create all push button parts for the jobs view.
185-
*
186-
* @param parent
187185
*/
188186
private void createPushButtonGroup(Composite parent) {
189187
Composite group = new Composite(parent, SWT.NONE);
@@ -293,7 +291,6 @@ public void widgetSelected(SelectionEvent e) {
293291

294292
/**
295293
* Test the showInDialog API
296-
*
297294
*/
298295
protected void showInDialog() {
299296

@@ -334,9 +331,6 @@ protected void doSleep() {
334331
Job.getJobManager().sleep(TestJob.FAMILY_TEST_JOB);
335332
}
336333

337-
/**
338-
* @param body
339-
*/
340334
private void createEntryFieldGroup(Composite body) {
341335
// duration
342336
Label label = new Label(body, SWT.NONE);

‎examples/org.eclipse.jface.examples.databinding/src/org/eclipse/jface/examples/databinding/contentprovider/test/LabelProviderTest.java

-12
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,6 @@ public void widgetSelected(SelectionEvent e) {
7878

7979
private final IObservableValue<RenamableItem> selectedRenamable;
8080

81-
/**
82-
*
83-
*/
8481
public LabelProviderTest() {
8582

8683
// Create shell
@@ -142,9 +139,6 @@ protected void removeListenerFrom(RenamableItem next) {
142139
LayoutConstants.getMargins()).generateLayout(shell);
143140
}
144141

145-
/**
146-
* @param currentSelection
147-
*/
148142
protected void rename(final RenamableItem currentSelection) {
149143
InputDialog inputDialog = new InputDialog(
150144
shell,
@@ -154,16 +148,10 @@ protected void rename(final RenamableItem currentSelection) {
154148
}
155149
}
156150

157-
/**
158-
* @return
159-
*/
160151
protected RenamableItem getCurrentSelection() {
161152
return selectedRenamable.getValue();
162153
}
163154

164-
/**
165-
* @param args
166-
*/
167155
public static void main(String[] args) {
168156
final Display display = Display.getDefault();
169157
Realm.runWithDefault(DisplayRealm.getRealm(display), () -> {

‎examples/org.eclipse.jface.examples.databinding/src/org/eclipse/jface/examples/databinding/contentprovider/test/LabelProviderTest2.java

-12
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,6 @@ public void widgetSelected(SelectionEvent e) {
7878

7979
private final IObservableValue<RenamableItem> selectedRenamable;
8080

81-
/**
82-
*
83-
*/
8481
public LabelProviderTest2() {
8582

8683
// Create shell
@@ -141,9 +138,6 @@ protected void removeListenerFrom(RenamableItem next) {
141138
LayoutConstants.getMargins()).generateLayout(shell);
142139
}
143140

144-
/**
145-
* @param currentSelection
146-
*/
147141
protected void rename(final RenamableItem currentSelection) {
148142
InputDialog inputDialog = new InputDialog(
149143
shell,
@@ -153,16 +147,10 @@ protected void rename(final RenamableItem currentSelection) {
153147
}
154148
}
155149

156-
/**
157-
* @return
158-
*/
159150
protected RenamableItem getCurrentSelection() {
160151
return selectedRenamable.getValue();
161152
}
162153

163-
/**
164-
* @param args
165-
*/
166154
public static void main(String[] args) {
167155
final Display display = Display.getDefault();
168156
Realm.runWithDefault(DisplayRealm.getRealm(display), () -> {

‎examples/org.eclipse.jface.examples.databinding/src/org/eclipse/jface/examples/databinding/contentprovider/test/RenamableItem.java

-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919

2020
/**
2121
* @since 1.0
22-
*
2322
*/
2423
public class RenamableItem {
2524

‎examples/org.eclipse.jface.examples.databinding/src/org/eclipse/jface/examples/databinding/contentprovider/test/SomeMathFunction.java

-15
Original file line numberDiff line numberDiff line change
@@ -32,34 +32,19 @@
3232
*/
3333
public class SomeMathFunction<K> extends ComputedObservableMap<K, Double> {
3434

35-
/**
36-
*
37-
*/
3835
public static final int OP_IDENTITY = 0;
3936

40-
/**
41-
*
42-
*/
4337
public static final int OP_MULTIPLY = 1;
4438

45-
/**
46-
*
47-
*/
4839
public static final int OP_ROUND = 2;
4940

5041
private int op = OP_ROUND;
5142

52-
/**
53-
* @param domain
54-
*/
5543
public SomeMathFunction(IObservableSet<K> domain) {
5644
super(domain);
5745
init();
5846
}
5947

60-
/**
61-
* @param operation
62-
*/
6348
public void setOperation(final int operation) {
6449
final int oldOp = this.op;
6550
this.op = operation;

‎examples/org.eclipse.jface.examples.databinding/src/org/eclipse/jface/examples/databinding/contentprovider/test/StructuredContentProviderTest.java

-3
Original file line numberDiff line numberDiff line change
@@ -363,9 +363,6 @@ public void widgetSelected(SelectionEvent e) {
363363
return addRemoveComposite;
364364
}
365365

366-
/**
367-
* @param args
368-
*/
369366
public static void main(String[] args) {
370367
Display display = Display.getDefault();
371368
realm = DisplayRealm.getRealm(display);

‎examples/org.eclipse.jface.examples.databinding/src/org/eclipse/jface/examples/databinding/contentprovider/test/TreeContentProviderTest.java

-6
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,6 @@ public void widgetSelected(SelectionEvent e) {
9898
shell.addDisposeListener(e -> dispose());
9999
}
100100

101-
/**
102-
*
103-
*/
104101
protected void dispose() {
105102
set1.dispose();
106103
set2.dispose();
@@ -166,9 +163,6 @@ public void updateLabel(ViewerLabel label, Object element) {
166163
tree.setInput(new Object());
167164
}
168165

169-
/**
170-
* @param args
171-
*/
172166
public static void main(String[] args) {
173167
final Display display = Display.getDefault();
174168
Realm.runWithDefault(DisplayRealm.getRealm(display), () -> {

‎examples/org.eclipse.jface.examples.databinding/src/org/eclipse/jface/examples/databinding/mask/EditMask.java

-10
Original file line numberDiff line numberDiff line change
@@ -268,18 +268,13 @@ public void setFireChangeOnKeystroke(boolean fireChangeOnKeystroke) {
268268

269269
/**
270270
* JavaBeans boilerplate code...
271-
*
272-
* @param listener
273271
*/
274272
public void addPropertyChangeListener(PropertyChangeListener listener) {
275273
propertyChangeSupport.addPropertyChangeListener(listener);
276274
}
277275

278276
/**
279277
* JavaBeans boilerplate code...
280-
*
281-
* @param propertyName
282-
* @param listener
283278
*/
284279
public void addPropertyChangeListener(String propertyName,
285280
PropertyChangeListener listener) {
@@ -288,18 +283,13 @@ public void addPropertyChangeListener(String propertyName,
288283

289284
/**
290285
* JavaBeans boilerplate code...
291-
*
292-
* @param listener
293286
*/
294287
public void removePropertyChangeListener(PropertyChangeListener listener) {
295288
propertyChangeSupport.removePropertyChangeListener(listener);
296289
}
297290

298291
/**
299292
* JavaBeans boilerplate code...
300-
*
301-
* @param propertyName
302-
* @param listener
303293
*/
304294
public void removePropertyChangeListener(String propertyName,
305295
PropertyChangeListener listener) {

‎examples/org.eclipse.jface.examples.databinding/src/org/eclipse/jface/examples/databinding/mask/EditMaskParseException.java

-10
Original file line numberDiff line numberDiff line change
@@ -30,24 +30,14 @@ public EditMaskParseException() {
3030
super();
3131
}
3232

33-
/**
34-
* @param message
35-
* @param cause
36-
*/
3733
public EditMaskParseException(String message, Throwable cause) {
3834
super(message, cause);
3935
}
4036

41-
/**
42-
* @param message
43-
*/
4437
public EditMaskParseException(String message) {
4538
super(message);
4639
}
4740

48-
/**
49-
* @param cause
50-
*/
5141
public EditMaskParseException(Throwable cause) {
5242
super(cause);
5343
}

‎examples/org.eclipse.jface.examples.databinding/src/org/eclipse/jface/examples/databinding/mask/internal/EditMaskLexerAndToken.java

-2
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,6 @@ public int initializeEditMask(String inputMask, int position) throws EditMaskPar
121121

122122
/**
123123
* ignores invalid input; stores valid input
124-
* @param inputCharacter
125-
* @return
126124
*/
127125
public boolean accept(String inputCharacter) {
128126
if (readOnly) {

‎examples/org.eclipse.jface.examples.databinding/src/org/eclipse/jface/examples/databinding/mask/internal/EditMaskParser.java

-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ public class EditMaskParser {
2828

2929
/**
3030
* @param editMask The complete edit mask
31-
* @throws EditMaskParseException
3231
*/
3332
public EditMaskParser(String editMask) throws EditMaskParseException {
3433
List<EditMaskLexerAndToken> tokens = new LinkedList<>();

‎examples/org.eclipse.jface.examples.databinding/src/org/eclipse/jface/examples/databinding/mask/internal/SWTUtil.java

-3
Original file line numberDiff line numberDiff line change
@@ -133,9 +133,6 @@ private static WorkQueue getQueueFor(final Display d) {
133133
}
134134

135135
/**
136-
* @param rgb1
137-
* @param rgb2
138-
* @param ratio
139136
* @return the RGB object
140137
*/
141138
public static RGB mix(RGB rgb1, RGB rgb2, double ratio) {

‎examples/org.eclipse.jface.examples.databinding/src/org/eclipse/jface/examples/databinding/mask/internal/WorkQueue.java

-4
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525

2626
/**
2727
* @since 3.2
28-
*
2928
*/
3029
public class WorkQueue {
3130

@@ -53,9 +52,6 @@ public void handleEvent(Event event) {
5352
}
5453
};
5554

56-
/**
57-
* @param targetDisplay
58-
*/
5955
public WorkQueue(Display targetDisplay) {
6056
d = targetDisplay;
6157
}

‎examples/org.eclipse.jface.examples.databinding/src/org/eclipse/jface/examples/databinding/model/AggregateObservableValue.java

-5
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323

2424
/**
2525
* @since 3.2
26-
*
2726
*/
2827
public class AggregateObservableValue extends AbstractObservableValue<Object> {
2928

@@ -41,10 +40,6 @@ public class AggregateObservableValue extends AbstractObservableValue<Object> {
4140
}
4241
};
4342

44-
/**
45-
* @param observableValues
46-
* @param delimiter
47-
*/
4843
public AggregateObservableValue(IObservableValue<Object>[] observableValues,
4944
String delimiter) {
5045
this.observableValues = observableValues;

‎examples/org.eclipse.jface.examples.databinding/src/org/eclipse/jface/examples/databinding/model/SimpleCart.java

-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818

1919
/**
2020
* @since 3.2
21-
*
2221
*/
2322
public class SimpleCart extends ModelObject {
2423

‎examples/org.eclipse.jface.examples.databinding/src/org/eclipse/jface/examples/databinding/model/SimpleOrder.java

-5
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020

2121
/**
2222
* @since 1.0
23-
*
2423
*/
2524
public class SimpleOrder extends ModelObject {
2625

@@ -55,10 +54,6 @@ public void setOrderNumber(int orderNumber) {
5554
this.orderNumber = orderNumber;
5655
}
5756

58-
/**
59-
* @param i
60-
* @param date
61-
*/
6257
public SimpleOrder(int i, Date date) {
6358
this.orderNumber = i;
6459
this.date = date;

‎examples/org.eclipse.jface.examples.databinding/src/org/eclipse/jface/examples/databinding/nestedselection/TestMasterDetail.java

-7
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,10 @@
5252

5353
/**
5454
* @since 1.0
55-
*
5655
*/
5756
public class TestMasterDetail {
5857
/**
5958
* @since 3.2
60-
*
6159
*/
6260
private static final class CustomUpdateValueStrategy<S, D> extends UpdateValueStrategy<S, D> {
6361
@Override
@@ -74,9 +72,6 @@ protected IStatus doSet(IObservableValue<? super D> observableValue, D value) {
7472
}
7573
}
7674

77-
/**
78-
* @param args
79-
*/
8075
public static void main(String[] args) {
8176
new TestMasterDetail().run();
8277
}
@@ -107,7 +102,6 @@ public static void main(String[] args) {
107102

108103
/**
109104
* This method initializes table
110-
*
111105
*/
112106
private void createTable() {
113107
GridData gridData = new org.eclipse.swt.layout.GridData();
@@ -130,7 +124,6 @@ private void createTable() {
130124

131125
/**
132126
* This method initializes table1
133-
*
134127
*/
135128
private void createTable1() {
136129
GridData gridData5 = new org.eclipse.swt.layout.GridData();

0 commit comments

Comments
 (0)