Skip to content

Commit 9872649

Browse files
committed
Fix unknown javadoc tags
Fixes all logged "unknown tag" and "tag not supported" errors in javadoc in the following way: * "@Private" -> "@noreference" * "@issue" -> "// TODO" * "@no" removed * "<tt>...</tt>" -> "{@code ...}
1 parent 79acafe commit 9872649

File tree

15 files changed

+18
-28
lines changed

15 files changed

+18
-28
lines changed

bundles/org.eclipse.e4.ui.progress/src/org/eclipse/e4/ui/progress/internal/legacy/StatusUtil.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
/**
2323
* Utility class to create status objects.
2424
*
25-
* @private - This class is an internal implementation class and should
26-
* not be referenced or subclassed outside of the workbench
25+
* @noreference This class is an internal implementation class and should not be
26+
* referenced or subclassed outside of the workbench
2727
*/
2828
public class StatusUtil {
2929

bundles/org.eclipse.ltk.ui.refactoring/src/org/eclipse/ltk/internal/ui/refactoring/RefactoringStatusViewer.java

+1-2
Original file line numberDiff line numberDiff line change
@@ -179,8 +179,7 @@ public void setStatus(RefactoringStatus status){
179179
}
180180

181181
/**
182-
* Returns the currently used <tt>RefactoringStatus</tt>.
183-
* @return the <tt>RefactoringStatus</tt>
182+
* @return the currently used {@link RefactoringStatus}
184183
*/
185184
public RefactoringStatus getStatus() {
186185
return fStatus;

bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/IWorkbenchHelpContextIds.java

+1-3
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,8 @@
2424
* This interface contains constants only; it is not intended to be implemented
2525
* or extended.
2626
* </p>
27-
*
28-
* @issue this class has been xcloned to org.eclipse.ui.internal.ide package;
29-
* remove all IDE-specific constants from here
3027
*/
28+
// TODO This class has been xcloned to org.eclipse.ui.internal.ide package; remove all IDE-specific constants from here
3129
public interface IWorkbenchHelpContextIds {
3230
String PREFIX = PlatformUI.PLUGIN_ID + "."; //$NON-NLS-1$
3331

bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/WorkbenchPlugin.java

+1-2
Original file line numberDiff line numberDiff line change
@@ -160,9 +160,8 @@ public class WorkbenchPlugin extends AbstractUIPlugin {
160160

161161
/**
162162
* The workbench plugin ID.
163-
*
164-
* @issue we should just drop this constant and use PlatformUI.PLUGIN_ID instead
165163
*/
164+
// TODO we should just drop this constant and use PlatformUI.PLUGIN_ID instead
166165
public static String PI_WORKBENCH = PlatformUI.PLUGIN_ID;
167166

168167
/**

bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/misc/StatusUtil.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
/**
2929
* Utility class to create status objects.
3030
*
31-
* @private - This class is an internal implementation class and should not be
32-
* referenced or subclassed outside of the workbench
31+
* @noreference This class is an internal implementation class and should not be
32+
* referenced or subclassed outside of the workbench
3333
*/
3434
public class StatusUtil {
3535
/**

bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/misc/TestPartListener.java

+1-2
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,8 @@
2323
public class TestPartListener implements IPartListener {
2424
/**
2525
* TestPartListener constructor comment.
26-
*
27-
* @issue seems like garbage - no one using it
2826
*/
27+
// TODO seems like garbage - no one using it
2928
public TestPartListener() {
3029
super();
3130
}

bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/registry/EditorDescriptor.java

+1-2
Original file line numberDiff line numberDiff line change
@@ -555,9 +555,8 @@ private int getOpenMode() {
555555
* Sets the open mode of this editor descriptor.
556556
*
557557
* @param mode the open mode
558-
*
559-
* @issue this method is public as a temporary fix for bug 47600
560558
*/
559+
// TODO this method is public as a temporary fix for bug 47600
561560
public void setOpenMode(int mode) {
562561
openMode = mode;
563562
}

examples/org.eclipse.ui.examples.job/src/org/eclipse/ui/examples/jobs/BusyShowWhileDialog.java

-3
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,6 @@
2727
* BusyShowWhileDialog is a test of busyShowWhile in a modal dialog.
2828
*/
2929
public class BusyShowWhileDialog extends IconAndMessageDialog {
30-
/**
31-
* @todo Generated comment
32-
*/
3330
public BusyShowWhileDialog(Shell parentShell) {
3431
super(parentShell);
3532
message = "Busy While Test"; //$NON-NLS-1$

tests/org.eclipse.jface.tests.databinding/src/org/eclipse/jface/tests/internal/databinding/swt/DateTimeCalendarObservableValueTest.java

-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@
3333

3434
/**
3535
* @since 3.2
36-
* @no
3736
*/
3837
public class DateTimeCalendarObservableValueTest extends AbstractSWTTestCase {
3938
private DateTime dateTime;

tests/org.eclipse.jface.tests.databinding/src/org/eclipse/jface/tests/internal/databinding/swt/DateTimeDateObservableValueTest.java

-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@
3333

3434
/**
3535
* @since 3.2
36-
* @no
3736
*/
3837
public class DateTimeDateObservableValueTest extends AbstractSWTTestCase {
3938
private DateTime dateTime;

tests/org.eclipse.jface.tests.databinding/src/org/eclipse/jface/tests/internal/databinding/swt/DateTimeTimeObservableValueTest.java

-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@
3333

3434
/**
3535
* @since 3.2
36-
* @no
3736
*/
3837
public class DateTimeTimeObservableValueTest extends AbstractSWTTestCase {
3938
private DateTime dateTime;

tests/org.eclipse.ui.tests/Eclipse UI Tests/org/eclipse/ui/tests/dialogs/DataTransferTestStub.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020
* <code>org.eclipse.ui.wizards.datatransfer</code>. For the purpose
2121
* of testing.
2222
* </p>
23-
* @private
23+
*
24+
* @noreference
2425
*/
2526
public class DataTransferTestStub {
2627
//Prevent instantiation

tests/org.eclipse.ui.tests/Eclipse UI Tests/org/eclipse/ui/tests/dialogs/NavigatorTestStub.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020
* <code>org.eclipse.ui.views.navigator</code>. For the purpose of
2121
* testing.
2222
* </p>
23-
* @private
23+
*
24+
* @noreference
2425
*/
2526

2627
public class NavigatorTestStub {

tests/org.eclipse.ui.tests/Eclipse UI Tests/org/eclipse/ui/tests/dialogs/TaskListTestStub.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020
* <code>org.eclipse.ui.views.tasklist</code>. For the purpose
2121
* of testing.
2222
* </p>
23-
* @private
23+
*
24+
* @noreference
2425
*/
2526
public class TaskListTestStub {
2627
//Prevent instantiation

tests/org.eclipse.ui.tests/Eclipse UI Tests/org/eclipse/ui/tests/dialogs/TextEditorTestStub.java

+3-4
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,11 @@
1717
* FOR USE BY TESTS ONLY!
1818
* <p>
1919
* Stub class that provides access to classes visible to the package
20-
* <code>org.eclipse.ui.texteditor</code>. For the purpose of
21-
* testing.
20+
* <code>org.eclipse.ui.texteditor</code>. For the purpose of testing.
2221
* </p>
23-
* @private
22+
*
23+
* @noreference
2424
*/
25-
2625
public class TextEditorTestStub {
2726
//Prevent instantiation
2827
private TextEditorTestStub() {

0 commit comments

Comments
 (0)